--- title: "Creates a new Fulfillment order" method: POST path: "/fulfillment-orders" tags: ["Fulfillment Orders"] --- # Creates a new Fulfillment order `POST /fulfillment-orders` Creates a new Fulfillment order. ## Request body - GlobalFulfillmentOrderRequest - `currency` string, required — A three-letter ISO currency code. - `locale` string — A locale designator that combines a two-letter ISO 639-1 language code with a ISO 3166-1 alpha-2 country code. - `upstreamOrderTime` string, date-time, required — The date and time at which the upstream order was created. The specified value should be in ISO-8601 UTC format. - `name` string — The customer's name. - `email` string, email — The customer's email address. - `phone` string — The customer's phone number. - `reservationId` string — An inventory reservation identifier. - `upstreamId` string — The upstream order identifier. - `shipTo` Shipping, required - `address` Address — Represents basic address information. - `line1` string, nullable — The first line of the address. - `line2` string — The second line of the address. - `city` string, nullable — The city of the address. - `postalCode` string, nullable — The postal code of the address. - `state` string, nullable — The state, county, province, or region. - `country` string, required — A [two-letter Alpha-2 country code](https://www.iban.com/country-codes) as described in the [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) international standard. - `name` string, nullable — The recipient’s name. - `phone` string, nullable — The recipient’s phone number. - `email` string, email, nullable — The recipient’s email address. - `organization` string, nullable — The recipient’s organization. - `additionalAddressInfo` AdditionalAddressInfo — Captures any information that's not included in the basic address. - `neighborhood` string, nullable — The neighborhood of the address. - `division` string, nullable — A division within an organization. - `phoneticName` string, nullable — The phonetic spelling of a name. - `shippingChoice` GlobalFulfillmentShippingChoice, required - `shippingInstructions` string, nullable — Specific shipping instructions. - `dutiesPaid` boolean, nullable — Indicates whether the upstream order triggered the landed cost feature. - `id` string, required — The unique identifier of the shipping quote. - `signatureRequiredType` 'standard' | 'adult', nullable — Indicates whether a signature is needed upon delivery, and, if it is, what type of signature is required. - `items` LineItemRequest[], required - `upstreamId` string — The upstream line item identifier. - `inventoryItemId` string, required — The inventory item identifier. - `shipping` number, double — The shipping cost for this line item - `subtotal` number, double — The product price of this line item multiplied by its quantity. - `total` number, double — The aggregate price of the product inclusive of taxes, discounts, fees, shipping, handling and duties. - `name` string — The product name. - `quantity` integer, required - `giftMessage` string — The gift message on the package of the product. - `giftWrap` boolean — Has the value true if the item should be gift wrapped. - `tax` GlobalFulfillmentTax - `items` TaxDetail[] - `authorityType` string, required - `amount` number, double, required — The tax amount. - `amount` number, double, required — The tax amount. - `metadata` Metadata — Key-value pairs used to store additional data. Value can be string, boolean or integer types. - `metadata` Metadata — Key-value pairs used to store additional data. Value can be string, boolean or integer types. ## Response `201` 201 Created - GlobalFulfillmentOrder - `id` number — The unique identifier of the fulfillment order. - `createdTime` string, date-time — The time when the fulfillment order was created. - `currency` string — A three-letter ISO currency code. - `locale` string — A locale designator that combines a two-letter ISO 639-1 language code with a ISO 3166-1 alpha-2 country code. - `upstreamOrderTime` string, date-time — The time at which the upstream order was created. - `name` string — The customer's name. - `email` string, email — The customer's email address. - `phone` string — The customer's phone number. - `reservationId` string — An inventory reservation identifier. - `upstreamId` string — The upstream order identifier. - `shipTo` Shipping - `address` Address — Represents basic address information. - `line1` string, nullable — The first line of the address. - `line2` string — The second line of the address. - `city` string, nullable — The city of the address. - `postalCode` string, nullable — The postal code of the address. - `state` string, nullable — The state, county, province, or region. - `country` string, required — A [two-letter Alpha-2 country code](https://www.iban.com/country-codes) as described in the [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) international standard. - `name` string, nullable — The recipient’s name. - `phone` string, nullable — The recipient’s phone number. - `email` string, email, nullable — The recipient’s email address. - `organization` string, nullable — The recipient’s organization. - `additionalAddressInfo` AdditionalAddressInfo — Captures any information that's not included in the basic address. - `neighborhood` string, nullable — The neighborhood of the address. - `division` string, nullable — A division within an organization. - `phoneticName` string, nullable — The phonetic spelling of a name. - `shippingChoice` GlobalFulfillmentShippingChoice - `shippingInstructions` string, nullable — Specific shipping instructions. - `dutiesPaid` boolean, nullable — Indicates whether the upstream order triggered the landed cost feature. - `id` string, required — The unique identifier of the shipping quote. - `signatureRequiredType` 'standard' | 'adult', nullable — Indicates whether a signature is needed upon delivery, and, if it is, what type of signature is required. - `items` LineItem[] - `id` number - `upstreamId` string — The upstream line item identifier. - `inventoryItemId` string — The inventory item identifier. - `shipping` number, double — The shipping cost for this line item - `subtotal` number, double — The product price of this line item multiplied by its quantity. - `total` number, double — The aggregate price of the product inclusive of taxes, discounts, fees, shipping, handling and duties. - `name` string — The product name. - `quantity` integer — The item quantity. - `pending` integer — The pending shipment quantity. - `backordered` integer — The backordered quantity. - `shipped` integer — The shipped quantity. - `cancelled` integer — The cancelled quantity. - `returned` integer — The returned quantity. - `giftMessage` string, nullable — The gift message on the package of the product. - `giftWrap` boolean — Has the value true if the item should be gift wrapped. - `tax` GlobalFulfillmentTax - `items` TaxDetail[] - `authorityType` string, required - `amount` number, double, required — The tax amount. - `amount` number, double, required — The tax amount. - `state` 'pending' | 'backordered' | 'cancelled' | 'shipped' — Current line item state. - `metadata` Metadata — Key-value pairs used to store additional data. Value can be string, boolean or integer types. - `state` 'pending' | 'cancelled' | 'shipped' — The current state of the fulfillment order. - `liveMode` boolean — Has the value true if the object exists in live mode or the value false if the object exists in test mode. - `metadata` Metadata — Key-value pairs used to store additional data. Value can be string, boolean or integer types. ## Other responses - `400` — 400 Bad Request - `401` — 401 Unauthorized - `403` — 403 Forbidden - `405` — 405 Method Not Allowed - `406` — 406 Not Acceptable - `408` — 408 Request Timeout - `409` — 409 Conflict - `429` — 429 Too Many Requests - `500` — 500 Internal Server Error - `502` — 502 Bad Gateway Error - `503` — 503 Service Unavailable Error - `504` — 504 Gateway Timeout Error --- [API](https://skmtc.net/digitalriver/apis/digital-river-api-reference.md) · [All operations](https://skmtc.net/digitalriver/apis/digital-river-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/digitalriver/digital-river-api-reference/revisions/f21981db32be/schema)