| GET | /api/ECommerceOrderStatus |
|---|
<?php namespace dtos;
use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};
// @DataContract
class BaseRequest implements JsonSerializable
{
public function __construct(
/** @description This is your AIM API Key provided by Tri-Tech */
// @DataMember
// @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
/** @var string */
public string $ApiKey='',
// @DataMember
// @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
/** @var string|null */
public ?string $OAuthToken=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ApiKey'])) $this->ApiKey = $o['ApiKey'];
if (isset($o['OAuthToken'])) $this->OAuthToken = $o['OAuthToken'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ApiKey)) $o['ApiKey'] = $this->ApiKey;
if (isset($this->OAuthToken)) $o['OAuthToken'] = $this->OAuthToken;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class BaseSecureRequest extends BaseRequest implements JsonSerializable
{
/**
* @param string $ApiKey
* @param string|null $OAuthToken
*/
public function __construct(
string $ApiKey='',
?string $OAuthToken=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
/** @var string|null */
public ?string $Token=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
/** @var string|null */
public ?string $DeviceId=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
/** @var string */
public string $AppId=''
) {
parent::__construct($ApiKey,$OAuthToken);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['Token'])) $this->Token = $o['Token'];
if (isset($o['DeviceId'])) $this->DeviceId = $o['DeviceId'];
if (isset($o['AppId'])) $this->AppId = $o['AppId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->Token)) $o['Token'] = $this->Token;
if (isset($this->DeviceId)) $o['DeviceId'] = $this->DeviceId;
if (isset($this->AppId)) $o['AppId'] = $this->AppId;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class BaseResponseResult implements JsonSerializable
{
public function __construct(
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
/** @var string|null */
public ?string $StatusCode=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
/** @var string|null */
public ?string $Login=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
/** @var string|null */
public ?string $ErrorCode=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
/** @var string|null */
public ?string $ErrorDisplayText=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
/** @var string|null */
public ?string $ErrorMessage=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
/** @var string|null */
public ?string $DomainName=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
/** @var string|null */
public ?string $IpAddress=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['StatusCode'])) $this->StatusCode = $o['StatusCode'];
if (isset($o['Login'])) $this->Login = $o['Login'];
if (isset($o['ErrorCode'])) $this->ErrorCode = $o['ErrorCode'];
if (isset($o['ErrorDisplayText'])) $this->ErrorDisplayText = $o['ErrorDisplayText'];
if (isset($o['ErrorMessage'])) $this->ErrorMessage = $o['ErrorMessage'];
if (isset($o['DomainName'])) $this->DomainName = $o['DomainName'];
if (isset($o['IpAddress'])) $this->IpAddress = $o['IpAddress'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->StatusCode)) $o['StatusCode'] = $this->StatusCode;
if (isset($this->Login)) $o['Login'] = $this->Login;
if (isset($this->ErrorCode)) $o['ErrorCode'] = $this->ErrorCode;
if (isset($this->ErrorDisplayText)) $o['ErrorDisplayText'] = $this->ErrorDisplayText;
if (isset($this->ErrorMessage)) $o['ErrorMessage'] = $this->ErrorMessage;
if (isset($this->DomainName)) $o['DomainName'] = $this->DomainName;
if (isset($this->IpAddress)) $o['IpAddress'] = $this->IpAddress;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class BaseResponse implements JsonSerializable
{
public function __construct(
/** @description */
// @DataMember
// @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
/** @var BaseResponseResult|null */
public ?BaseResponseResult $Status=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Status'])) $this->Status = JsonConverters::from('BaseResponseResult', $o['Status']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Status)) $o['Status'] = JsonConverters::to('BaseResponseResult', $this->Status);
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class ECommerceOrderLineItem implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var string|null */
public ?string $Sku=null,
// @DataMember
/** @var float */
public float $Quantity=0.0,
// @DataMember
/** @var string|null */
public ?string $ItemStatus=null,
// @DataMember
/** @var int|null */
public ?int $ShipmentId=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Sku'])) $this->Sku = $o['Sku'];
if (isset($o['Quantity'])) $this->Quantity = $o['Quantity'];
if (isset($o['ItemStatus'])) $this->ItemStatus = $o['ItemStatus'];
if (isset($o['ShipmentId'])) $this->ShipmentId = $o['ShipmentId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Sku)) $o['Sku'] = $this->Sku;
if (isset($this->Quantity)) $o['Quantity'] = $this->Quantity;
if (isset($this->ItemStatus)) $o['ItemStatus'] = $this->ItemStatus;
if (isset($this->ShipmentId)) $o['ShipmentId'] = $this->ShipmentId;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class ECommerceOrderShippingInfo implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var int */
public int $ShipmentId=0,
// @DataMember
/** @var string|null */
public ?string $ShipVia=null,
// @DataMember
/** @var array<string>|null */
public ?array $TrackingNumbers=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ShipmentId'])) $this->ShipmentId = $o['ShipmentId'];
if (isset($o['ShipVia'])) $this->ShipVia = $o['ShipVia'];
if (isset($o['TrackingNumbers'])) $this->TrackingNumbers = JsonConverters::fromArray('string', $o['TrackingNumbers']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ShipmentId)) $o['ShipmentId'] = $this->ShipmentId;
if (isset($this->ShipVia)) $o['ShipVia'] = $this->ShipVia;
if (isset($this->TrackingNumbers)) $o['TrackingNumbers'] = JsonConverters::toArray('string', $this->TrackingNumbers);
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class ECommerceOrderStatusResponse extends BaseResponse implements JsonSerializable
{
/**
* @param BaseResponseResult|null $Status
*/
public function __construct(
?BaseResponseResult $Status=null,
// @DataMember
/** @var string|null */
public ?string $OrderStatus=null,
// @DataMember
/** @var string|null */
public ?string $OrderStatusDescription=null,
// @DataMember
/** @var array<ECommerceOrderLineItem>|null */
public ?array $LineItems=null,
// @DataMember
/** @var array<ECommerceOrderShippingInfo>|null */
public ?array $ShippingInfo=null
) {
parent::__construct($Status);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['OrderStatus'])) $this->OrderStatus = $o['OrderStatus'];
if (isset($o['OrderStatusDescription'])) $this->OrderStatusDescription = $o['OrderStatusDescription'];
if (isset($o['LineItems'])) $this->LineItems = JsonConverters::fromArray('ECommerceOrderLineItem', $o['LineItems']);
if (isset($o['ShippingInfo'])) $this->ShippingInfo = JsonConverters::fromArray('ECommerceOrderShippingInfo', $o['ShippingInfo']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->OrderStatus)) $o['OrderStatus'] = $this->OrderStatus;
if (isset($this->OrderStatusDescription)) $o['OrderStatusDescription'] = $this->OrderStatusDescription;
if (isset($this->LineItems)) $o['LineItems'] = JsonConverters::toArray('ECommerceOrderLineItem', $this->LineItems);
if (isset($this->ShippingInfo)) $o['ShippingInfo'] = JsonConverters::toArray('ECommerceOrderShippingInfo', $this->ShippingInfo);
return empty($o) ? new class(){} : $o;
}
}
/** @description ECommerceOrderStatusRequires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce. */
// @DataContract
class ECommerceOrderStatusRequest extends BaseSecureRequest implements JsonSerializable
{
/**
* @param string $ApiKey
* @param string|null $OAuthToken
* @param string|null $Token
* @param string|null $DeviceId
* @param string $AppId
*/
public function __construct(
string $ApiKey='',
?string $OAuthToken=null,
?string $Token=null,
?string $DeviceId=null,
string $AppId='',
// @DataMember
/** @var string|null */
public ?string $OrderNumber=null,
/** @description 3 is 3rd Party, C is AIMStoreFront, E is Ebay, A is Amazon, B is Excel Import, R is Reverb, G is Gunbroker, M is Ammoready. Defaults to 3 */
// @DataMember
// @ApiMember(DataType="string", Description="3 is 3rd Party, C is AIMStoreFront, E is Ebay, A is Amazon, B is Excel Import, R is Reverb, G is Gunbroker, M is Ammoready. Defaults to 3", Name="OrderType", ParameterType="query")
/** @var string|null */
public ?string $OrderType=null
) {
parent::__construct($ApiKey,$OAuthToken,$Token,$DeviceId,$AppId);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['OrderNumber'])) $this->OrderNumber = $o['OrderNumber'];
if (isset($o['OrderType'])) $this->OrderType = $o['OrderType'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->OrderNumber)) $o['OrderNumber'] = $this->OrderNumber;
if (isset($this->OrderType)) $o['OrderType'] = $this->OrderType;
return empty($o) ? new class(){} : $o;
}
}
PHP ECommerceOrderStatusRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/ECommerceOrderStatus HTTP/1.1 Host: active-ewebservice.biz Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"OrderStatus":"String","OrderStatusDescription":"String","LineItems":[{"Sku":"String","Quantity":0,"ItemStatus":"String","ShipmentId":0}],"ShippingInfo":[{"ShipmentId":0,"ShipVia":"String","TrackingNumbers":["String"]}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}