Fulfillment Provider API (2.0.0)

Download OpenAPI specification:Download

ShipEngine Connect: connect@shipengine.com URL: https://connect.shipengine.com/ License: Apache-2.0

This API specification describes the canonical ShipEngine Fulfillmen Provider module. A module which implements this specification can be integrated with the ShipEngine Fulfillments Platform as a Fulfillment Provider.

Cancel Fulfillment

Starts the cancellation process for a requested fulfillment. Fulfillment Provider Order ID was originally returned from the delegate fulfillment method. Status code 200 means the cancellation request was accepted.

Request
Request Body schema: application/json
transaction_id
required
string <guid>

A randomly generated transaction ID, used to correlate the request and response.

required
object (Auth)

Authentication properties

fulfillment_provider_order_id
required
string

Fulfillment provider order ID of the fulfillment to request to be cancelled.

reason
required
string

The reason for requesting a cancellation.

Responses
200

OK

post/cancel_fulfillment
Request samples
application/json
{
  • "transaction_id": "8e4e3181-2a7e-4153-ba6a-f2d6e121500b",
  • "auth": {
    },
  • "fulfillment_provider_order_id": "3b5aa32d-c082-4058-9c7a-1b523d431b52",
  • "reason": "Customer changed their order"
}
Response samples
application/json
{ }