Sign in
latestOpenAPI 3.0.12026-08-101292701.1 MB

f21981db32be

Fulfillment Orders

Creates a new Fulfillment order

Creates a new Fulfillment order.

post/fulfillment-orders

Request body

currencystring required

A three-letter ISO currency code.

localestring

A locale designator that combines a two-letter ISO 639-1 language code with a ISO 3166-1 alpha-2 country code.

upstreamOrderTimestring date-time required

The date and time at which the upstream order was created. The specified value should be in ISO-8601 UTC format.

namestring

The customer's name.

emailstring email

The customer's email address.

phonestring

The customer's phone number.

reservationIdstring

An inventory reservation identifier.

upstreamIdstring

The upstream order identifier.

metadataMetadata

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

Example request

{
  "currency": "USD",
  "locale": "en_US",
  "upstreamOrderTime": "2018-04-25T20:36:00Z",
  "name": "John Smith",
  "email": "jsmith@digitalriver.com",
  "phone": "612-258-1966",
  "reservationId": "7765374748",
  "upstreamId": "7765374748",
  "shipTo": {
    "address": {
      "line1": "10380 Bren Rd W",
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    },
    "name": "John Smith",
    "phone": "952-111-1111",
    "email": "jsmith@digitalriver.com",
    "organization": "Digital River",
    "additionalAddressInfo": {
      "neighborhood": "Centro",
      "division": "営業部",
      "phoneticName": "ヤマダ タロ"
    }
  },
  "shippingChoice": {
    "shippingInstructions": ".",
    "id": "SG"
  },
  "items": [
    {
      "upstreamId": "123",
      "inventoryItemId": "abc",
      "shipping": 5,
      "subtotal": 10,
      "total": 10,
      "name": ".",
      "quantity": 1,
      "giftMessage": ".",
      "tax": {
        "items": [
          {
            "authorityType": "City",
            "amount": 9.99
          }
        ],
        "amount": 9.99
      },
      "metadata": {
        "coupon": "iOS"
      }
    }
  ],
  "metadata": {
    "coupon": "iOS"
  }
}

Response

201 Created

idnumber

The unique identifier of the fulfillment order.

createdTimestring date-time

The time when the fulfillment order was created.

currencystring

A three-letter ISO currency code.

localestring

A locale designator that combines a two-letter ISO 639-1 language code with a ISO 3166-1 alpha-2 country code.

upstreamOrderTimestring date-time

The time at which the upstream order was created.

namestring

The customer's name.

emailstring email

The customer's email address.

phonestring

The customer's phone number.

reservationIdstring

An inventory reservation identifier.

upstreamIdstring

The upstream order identifier.

state'pending' | 'cancelled' | 'shipped'

The current state of the fulfillment order.

liveModeboolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

metadataMetadata

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

Example response

{
  "id": 9292981838,
  "createdTime": "2018-04-25T20:36:00Z",
  "currency": "USD",
  "locale": "en_US",
  "upstreamOrderTime": "2018-04-25T20:36:00Z",
  "name": "John Smith",
  "email": "jsmith@digitalriver.com",
  "phone": "612-258-1966",
  "reservationId": "7765374748",
  "upstreamId": "7765374748",
  "shipTo": {
    "address": {
      "line1": "10380 Bren Rd W",
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    },
    "name": "John Smith",
    "phone": "952-111-1111",
    "email": "jsmith@digitalriver.com",
    "organization": "Digital River",
    "additionalAddressInfo": {
      "neighborhood": "Centro",
      "division": "営業部",
      "phoneticName": "ヤマダ タロ"
    }
  },
  "shippingChoice": {
    "shippingInstructions": ".",
    "id": "SG"
  },
  "items": [
    {
      "id": 449838789,
      "upstreamId": "123",
      "inventoryItemId": "abc",
      "shipping": 5,
      "subtotal": 10,
      "total": 10,
      "name": ".",
      "quantity": 1,
      "pending": 1,
      "giftMessage": ".",
      "tax": {
        "items": [
          {
            "authorityType": "City",
            "amount": 9.99
          }
        ],
        "amount": 9.99
      },
      "state": "pending",
      "metadata": {
        "coupon": "iOS"
      }
    }
  ],
  "state": "pending",
  "metadata": {
    "coupon": "iOS"
  }
}