POST:order_fulfillments.json

Description

Create one or multiple fulfillments.

If you don't specify quantity in line items, the default is all fulfillable quantity.

If you don't specify line items at all, it is assumed that you want to ship everything that corresponds to order. Most shops will ship things in one go and they don't need to think about complexity of shipping things in multiple steps this way.

The fulfillment will be applied immediately if it's correct, otherwise it will be created in a "cancelled" state.

Use "type" to restrict automatic fulfillment to a particular type. By default it will do "physical".

Permission bit: "fulfillments.create"

Topic: Order Fulfillments

Query Parameters

order_id: String, required

Unique order identifier. See also: Unique Identifiers

Example: ?order_id=or_EQzGqWoY

shop_id: String, required

Unique shop identifier. See also: Unique Identifiers

Example: ?shop_id=sh_EQzGqWoY

type: FulfillmentType

When automatically creating a fulfillment, use only items from given category

Example: ?type=physical

Request Body

Array of OrderFulfillmentCreate

Copy
[
  {
    "email": false,
    "line_items": [
      {
        "dest_inventory_location_id": "il_EQzGqWoY",
        "inventory_location_id": "il_EQzGqWoY",
        "line_item_id": "li_EQzGqWoY",
        "quantity": 1,
        "variant_id": "va_EQzGqWoY"
      }
    ],
    "pickup_inventory_location_id": "",
    "scheduled_fulfillment_id": "",
    "scheduled_fulfillment_line_items": [
      {
        "dest_inventory_location_id": "il_EQzGqWoY",
        "line_item_id": "li_EQzGqWoY",
        "variant_id": "va_EQzGqWoY"
      }
    ],
    "shipping_provider_type": "auspost",
    "subscription_id": "",
    "tracking_company": "Ship & Co",
    "tracking_number": "1Z2345",
    "tracking_url": "http://www.google.com/search?q=1Z2345"
  }
]

Response Body

Array of OrderFulfillment

Response Body Type

Loading module