• postAccept fulfillment request
• getGet item cancelation status
• postCancel items
• getGet item rejection status
• postReject items
• getGet rejection status
• postReject fulfillment request
• postResend fulfillment request
• getGet shipping status
• postUpdate shipping status

API docs by Redocly

Fulfillment Provider API (v0)

Download OpenAPI specification:Download

Represents a request to ship products in an order. Use this resource to accept or reject fulfillment requests. You can also retrieve and update the shipping status for a fulfillment request.

This resource only applies to orders routed to a warehouse for fulfillment.

To manage orders routed to stores for fulfillment, contact the support team.

To retrieve a list of fulfillment requests for an order, with the status of items in each fulfillment request, see Store and DC orders.

Accept fulfillment request

Accepts a fulfillment request. Acceptance indicates intent to fulfill.

Note: This only applies to orders routed to a DC or warehouse for fulfillment.

path Parameters

uuid required

string Unique ID for a fulfillment request.

Responses

/v0/d/fulfillment_requests/{uuid}/acknowledgement

Response samples

• 400

Content type

application/json

{

• "error_code": "already_shipped",
• "error_description": "string"

}

Get item cancelation status

Returns the cancelation status of items in a fulfillment request. Use this method to check if a item in a fulfillment request was successfully canceled.

This method only works if the Cancel items method was used to cancel the fulfillment request.

Note: This only applies to orders routed to a DC or warehouse for fulfillment.

Important: You cannot cancel an item after it has been shipped or rejected.

path Parameters

uuid required

string Unique ID for a fulfillment request.

Responses

/v0/d/fulfillment_requests/{uuid}/canceled_items

Response samples

• 200

Content type

application/json

Example

Successfully canceled itemsFailed canceled itemsSuccessful and failed canceled itemsSuccessfully canceled items

{

• "canceled_items": [

  • {

    • "accepted_at": "2018-10-17T13:57:59.349Z",
    • "product_id": "1000041",
    • "item_id": "85235c11-b515-4330-9345-b923a23dc352",
    • "received_at": "2018-10-17T13:57:59.296Z"

    }

  ]

}

Cancel items

Marks some or all items of a fulfillment request as canceled. This immediately releases allocations and means that the item can no longer be fulfilled.

To retrieve the status of the cancelation, use the Get item cancelation status.

Note: This only applies to orders routed to a DC or warehouse for fulfillment.

To cancel an item in an order that is routed to a store for fulfillment, contact the support team.

Important: You cannot cancel an item after it has been shipped or rejected.

path Parameters

uuid required

string Unique ID for a fulfillment request.

Request Body schema: application/json

product_ids required

Array of strings non-empty A list of product IDs, e.g. SKU that will be canceled.

Responses

/v0/d/fulfillment_requests/{uuid}/canceled_items

Request samples

• Payload

Content type

application/json

{

• "product_ids": [

  • "1000041",
  • "1000201"

  ]

}

Response samples

• 400
• 404
• 409

Content type

application/json

{

• "Bad payload": {

  • "value": {

    • "error_code": "payload_conversion_failed",
    • "error_description": "The provided payload failed to be converted to the NewStore model, check if the data is in the right format."

    }

  },
• "Already rejected": {

  • "value": {

    • "error_code": "already_rejected",
    • "error_description": "The fulfillment request has already been rejected."

    }

  }

}

Get item rejection status

Returns a list of all rejected items in a fulfillment request. Use this method to check if a item in a fulfillment request was successfully rejected.

Note: This only applies to orders routed to a DC or warehouse for fulfillment.

Important: You cannot reject an item after it has been shipped or canceled.

path Parameters

uuid required

string Unique ID for a fulfillment request.

Responses

/v0/d/fulfillment_requests/{uuid}/reject_items

Response samples

• 200

Content type

application/json

Example

Successfully rejected itemsFailed rejected itemsSuccessful and failed rejected itemsSuccessfully rejected items

{

• "rejected_items": [

  • {

    • "accepted_at": "2018-10-17T13:57:59.349Z",
    • "product_id": "1000041",
    • "received_at": "2018-10-17T13:57:59.296Z",
    • "rejection_reason": "no_inventory"

    }

  ]

}

Reject items

Marks some or all items of a fulfillment request as not fulfillable. Provide a rejection reason for each item.

Typical reasons are no_inventory to mark items as rejected due to missing inventory or cannot_fulfill if the DC is not able to fulfill the request.

Note: This only applies to orders routed to a DC or warehouse for fulfillment.

To cancel a fulfillment request that is routed to a store, contact the support team.

To address all products for a given fulfillment request, supply an empty product-id; see payload example Special case; with no specificity-- this operation will defensively fail with an invalid_item error if more than one object is supplied.

path Parameters

uuid required

string Unique ID for a fulfillment request.

Request Body schema: application/json

required	Array of objects non-empty
Array (non-empty) product_ids required Array of strings[ items >= 0 characters ] A list of product identifiers of all items that can't be fulfilled reason required string (Rejection reason) Enum: "no_inventory" "cannot_fulfill" The reason why the products couldn't be fulfilled.

Responses

/v0/d/fulfillment_requests/{uuid}/reject_items

Request samples

• Payload

Content type

application/json

Example

Regular case; specified product identifiersSpecial case; with no specificityRegular case; specified product identifiers

{

• "missing_items": [

  • {

    • "product_ids": [

      • "123456",
      • "7890123"

      ],
    • "reason": "no_inventory"

    },
  • {

    • "product_ids": [

      • "654321"

      ],
    • "reason": "cannot_fulfill"

    }

  ]

}

Response samples

• 400

Content type

application/json

Example

Already rejectedAlready shippedItem already shippedItem already rejectedItem already canceledInvalid itemFulfillment request invalidReject items request conversion_failedAlready rejected

{

• "error_code": "already_rejected",
• "error_description": "The fulfillment request has already been rejected."

}

Get rejection status Deprecated

Note: This method is deprecated. Use the Get item rejection status method instead.

Returns the rejection status of a fulfillment request. Use it to check whether a request has been successfully processed as rejected or not. This method only works if the Reject request method was used to reject the fulfillment request.

Important: You cannot reject a request after one or more of its items have been shipped.

path Parameters

uuid required

string Unique ID for a fulfillment request.

Responses

/v0/d/fulfillment_requests/{uuid}/rejection

Response samples

• 200

Content type

application/json

{

• "rejection_reason": "no_inventory",
• "missing_product_ids": [

  • "string"

  ],
• "error_code": "string",
• "received_at": "2019-08-24T14:15:22Z",
• "accepted_at": "2019-08-24T14:15:22Z"

}

Reject fulfillment request Deprecated

Note: This method is deprecated. Use the Reject items method instead.

Rejects a fulfillment request and all the items it contains. Specify the rejection reason (rejection_reason):

1. cannot_fulfill: Marks all items in the fulfillment request as rejected due to an inability to fulfill the request. In this case, the missing_items field in the payload has to be empty.
2. no_inventory: Marks specific items in the fulfillment request as rejected due to missing inventory. In this case, the missing_items field has to be set with the IDs of the items that cannot be fulfilled.

path Parameters

uuid required

string Unique ID for a fulfillment request.

Request Body schema: application/json

rejection_reason required	string Enum: "no_inventory" "cannot_fulfill"
missing_product_ids	Array of strings List of identifiers of the items concerned by the rejection request.

Responses

/v0/d/fulfillment_requests/{uuid}/rejection

Request samples

• Payload

Content type

application/json

{

• "rejection_reason": "no_inventory",
• "missing_product_ids": [

  • "string"

  ]

}

Response samples

• 400

Content type

application/json

{

• "error_code": "already_shipped",
• "error_description": "string"

}

Resend fulfillment request

Resends the specified fulfillment request, regardless of its shipment status (acknowledged, shipped or rejected).

Use this method if NewStore was unable to send the fulfillment request.

Note: This only applies to orders routed to a DC or warehouse for fulfillment.

path Parameters

uuid required

string Unique ID for a fulfillment request.

Responses

/v0/d/fulfillment_requests/{uuid}/resend

Get shipping status

Retrieves the shipment status of a fulfillment request. Use it to check if the shipment of a fulfillment request has been successfully processed or not.

Note: This only applies to orders routed to a DC or warehouse for fulfillment.

path Parameters

uuid required

string Unique ID for a fulfillment request.

Responses

/v0/d/fulfillment_requests/{uuid}/shipment

Response samples

• 200

Content type

application/json

{

• "failed_shipments": [

  • {

    • "error_code": "shipment_already_started",
    • "carrier": "FEDEX",
    • "carrier_service_level": "FEDEX_GROUND",
    • "product_id": "1000041",
    • "received_at": "2018-10-17T14:02:02.814Z",
    • "tracking_code": "1234567890"

    }

  ],
• "successful_shipments": [

  • {

    • "accepted_at": "2018-10-17T14:02:02.872Z",
    • "carrier": "FEDEX",
    • "carrier_service_level": "FEDEX_GROUND",
    • "product_id": "1000041",
    • "received_at": "2018-10-17T14:02:02.814Z",
    • "tracking_code": "1234567890",
    • "tracking_url": "https://www.fedex.com/fedextrack/?tracknumbers=1234567890"

    }

  ]

}

Update shipping status

Marks some or all items of a fulfillment request as shipped.

Note: This only applies to orders routed to a DC or warehouse for fulfillment.

To mark an item as shipped, which was part of an order that is routed to a store for fulfillment, contact the support team.

path Parameters

uuid required

string Unique ID for a fulfillment request.

Request Body schema: application/json

required	Array of objects
Array product_ids required Array of strings required object

Responses

/v0/d/fulfillment_requests/{uuid}/shipment

Request samples

• Payload

Content type

application/json

{

• "line_items": [

  • {

    • "product_ids": [

      • "1000001",
      • "1000061"

      ],
    • "shipment": {

      • "tracking_code": "1234",
      • "tracking_url": "https://www.fedex.com/fedextrack/?tracknumbers=1234",
      • "carrier": "FEDEX",
      • "carrier_service_level": "FEDEX_GROUND"

      }

    }

  ]

}

Response samples

• 400

Content type

application/json

{

• "error_code": "already_rejected",
• "error_description": "string",
• "conflicting_items": [

  • "string"

  ]

}