v1

latestOpenAPI 3.0.0Apache License 2.02026-07-263171,5614.1 MB
Amazon Warehousing and Distribution v2024-05-09

listReplenishmentOrders

Retrieves all the AWD replenishment orders pertaining to a merchant with optional filters. API by default will sort orders by updatedAt attribute in descending order.

get/awd/2024-05-09/replenishmentOrders

Query parameters

updatedAfterstring date-time

Get the replenishment orders updated after certain time (Inclusive) Date should be in ISO 8601 format as defined by date-time in - https://www.rfc-editor.org/rfc/rfc3339.

updatedBeforestring date-time

Get the replenishment orders updated before certain time (Inclusive) Date should be in ISO 8601 format as defined by date-time in - https://www.rfc-editor.org/rfc/rfc3339.

sortOrder'ASCENDING' | 'DESCENDING'

Sort the response in ASCENDING or DESCENDING order. The default sort order is DESCENDING.

maxResultsinteger

Maximum results to be returned in a single response.

nextTokenstring

A token that is used to retrieve the next page of results. The response includes nextToken when the number of results exceeds the specified maxResults value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until nextToken is null. Note that this operation can return empty pages.

Response

ListReplenishmentOrders 200 response

nextTokenstring

A token that is used to retrieve the next page of results. The response includes nextToken when the number of results exceeds the specified maxResults value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until nextToken is null. Note that this operation can return empty pages.

Example response

{
  "nextToken": "SampleToken",
  "orders": [
    {
      "distributionIneligibleReasons": [
        {
          "failureCode": "TestErrorCode",
          "failureReasons": [
            "Test failure reason"
          ],
          "sku": "SampleSKU"
        }
      ],
      "eligibleProducts": [
        {
          "attributes": [
            {
              "name": "TestAttribute",
              "value": "TestAttributeValue"
            }
          ]
        }
      ],
      "outboundShipments": [
        {
          "createdAt": "2023-01-12T10:00:00.000Z",
          "orderId": "TestOrderId",
          "shipmentId": "TestShipmentId",
          "shipmentStatus": "CREATED",
          "updatedAt": "2023-01-12T10:00:00.000Z"
        }
      ],
      "products": [
        {
          "attributes": [
            {
              "name": "TestAttribute",
              "value": "TestAttributeValue"
            }
          ]
        }
      ],
      "shippedProducts": [
        {
          "attributes": [
            {
              "name": "TestAttribute",
              "value": "TestAttributeValue"
            }
          ]
        }
      ],
      "updatedAt": "2023-01-12T10:00:00.000Z"
    }
  ]
}