Sign in
latestOpenAPI 3.0.12026-08-101292701.1 MB

f21981db32be

Fulfillments

Updates an existing fulfillment

Updates an existing fulfillment.

post/fulfillments/{id}

Path parameters

idstring required

Fulfillment ID

Request body

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 request

{
  "trackingCompany": "Fedex",
  "trackingNumber": "5678901234",
  "trackingUrl": "http://www.digitalriver.com?code=5678901234",
  "items": [
    {
      "itemId": "98784590336",
      "trackingCompany": "Fedex",
      "trackingNumber": "5678901234",
      "trackingUrl": "http://www.digitalriver.com?code=5678901234"
    }
  ],
  "metadata": {
    "coupon": "iOS"
  }
}

Response

200 OK

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"
}