Sign in
latestOpenAPI 3.0.12026-08-101292701.1 MB

f21981db32be

Fulfillments

Creates a Fulfillment

Fulfills and/or cancels all or part of an order.

post/fulfillments

Request body

orderIdstring required

The identifier of the Order associated with this Fulfillment.

shipmentIdstring

The unique identifier associated to the shipment

currencystring

A valid ISO 4217 code that represents the currency the distributor should be paid in. If <code> items[].distributorCost</code> or <code>items[].shippingCost</code> are specified, then <code>currency</code> is required. The value doesn't have to be the same as the Order's <code>currency</code>.

metadataMetadata

Key-value pairs used to store additional data. Value can be string, boolean or integer types.

trackingCompanystring

The name of the tracking company.

trackingNumberstring

The tracking number provided by the shipping company.

trackingUrlstring

The URL of the tracking page for the fulfillment.

partnerIdstring

The unique identifier of the partner associated with the sku.

Example request

{
  "orderId": "5678901234",
  "shipmentId": "321765",
  "items": [
    {
      "itemId": "98784590336",
      "skuId": "98784590336",
      "shipmentItemId": "321765",
      "quantity": 1,
      "cancelQuantity": 1,
      "trackingCompany": "Fedex",
      "trackingNumber": "5678901234",
      "trackingUrl": "http://www.digitalriver.com?code=5678901234",
      "subfulfillerId": "hjueo9g",
      "distributorCost": 10,
      "shippingCost": 10
    }
  ],
  "currency": "USD",
  "metadata": {
    "coupon": "iOS"
  },
  "trackingCompany": "Fedex",
  "trackingNumber": "5678901234",
  "trackingUrl": "http://www.digitalriver.com?code=5678901234",
  "partnerId": "partner123"
}

Response

201 Created

idstring

The unique identifier of the Fulfillment.

createdTimestring date-time

The time when the Fulfillment was created.

orderIdstring

The unique identifier of the Order associated with this Fulfillment.

shipmentIdstring

The unique identifier associated to the shipment

currencystring

A valid ISO 4217 code that represents the currency the distributor is paid in.

liveModeboolean

Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.

metadataMetadata

Key-value pairs used to store additional data. Value can be string, boolean or integer types.

trackingCompanystring

The name of the tracking company.

trackingNumberstring

A tracking number provided by the shipping company.

trackingUrlstring

The URL of the tracking page for the Fulfillment.

Example response

{
  "id": "ful_25c651d0-8079-48d7-b22e-eb1e2f451966",
  "createdTime": "2018-04-25T20:36:00Z",
  "orderId": "ord_5678901234",
  "shipmentId": "321765",
  "items": [
    {
      "itemId": "98784590336",
      "skuId": "98784590336",
      "shipmentItemId": "321765",
      "quantity": 1,
      "cancelQuantity": 1,
      "trackingCompany": "Fedex",
      "trackingNumber": "5678901234",
      "trackingUrl": "http://www.digitalriver.com?code=5678901234",
      "subfulfillerId": "hjueo9g",
      "distributorCost": 10,
      "shippingCost": 10
    }
  ],
  "currency": "USD",
  "metadata": {
    "coupon": "iOS"
  },
  "trackingCompany": "Fedex",
  "trackingNumber": "5678901234",
  "trackingUrl": "http://www.digitalriver.com?code=5678901234"
}