POST Api/UpdateOrders/Post
Request Information
URI Parameters
None.
Body Parameters
UpdateOrdersRequestData| Name | Description | Type | Additional information |
|---|---|---|---|
| ProxyInformation | CustomerProxyInformation |
None. |
|
| MarketPlaceID | string |
None. |
|
| UpdateOrdersRequest | UpdateOrdersRequestMessage |
None. |
Request Formats
application/json, text/json
Sample:
{
"ProxyInformation": {
"ClientProxyfields": [
{
"Key": "sample string 1",
"Value": "sample string 2"
},
{
"Key": "sample string 1",
"Value": "sample string 2"
}
],
"CustomerProxyfields": [
{
"Key": "sample string 1",
"Value": "sample string 2"
},
{
"Key": "sample string 1",
"Value": "sample string 2"
}
]
},
"MarketPlaceID": "sample string 1",
"UpdateOrdersRequest": {
"request": {
"Token": "sample string 1",
"MarketplaceID": "sample string 2",
"MarketplaceInstanceID": "sample string 3",
"Records": [
{
"OriginalRecordXML": "sample string 1",
"FulfillmentDate": "2026-01-13T10:55:54.6614022+00:00",
"MarketPlaceKey": "sample string 3",
"CarrierName": "sample string 4",
"ShippingMethod": 0,
"EnumeratedCarrierCode": 0,
"UseCarrierName": true,
"TrackingNumber": "sample string 6",
"Items": [
{
"MarketPlaceItemID": "sample string 1",
"SKU": "sample string 2",
"SKUVariant1": "sample string 3",
"SKUVariant2": "sample string 4",
"SKUVariant3": "sample string 5",
"Quantity": 6,
"Custom1": "sample string 7",
"Custom2": "sample string 8",
"Custom3": "sample string 9"
},
{
"MarketPlaceItemID": "sample string 1",
"SKU": "sample string 2",
"SKUVariant1": "sample string 3",
"SKUVariant2": "sample string 4",
"SKUVariant3": "sample string 5",
"Quantity": 6,
"Custom1": "sample string 7",
"Custom2": "sample string 8",
"Custom3": "sample string 9"
}
],
"ShippingIsComplete": true,
"PieceNo": "sample string 8"
},
{
"OriginalRecordXML": "sample string 1",
"FulfillmentDate": "2026-01-13T10:55:54.6614022+00:00",
"MarketPlaceKey": "sample string 3",
"CarrierName": "sample string 4",
"ShippingMethod": 0,
"EnumeratedCarrierCode": 0,
"UseCarrierName": true,
"TrackingNumber": "sample string 6",
"Items": [
{
"MarketPlaceItemID": "sample string 1",
"SKU": "sample string 2",
"SKUVariant1": "sample string 3",
"SKUVariant2": "sample string 4",
"SKUVariant3": "sample string 5",
"Quantity": 6,
"Custom1": "sample string 7",
"Custom2": "sample string 8",
"Custom3": "sample string 9"
},
{
"MarketPlaceItemID": "sample string 1",
"SKU": "sample string 2",
"SKUVariant1": "sample string 3",
"SKUVariant2": "sample string 4",
"SKUVariant3": "sample string 5",
"Quantity": 6,
"Custom1": "sample string 7",
"Custom2": "sample string 8",
"Custom3": "sample string 9"
}
],
"ShippingIsComplete": true,
"PieceNo": "sample string 8"
}
],
"ShipmentCost": 4.0,
"IntegrationName": "sample string 5",
"IntegrationServerKey": "sample string 6",
"IntegrationNickName": "sample string 7",
"ClientId": "sample string 8",
"RequestId": "6bb6da1f-90a9-4275-aa0a-182e2eca036c",
"Guid_UniqueID": "sample string 9",
"MarketPlaceClientContractId": "sample string 10",
"IsRetry": true,
"OrderId": "sample string 12",
"TrackingUrl": "sample string 13",
"ServiceLevel": "sample string 14",
"AdditionalData": "sample string 15",
"ParcelWeight": 16.0
},
"RequestID": "f9f21da2-4e71-4cc0-85ce-a1a64c91bcd5",
"IntegrationName": "sample string 2",
"IntegrationNickName": "sample string 3",
"ClientId": "sample string 4",
"RequestStartDate": "2026-01-13T10:55:54.6614022+00:00",
"RequestEndDate": "2026-01-13T10:55:54.6614022+00:00",
"NumberOfRecords": 1,
"PreviousRequestId": "sample string 5",
"StartUTCDate": "2026-01-13T10:55:54.6614022+00:00",
"EndUTCDate": "2026-01-13T10:55:54.6614022+00:00",
"IntegrationServerKey": "sample string 8",
"MarketPlaceClientContractId": "sample string 9",
"IsRetry": true,
"OrderId": "sample string 11"
}
}
application/xml, text/xml
Sample:
<UpdateOrdersRequestData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MarketPlaceWorkflowWebAPI.Controllers">
<MarketPlaceID>sample string 1</MarketPlaceID>
<ProxyInformation xmlns:d2p1="http://schemas.datacontract.org/2004/07/MarketplaceDataContracts.Mef">
<d2p1:ClientProxyfields xmlns:d3p1="http://schemas.datacontract.org/2004/07/MarketplaceDataContracts.General">
<d3p1:KeyValue>
<d3p1:Key>sample string 1</d3p1:Key>
<d3p1:Value>sample string 2</d3p1:Value>
</d3p1:KeyValue>
<d3p1:KeyValue>
<d3p1:Key>sample string 1</d3p1:Key>
<d3p1:Value>sample string 2</d3p1:Value>
</d3p1:KeyValue>
</d2p1:ClientProxyfields>
<d2p1:CustomerProxyfields xmlns:d3p1="http://schemas.datacontract.org/2004/07/MarketplaceDataContracts.General">
<d3p1:KeyValue>
<d3p1:Key>sample string 1</d3p1:Key>
<d3p1:Value>sample string 2</d3p1:Value>
</d3p1:KeyValue>
<d3p1:KeyValue>
<d3p1:Key>sample string 1</d3p1:Key>
<d3p1:Value>sample string 2</d3p1:Value>
</d3p1:KeyValue>
</d2p1:CustomerProxyfields>
</ProxyInformation>
<UpdateOrdersRequest xmlns:d2p1="http://schemas.datacontract.org/2004/07/MarketplaceDataContracts.Request">
<d2p1:ClientId>sample string 4</d2p1:ClientId>
<d2p1:EndUTCDate>2026-01-13T10:55:54.6614022+00:00</d2p1:EndUTCDate>
<d2p1:IntegrationName>sample string 2</d2p1:IntegrationName>
<d2p1:IntegrationNickName>sample string 3</d2p1:IntegrationNickName>
<d2p1:IntegrationServerKey>sample string 8</d2p1:IntegrationServerKey>
<d2p1:IsRetry>true</d2p1:IsRetry>
<d2p1:MarketPlaceClientContractId>sample string 9</d2p1:MarketPlaceClientContractId>
<d2p1:NumberOfRecords>1</d2p1:NumberOfRecords>
<d2p1:OrderId>sample string 11</d2p1:OrderId>
<d2p1:PreviousRequestId>sample string 5</d2p1:PreviousRequestId>
<d2p1:RequestEndDate>2026-01-13T10:55:54.6614022+00:00</d2p1:RequestEndDate>
<d2p1:RequestID>f9f21da2-4e71-4cc0-85ce-a1a64c91bcd5</d2p1:RequestID>
<d2p1:RequestStartDate>2026-01-13T10:55:54.6614022+00:00</d2p1:RequestStartDate>
<d2p1:StartUTCDate>2026-01-13T10:55:54.6614022+00:00</d2p1:StartUTCDate>
<d2p1:request>
<d2p1:AdditionalData>sample string 15</d2p1:AdditionalData>
<d2p1:ClientId>sample string 8</d2p1:ClientId>
<d2p1:Guid_UniqueID>sample string 9</d2p1:Guid_UniqueID>
<d2p1:IntegrationName>sample string 5</d2p1:IntegrationName>
<d2p1:IntegrationNickName>sample string 7</d2p1:IntegrationNickName>
<d2p1:IntegrationServerKey>sample string 6</d2p1:IntegrationServerKey>
<d2p1:IsRetry>true</d2p1:IsRetry>
<d2p1:MarketPlaceClientContractId>sample string 10</d2p1:MarketPlaceClientContractId>
<d2p1:MarketplaceID>sample string 2</d2p1:MarketplaceID>
<d2p1:MarketplaceInstanceID>sample string 3</d2p1:MarketplaceInstanceID>
<d2p1:OrderId>sample string 12</d2p1:OrderId>
<d2p1:ParcelWeight>16</d2p1:ParcelWeight>
<d2p1:Records>
<d2p1:UpdateOrderRecord>
<d2p1:CarrierName>sample string 4</d2p1:CarrierName>
<d2p1:EnumeratedCarrierCode>NotSet</d2p1:EnumeratedCarrierCode>
<d2p1:FulfillmentDate>2026-01-13T10:55:54.6614022+00:00</d2p1:FulfillmentDate>
<d2p1:Items>
<d2p1:OrderItemData>
<d2p1:Custom1>sample string 7</d2p1:Custom1>
<d2p1:Custom2>sample string 8</d2p1:Custom2>
<d2p1:Custom3>sample string 9</d2p1:Custom3>
<d2p1:MarketPlaceItemID>sample string 1</d2p1:MarketPlaceItemID>
<d2p1:Quantity>6</d2p1:Quantity>
<d2p1:SKU>sample string 2</d2p1:SKU>
<d2p1:SKUVariant1>sample string 3</d2p1:SKUVariant1>
<d2p1:SKUVariant2>sample string 4</d2p1:SKUVariant2>
<d2p1:SKUVariant3>sample string 5</d2p1:SKUVariant3>
</d2p1:OrderItemData>
<d2p1:OrderItemData>
<d2p1:Custom1>sample string 7</d2p1:Custom1>
<d2p1:Custom2>sample string 8</d2p1:Custom2>
<d2p1:Custom3>sample string 9</d2p1:Custom3>
<d2p1:MarketPlaceItemID>sample string 1</d2p1:MarketPlaceItemID>
<d2p1:Quantity>6</d2p1:Quantity>
<d2p1:SKU>sample string 2</d2p1:SKU>
<d2p1:SKUVariant1>sample string 3</d2p1:SKUVariant1>
<d2p1:SKUVariant2>sample string 4</d2p1:SKUVariant2>
<d2p1:SKUVariant3>sample string 5</d2p1:SKUVariant3>
</d2p1:OrderItemData>
</d2p1:Items>
<d2p1:MarketPlaceKey>sample string 3</d2p1:MarketPlaceKey>
<d2p1:OriginalRecordXML>sample string 1</d2p1:OriginalRecordXML>
<d2p1:PieceNo>sample string 8</d2p1:PieceNo>
<d2p1:ShippingIsComplete>true</d2p1:ShippingIsComplete>
<d2p1:ShippingMethod>Not Set</d2p1:ShippingMethod>
<d2p1:TrackingNumber>sample string 6</d2p1:TrackingNumber>
<d2p1:UseCarrierName>true</d2p1:UseCarrierName>
</d2p1:UpdateOrderRecord>
<d2p1:UpdateOrderRecord>
<d2p1:CarrierName>sample string 4</d2p1:CarrierName>
<d2p1:EnumeratedCarrierCode>NotSet</d2p1:EnumeratedCarrierCode>
<d2p1:FulfillmentDate>2026-01-13T10:55:54.6614022+00:00</d2p1:FulfillmentDate>
<d2p1:Items>
<d2p1:OrderItemData>
<d2p1:Custom1>sample string 7</d2p1:Custom1>
<d2p1:Custom2>sample string 8</d2p1:Custom2>
<d2p1:Custom3>sample string 9</d2p1:Custom3>
<d2p1:MarketPlaceItemID>sample string 1</d2p1:MarketPlaceItemID>
<d2p1:Quantity>6</d2p1:Quantity>
<d2p1:SKU>sample string 2</d2p1:SKU>
<d2p1:SKUVariant1>sample string 3</d2p1:SKUVariant1>
<d2p1:SKUVariant2>sample string 4</d2p1:SKUVariant2>
<d2p1:SKUVariant3>sample string 5</d2p1:SKUVariant3>
</d2p1:OrderItemData>
<d2p1:OrderItemData>
<d2p1:Custom1>sample string 7</d2p1:Custom1>
<d2p1:Custom2>sample string 8</d2p1:Custom2>
<d2p1:Custom3>sample string 9</d2p1:Custom3>
<d2p1:MarketPlaceItemID>sample string 1</d2p1:MarketPlaceItemID>
<d2p1:Quantity>6</d2p1:Quantity>
<d2p1:SKU>sample string 2</d2p1:SKU>
<d2p1:SKUVariant1>sample string 3</d2p1:SKUVariant1>
<d2p1:SKUVariant2>sample string 4</d2p1:SKUVariant2>
<d2p1:SKUVariant3>sample string 5</d2p1:SKUVariant3>
</d2p1:OrderItemData>
</d2p1:Items>
<d2p1:MarketPlaceKey>sample string 3</d2p1:MarketPlaceKey>
<d2p1:OriginalRecordXML>sample string 1</d2p1:OriginalRecordXML>
<d2p1:PieceNo>sample string 8</d2p1:PieceNo>
<d2p1:ShippingIsComplete>true</d2p1:ShippingIsComplete>
<d2p1:ShippingMethod>Not Set</d2p1:ShippingMethod>
<d2p1:TrackingNumber>sample string 6</d2p1:TrackingNumber>
<d2p1:UseCarrierName>true</d2p1:UseCarrierName>
</d2p1:UpdateOrderRecord>
</d2p1:Records>
<d2p1:RequestId>6bb6da1f-90a9-4275-aa0a-182e2eca036c</d2p1:RequestId>
<d2p1:ServiceLevel>sample string 14</d2p1:ServiceLevel>
<d2p1:ShipmentCost>4</d2p1:ShipmentCost>
<d2p1:Token>sample string 1</d2p1:Token>
<d2p1:TrackingUrl>sample string 13</d2p1:TrackingUrl>
</d2p1:request>
</UpdateOrdersRequest>
</UpdateOrdersRequestData>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
UpdateOrderResult| Name | Description | Type | Additional information |
|---|---|---|---|
| Error | boolean |
None. |
|
| Message | string |
None. |
|
| OrderResults | Collection of UpdateOrderResultRecord |
None. |
Response Formats
application/json, text/json
Sample:
{
"OrderResults": [
{
"Status": "sample string 1",
"MarketplaceOrderKey": "sample string 2",
"Success": true,
"ErrorMessage": "sample string 4",
"ResponseContent": "sample string 5"
},
{
"Status": "sample string 1",
"MarketplaceOrderKey": "sample string 2",
"Success": true,
"ErrorMessage": "sample string 4",
"ResponseContent": "sample string 5"
}
],
"Error": true,
"Message": "sample string 2"
}
application/xml, text/xml
Sample:
<UpdateOrderResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MarketplaceDataContracts.Orders">
<Error>true</Error>
<Message>sample string 2</Message>
<OrderResults>
<UpdateOrderResultRecord>
<ErrorMessage>sample string 4</ErrorMessage>
<MarketplaceOrderKey>sample string 2</MarketplaceOrderKey>
<ResponseContent>sample string 5</ResponseContent>
<Status>sample string 1</Status>
<Success>true</Success>
</UpdateOrderResultRecord>
<UpdateOrderResultRecord>
<ErrorMessage>sample string 4</ErrorMessage>
<MarketplaceOrderKey>sample string 2</MarketplaceOrderKey>
<ResponseContent>sample string 5</ResponseContent>
<Status>sample string 1</Status>
<Success>true</Success>
</UpdateOrderResultRecord>
</OrderResults>
</UpdateOrderResult>