Skip to main content
POST
/
1.0
/
order
Create Order
curl --request POST \
  --url https://gateway-dev.shipbob.dev/1.0/order \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'shipbob_channel_id: <shipbob_channel_id>' \
  --data '
{
  "financials": {
    "total_price": 0.1
  },
  "gift_message": "string",
  "location_id": 0,
  "order_number": "string",
  "products": [
    {
      "external_line_id": 0,
      "id": 0,
      "quantity": 1,
      "quantity_unit_of_measure_code": "string"
    }
  ],
  "purchase_date": "2019-08-24T14:15:22Z",
  "recipient": {
    "address": {
      "address1": "100 Nowhere Blvd",
      "address2": "Suite 100",
      "city": "Gotham City",
      "company_name": "Wayne Enterprises",
      "country": "US",
      "state": "NJ",
      "zip_code": "07093"
    },
    "email": "[email protected]",
    "name": "John Doe",
    "phone_number": "555-555-5555"
  },
  "reference_id": "string",
  "retailer_program_data": {
    "addresses": [
      {
        "address1": "100 Nowhere Blvd",
        "address2": "Suite 100",
        "city": "Gotham City",
        "company_name": "Wayne Enterprises",
        "country": "US",
        "state": "NJ",
        "type": "MarkFor",
        "zip_code": "07093"
      }
    ],
    "customer_ticket_number": "string",
    "delivery_date": "2019-08-24T14:15:22Z",
    "department": "string",
    "doNotShipBeforeDate": "2019-08-24T14:15:22Z",
    "mark_for_store": "string",
    "purchase_order_number": "string",
    "retailer_program_type": "string",
    "shipByDate": "2019-08-24T14:15:22Z"
  },
  "shipping_method": "Free 2-day Shipping",
  "shipping_terms": {
    "carrier_type": "Parcel",
    "payment_term": "Collect"
  },
  "tags": [
    {
      "name": "Handling instructions",
      "value": "Fragile"
    }
  ],
  "type": "DTC"
}
'
{
  "channel": {
    "id": 0,
    "name": "ShipBobs-Shopify-Store"
  },
  "created_date": "2019-08-24T14:15:22Z",
  "financials": {
    "total_price": 0.1
  },
  "gift_message": "string",
  "id": 0,
  "order_number": "string",
  "products": [
    {
      "external_line_id": 0,
      "gtin": "string",
      "id": 0,
      "quantity": 0,
      "quantity_unit_of_measure_code": "string",
      "reference_id": "TShirtBlueM",
      "sku": "TShirtBlueM",
      "unit_price": 0.1,
      "upc": "string"
    }
  ],
  "purchase_date": "2019-08-24T14:15:22Z",
  "recipient": {
    "address": {
      "address1": "100 Nowhere Blvd",
      "address2": "Suite 100",
      "city": "Gotham City",
      "company_name": "Wayne Enterprises",
      "country": "US",
      "state": "NJ",
      "zip_code": "07093"
    },
    "email": "[email protected]",
    "name": "John Doe",
    "phone_number": "555-555-5555"
  },
  "reference_id": "string",
  "retailer_program_data": {
    "addresses": [
      {
        "address1": "100 Nowhere Blvd",
        "address2": "Suite 100",
        "city": "Gotham City",
        "company_name": "Wayne Enterprises",
        "country": "US",
        "state": "NJ",
        "type": "MarkFor",
        "zip_code": "07093"
      }
    ],
    "customer_ticket_number": "string",
    "delivery_date": "2019-08-24T14:15:22Z",
    "department": "string",
    "doNotShipBeforeDate": "2019-08-24T14:15:22Z",
    "mark_for_store": "string",
    "purchase_order_number": "string",
    "retailer_program_type": "string",
    "shipByDate": "2019-08-24T14:15:22Z"
  },
  "shipments": [
    {
      "actual_fulfillment_date": "2019-08-24T14:15:22Z",
      "created_date": "2019-08-24T14:15:22Z",
      "delivery_date": "2019-08-24T14:15:22Z",
      "estimated_fulfillment_date": "2019-08-24T14:15:22Z",
      "estimated_fulfillment_date_status": "AwaitingInventoryAllocation",
      "gift_message": "string",
      "id": 0,
      "insurance_value": 0,
      "invoice_amount": 0,
      "invoice_currency_code": "string",
      "is_tracking_uploaded": true,
      "last_tracking_update_at": "2019-08-24T14:15:22Z",
      "last_update_at": "2019-08-24T14:15:22Z",
      "location": {
        "id": 0,
        "name": "Cicero (IL)"
      },
      "measurements": {
        "depth_in": 0,
        "length_in": 0,
        "total_weight_oz": 0,
        "width_in": 0
      },
      "order_id": 0,
      "package_material_type": "Unknown",
      "parent_cartons": [
        {
          "barcode": "string",
          "cartons": [
            {
              "barcode": "string",
              "carton_details": [
                {
                  "products": [
                    {
                      "id": 0,
                      "inventory_items": [
                        {
                          "expiration_date": "2019-08-24T14:15:22Z",
                          "id": 0,
                          "is_dangerous_goods": true,
                          "lot": "22222",
                          "name": "Medium Blue T-Shirt",
                          "quantity": 0,
                          "quantity_committed": 0,
                          "serial_numbers": [
                            "string"
                          ]
                        }
                      ],
                      "name": "Medium Blue T-Shirt",
                      "reference_id": "TShirtBlueM",
                      "sku": "TShirtBlueM"
                    }
                  ]
                }
              ],
              "id": 0,
              "measurements": {
                "depth_in": 0.1,
                "length_in": 0.1,
                "total_weight_oz": 0.1,
                "width_in": 0.1
              },
              "type": "Box or pallet"
            }
          ],
          "measurements": {
            "depth_in": 0.1,
            "length_in": 0.1,
            "total_weight_oz": 0.1,
            "width_in": 0.1
          },
          "type": "Box or pallet"
        }
      ],
      "products": [
        {
          "id": 0,
          "inventory_items": [
            {
              "expiration_date": "2019-08-24T14:15:22Z",
              "id": 0,
              "is_dangerous_goods": true,
              "lot": "22222",
              "name": "Medium Blue T-Shirt",
              "quantity": 0,
              "quantity_committed": 0,
              "serial_numbers": [
                "string"
              ]
            }
          ],
          "name": "Medium Blue T-Shirt",
          "reference_id": "TShirtBlueM",
          "sku": "TShirtBlueM"
        }
      ],
      "recipient": {
        "address": {
          "address1": "100 Nowhere Blvd",
          "address2": "Suite 100",
          "city": "Gotham City",
          "company_name": "Wayne Enterprises",
          "country": "US",
          "state": "NJ",
          "zip_code": "07093"
        },
        "email": "[email protected]",
        "full_name": "John Doe",
        "name": "John Doe",
        "phone_number": "555-555-5555"
      },
      "reference_id": "string",
      "require_signature": true,
      "ship_option": "Standard",
      "status": "None",
      "status_details": [
        {
          "description": "string",
          "exception_fulfillment_center_id": 0,
          "extra_information": {
            "validation_messages": [
              "string"
            ]
          },
          "id": 0,
          "inventory_id": 0,
          "name": "string"
        }
      ],
      "tracking": {
        "bol": "string",
        "carrier": "USPS",
        "carrier_service": "Priority",
        "pro_number": "string",
        "scac": "string",
        "shipping_date": "2019-08-24T14:15:22Z",
        "tracking_number": "860C8CDC8F0B4FC7AB69AC86C20539EC",
        "tracking_url": "https://www.example.com/tracking?id=860C8CDC8F0B4FC7AB69AC86C20539EC"
      }
    }
  ],
  "shipping_method": "Free 2-day Shipping",
  "shipping_terms": {
    "carrier_type": "Parcel",
    "payment_term": "Collect"
  },
  "status": "Processing",
  "tags": [
    {
      "name": "Handling instructions",
      "value": "Fragile"
    }
  ],
  "type": "DTC"
}

Authorizations

​
Authorization
string
header
required

Authentication using Personal Access Token (PAT) token

Headers

​
shipbob_channel_id
string<int32>
required

Channel Id for Operation

Body

application/json
​
products
object[]
required

Products included in the order. Products identified by reference_id must also include the product name if there is no matching ShipBob product.

Minimum array length: 1
​
recipient
object
required

Information about the recipient of an order

​
financials
object
​
gift_message
string | null

Gift message associated with the order

Maximum string length: 500
​
location_id
integer<int32> | null

Desired Fulfillment Center Location ID. If not specified, ShipBob will determine the location that fulfills this order.

​
order_number
string | null

User friendly orderId or store order number that will be shown on the Orders Page. If not provided, referenceId will be used

Maximum string length: 400
​
origin_platform_program
string | null

Origin platform program for the order. Accepts a program name.

Maximum string length: 100
Example:

"FBM"

​
purchase_date
string<date-time> | null

Date this order was purchase by the end user

​
reference_id
string

Unique and immutable order identifier from your upstream system

Required string length: 1 - 300
​
retailer_program_data
object

Contains properties that needs to be used for fulfilling B2B/Dropship orders.

​
sales_channel
string | null

Origin platform source for the order. Accepts a sales channel name.

Maximum string length: 100
Example:

"Amazon"

​
shipping_method
string

Client-defined shipping method matching what the user has listed as the shipping method on the Ship Option Mapping setup page in the ShipBob Merchant Portal. If they don’t match, we will create a new one and default it to Standard

Minimum string length: 1
Example:

"Free 2-day Shipping"

​
shipping_terms
object

Contains shipping properties that need to be used for fulfilling an order.

​
tags
object[] | null

Key value pair array to store extra information at the order level for API purposes. ShipBob won't display the info in the ShipBob Merchant Portal or react based on this data.

​
type
enum<string>
Available options:
DTC,
DropShip,
B2B

Response

Created

​
channel
object

Created by channel metadata

​
created_date
string<date-time>

Date this order was created

​
financials
object
​
gift_message
string | null

Gift message associated with the order

​
id
integer<int32>

Unique id of the order

​
order_number
string | null

User friendly orderId or store order number that will be shown on the Orders Page. If not provided, referenceId will be used

​
products
object[] | null

List of products included in the order

​
purchase_date
string<date-time> | null

Date this order was purchase by the end user

​
recipient
object

Information about the recipient of an order

​
reference_id
string | null

Client-defined external unique id of the order

​
retailer_program_data
object

Contains properties that needs to be used for fulfilling B2B/Dropship orders.

​
shipments
object[] | null

Shipments affiliated with the order

Information about a shipment

​
shipping_method
string | null

Client-defined shipping method

Example:

"Free 2-day Shipping"

​
shipping_terms
object

Contains shipping properties that need to be used for fulfilling an order.

​
status
enum<string>
Available options:
Processing,
Exception,
PartiallyFulfilled,
Fulfilled,
Cancelled,
ImportReview
​
tags
object[] | null

Client-defined order tags

​
type
enum<string>
Available options:
DTC,
DropShip,
B2B