POST Api/GetSingleOrder/GetSingleOrder
Request Information
URI Parameters
None.
Body Parameters
SingleOrderRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Guid_UniqueID | string |
None. |
|
| Token | string |
None. |
|
| MarketPlaceKey | string |
None. |
|
| MarketPlaceInstanceID | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"Guid_UniqueID": "sample string 1",
"Token": "sample string 2",
"MarketPlaceKey": "sample string 3",
"MarketPlaceInstanceID": "sample string 4"
}
application/xml, text/xml
Sample:
<SingleOrderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MarketplaceDataContracts.Orders"> <Guid_UniqueID>sample string 1</Guid_UniqueID> <MarketPlaceInstanceID>sample string 4</MarketPlaceInstanceID> <MarketPlaceKey>sample string 3</MarketPlaceKey> <Token>sample string 2</Token> </SingleOrderRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Order| Name | Description | Type | Additional information |
|---|---|---|---|
| MarketPlaceKey | string |
None. |
|
| OrderKey | string |
None. |
|
| Order_Status | OrderStatus |
None. |
|
| Payment_Status | PaymentStatus |
None. |
|
| Fulfillment_Status | FulfillmentStatus |
None. |
|
| OrderDate | date |
None. |
|
| OrderNumber | string |
None. |
|
| purchaseOrderNumber | string |
None. |
|
| ShipmentRefNumber | string |
None. |
|
| CustomRefField1 | string |
None. |
|
| CustomRefField2 | string |
None. |
|
| CustomRefField3 | string |
None. |
|
| RequestedServiceLevel | string |
None. |
|
| ShippingPaid | Money |
None. |
|
| TaxesPaid | Money |
None. |
|
| AmountPaid | Money |
None. |
|
| DiscountAmount | Money |
None. |
|
| CouponDiscount | Money |
None. |
|
| Notes | string |
None. |
|
| ShipAddress | Address |
None. |
|
| Items | Collection of OrderItem |
None. |
|
| IsNotSync | boolean |
None. |
|
| IntegrationStatus | string |
None. |
|
| IntegrationStatusId | string |
None. |
|
| Requested | boolean |
None. |
|
| OrderCarrier | string |
None. |
|
| OrderPackaging | string |
None. |
|
| Warehouse_id | string |
None. |
|
| Warehouse_name | string |
None. |
|
| Bin | string |
None. |
|
| Row | string |
None. |
|
| Aisle | string |
None. |
|
| Room | string |
None. |
|
| OrderTags | string |
None. |
|
| GiftMessage | string |
None. |
|
| ToMessage | string |
None. |
|
| FromMessage | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"MarketPlaceKey": "sample string 1",
"OrderKey": "sample string 2",
"Order_Status": 0,
"Payment_Status": 0,
"Fulfillment_Status": 0,
"OrderDate": "2026-01-13T10:50:35.4973048+00:00",
"OrderNumber": "sample string 3",
"purchaseOrderNumber": "sample string 4",
"ShipmentRefNumber": "sample string 5",
"CustomRefField1": "sample string 6",
"CustomRefField2": "sample string 7",
"CustomRefField3": "sample string 8",
"RequestedServiceLevel": "sample string 9",
"ShippingPaid": {
"CurrencyCode": 0,
"Amount": 1.0
},
"TaxesPaid": {
"CurrencyCode": 0,
"Amount": 1.0
},
"AmountPaid": {
"CurrencyCode": 0,
"Amount": 1.0
},
"DiscountAmount": {
"CurrencyCode": 0,
"Amount": 1.0
},
"CouponDiscount": {
"CurrencyCode": 0,
"Amount": 1.0
},
"Notes": "sample string 10",
"ShipAddress": {
"Company": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"FullName": "sample string 4",
"PhoneNumber": "sample string 5",
"Email": "sample string 6",
"Address1": "sample string 7",
"Address2": "sample string 8",
"City": "sample string 9",
"Province": "sample string 10",
"PostalCode": "sample string 11",
"CountryAlpha2": "sample string 12",
"CountryName": "sample string 13",
"IsResidential": true
},
"Items": [
{
"MarketPlaceItemID": "sample string 1",
"SKU": "sample string 2",
"SKUVariant1": "sample string 3",
"SKUVariant2": "sample string 4",
"SKUVariant3": "sample string 5",
"Name": "sample string 6",
"Description": "sample string 7",
"Quantity": 1,
"SoldPriceEach": {
"CurrencyCode": 0,
"Amount": 1.0
},
"Weight": 1.1,
"Dimensionx": 1.1,
"Dimensiony": 1.1,
"Dimensionz": 1.1,
"CustomsDeclarationValue": "sample string 8",
"CustomsHarmonizedCode": "sample string 9",
"CustomsDeclarationDescription": "sample string 10",
"Custom1": "sample string 11",
"Custom2": "sample string 12",
"Custom3": "sample string 13",
"Warehouse_id": "sample string 14",
"Warehouse_name": "sample string 15",
"Warehouse_bin": "sample string 16",
"Warehouse_row": "sample string 17",
"Warehouse_aisle": "sample string 18",
"Warehouse_room": "sample string 19",
"PieceNo": "sample string 20"
},
{
"MarketPlaceItemID": "sample string 1",
"SKU": "sample string 2",
"SKUVariant1": "sample string 3",
"SKUVariant2": "sample string 4",
"SKUVariant3": "sample string 5",
"Name": "sample string 6",
"Description": "sample string 7",
"Quantity": 1,
"SoldPriceEach": {
"CurrencyCode": 0,
"Amount": 1.0
},
"Weight": 1.1,
"Dimensionx": 1.1,
"Dimensiony": 1.1,
"Dimensionz": 1.1,
"CustomsDeclarationValue": "sample string 8",
"CustomsHarmonizedCode": "sample string 9",
"CustomsDeclarationDescription": "sample string 10",
"Custom1": "sample string 11",
"Custom2": "sample string 12",
"Custom3": "sample string 13",
"Warehouse_id": "sample string 14",
"Warehouse_name": "sample string 15",
"Warehouse_bin": "sample string 16",
"Warehouse_row": "sample string 17",
"Warehouse_aisle": "sample string 18",
"Warehouse_room": "sample string 19",
"PieceNo": "sample string 20"
}
],
"IsNotSync": true,
"IntegrationStatus": "sample string 12",
"IntegrationStatusId": "sample string 13",
"Requested": true,
"OrderCarrier": "sample string 15",
"OrderPackaging": "sample string 16",
"Warehouse_id": "sample string 18",
"Warehouse_name": "sample string 19",
"Bin": "sample string 20",
"Row": "sample string 21",
"Aisle": "sample string 22",
"Room": "sample string 23",
"OrderTags": "sample string 24",
"GiftMessage": "sample string 25",
"ToMessage": "sample string 26",
"FromMessage": "sample string 27"
}
application/xml, text/xml
Sample:
<Order xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MarketplaceDataContracts.Orders">
<Aisle>sample string 22</Aisle>
<AmountPaid>
<Amount>1</Amount>
<CurrencyCode>NotSet</CurrencyCode>
</AmountPaid>
<Bin>sample string 20</Bin>
<CouponDiscount>
<Amount>1</Amount>
<CurrencyCode>NotSet</CurrencyCode>
</CouponDiscount>
<CustomRefField1>sample string 6</CustomRefField1>
<CustomRefField2>sample string 7</CustomRefField2>
<CustomRefField3>sample string 8</CustomRefField3>
<DiscountAmount>
<Amount>1</Amount>
<CurrencyCode>NotSet</CurrencyCode>
</DiscountAmount>
<FromMessage>sample string 27</FromMessage>
<Fulfillment_Status>Unknown</Fulfillment_Status>
<GiftMessage>sample string 25</GiftMessage>
<IntegrationStatus>sample string 12</IntegrationStatus>
<IntegrationStatusId>sample string 13</IntegrationStatusId>
<IsNotSync>true</IsNotSync>
<Items>
<OrderItem>
<Custom1>sample string 11</Custom1>
<Custom2>sample string 12</Custom2>
<Custom3>sample string 13</Custom3>
<CustomsDeclarationDescription>sample string 10</CustomsDeclarationDescription>
<CustomsDeclarationValue>sample string 8</CustomsDeclarationValue>
<CustomsHarmonizedCode>sample string 9</CustomsHarmonizedCode>
<Description>sample string 7</Description>
<Dimensionx>1.1</Dimensionx>
<Dimensiony>1.1</Dimensiony>
<Dimensionz>1.1</Dimensionz>
<MarketPlaceItemID>sample string 1</MarketPlaceItemID>
<Name>sample string 6</Name>
<PieceNo>sample string 20</PieceNo>
<Quantity>1</Quantity>
<SKU>sample string 2</SKU>
<SKUVariant1>sample string 3</SKUVariant1>
<SKUVariant2>sample string 4</SKUVariant2>
<SKUVariant3>sample string 5</SKUVariant3>
<SoldPriceEach>
<Amount>1</Amount>
<CurrencyCode>NotSet</CurrencyCode>
</SoldPriceEach>
<Warehouse_aisle>sample string 18</Warehouse_aisle>
<Warehouse_bin>sample string 16</Warehouse_bin>
<Warehouse_id>sample string 14</Warehouse_id>
<Warehouse_name>sample string 15</Warehouse_name>
<Warehouse_room>sample string 19</Warehouse_room>
<Warehouse_row>sample string 17</Warehouse_row>
<Weight>1.1</Weight>
</OrderItem>
<OrderItem>
<Custom1>sample string 11</Custom1>
<Custom2>sample string 12</Custom2>
<Custom3>sample string 13</Custom3>
<CustomsDeclarationDescription>sample string 10</CustomsDeclarationDescription>
<CustomsDeclarationValue>sample string 8</CustomsDeclarationValue>
<CustomsHarmonizedCode>sample string 9</CustomsHarmonizedCode>
<Description>sample string 7</Description>
<Dimensionx>1.1</Dimensionx>
<Dimensiony>1.1</Dimensiony>
<Dimensionz>1.1</Dimensionz>
<MarketPlaceItemID>sample string 1</MarketPlaceItemID>
<Name>sample string 6</Name>
<PieceNo>sample string 20</PieceNo>
<Quantity>1</Quantity>
<SKU>sample string 2</SKU>
<SKUVariant1>sample string 3</SKUVariant1>
<SKUVariant2>sample string 4</SKUVariant2>
<SKUVariant3>sample string 5</SKUVariant3>
<SoldPriceEach>
<Amount>1</Amount>
<CurrencyCode>NotSet</CurrencyCode>
</SoldPriceEach>
<Warehouse_aisle>sample string 18</Warehouse_aisle>
<Warehouse_bin>sample string 16</Warehouse_bin>
<Warehouse_id>sample string 14</Warehouse_id>
<Warehouse_name>sample string 15</Warehouse_name>
<Warehouse_room>sample string 19</Warehouse_room>
<Warehouse_row>sample string 17</Warehouse_row>
<Weight>1.1</Weight>
</OrderItem>
</Items>
<MarketPlaceKey>sample string 1</MarketPlaceKey>
<Notes>sample string 10</Notes>
<OrderCarrier>sample string 15</OrderCarrier>
<OrderDate>2026-01-13T10:50:35.4973048+00:00</OrderDate>
<OrderKey>sample string 2</OrderKey>
<OrderNumber>sample string 3</OrderNumber>
<OrderPackaging>sample string 16</OrderPackaging>
<OrderTags>sample string 24</OrderTags>
<Order_Status>Unknown</Order_Status>
<Payment_Status>Unknown</Payment_Status>
<Requested>true</Requested>
<RequestedServiceLevel>sample string 9</RequestedServiceLevel>
<Room>sample string 23</Room>
<Row>sample string 21</Row>
<ShipAddress>
<Address1>sample string 7</Address1>
<Address2>sample string 8</Address2>
<City>sample string 9</City>
<Company>sample string 1</Company>
<CountryAlpha2>sample string 12</CountryAlpha2>
<CountryName>sample string 13</CountryName>
<Email>sample string 6</Email>
<FirstName>sample string 2</FirstName>
<FullName>sample string 4</FullName>
<IsResidential>true</IsResidential>
<LastName>sample string 3</LastName>
<PhoneNumber>sample string 5</PhoneNumber>
<PostalCode>sample string 11</PostalCode>
<Province>sample string 10</Province>
</ShipAddress>
<ShipmentRefNumber>sample string 5</ShipmentRefNumber>
<ShippingPaid>
<Amount>1</Amount>
<CurrencyCode>NotSet</CurrencyCode>
</ShippingPaid>
<TaxesPaid>
<Amount>1</Amount>
<CurrencyCode>NotSet</CurrencyCode>
</TaxesPaid>
<ToMessage>sample string 26</ToMessage>
<Warehouse_id>sample string 18</Warehouse_id>
<Warehouse_name>sample string 19</Warehouse_name>
<purchaseOrderNumber>sample string 4</purchaseOrderNumber>
</Order>