POST v1/api/OrderAcknowledgement

Processes Order Acknowledgement details from Nike to eShopWorld.

Request Information

URI Parameters

None.

Body Parameters

A object containing Order Acknowledgement details for eShopWorld to process.

esw.Common.Model.Published.Order.Nike.NikeOrderAcknowledgementRequest
NameDescriptionTypeAdditional information
BrandOrderReference

The Nike Order number that is being acknowledged. Required: Yes

string

None.

EShopOrderReference

The eShopWorld Order number that is being acknowledged. Required: Yes

string

None.

Status

The overall OrderStatus from Nike. Required: Yes

string

None.

OrderItems

The collection of OrderLineItems with status'. Required: Yes

esw.Common.Model.Published.Order.Nike.NikeOrderAckLineItemsContainer

None.

Request Formats

application/json, text/json

Sample:
{
  "BrandOrderReference": "sample string 1",
  "EShopOrderReference": "sample string 2",
  "Status": "sample string 3",
  "OrderItems": {
    "OrderItem": [
      {
        "Status": "sample string 1",
        "OrderItemSequence": 2
      },
      {
        "Status": "sample string 1",
        "OrderItemSequence": 2
      }
    ]
  }
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'esw.Common.Model.Published.Order.Nike.NikeOrderAcknowledgementRequest'.

application/xml, text/xml

Sample:
<Order xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" OrderId="sample string 1" VendorOrderNo="sample string 2" Status="sample string 3" xmlns="http://www.eShopWorld.com/eShopWorld.Nike.Contracts">
  <OrderLines>
    <OrderLine Status="sample string 1" VendorOrderLineNo="2" />
    <OrderLine Status="sample string 1" VendorOrderLineNo="2" />
  </OrderLines>
</Order>

Response Information

Resource Description

An object containing the response object.

esw.Common.Model.Published.Order.Nike.NikeOrderAcknowledgementResponse
NameDescriptionTypeAdditional information
Status

esw.Common.Model.Published.Order.Nike.NikeOrderAcknowledgementStatus

None.

StatusMessage

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Status": 0,
  "StatusMessage": "sample string 1"
}

application/xml, text/xml

Sample:
<Order xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.eShopWorld.com/eShopWorld.Nike.Contracts">
  <Status>Success</Status>
  <StatusMessage>sample string 1</StatusMessage>
</Order>