Post 2026 07 Order

Create Order

POST/2026-07/order

Use it in a workflow

Add a step and choose the ShipBob connector.
Pick the Post 2026 07 Order action (under ShipBob).
Fill in the fields below, then reference the result from later steps as {{post202607Order.response.data}}.

Request

Headers

shipbob_channel_idinteger (int32)required

Channel Id for Operation

Request body

Enter the body as JSON in the step's Body field.

financialsobject

total_pricenumber (double)

Sum of all line item prices, discounts, and taxes in USD

gift_messagestring

Gift message associated with the order

location_idinteger (int32)

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

order_numberstring

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

origin_platform_programstring

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

productsarray<oneOf>required

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

purchase_datestring (date-time)

Date this order was purchase by the end user

recipientobjectrequired

Information about the recipient of an order

addressoneOfrequired

Address of the recipient

emailstring (email)

Email address of the recipient

namestringrequired

Name of the recipient

phone_numberstring

Phone number of the recipient

reference_idstringrequired

Unique and immutable order identifier from your upstream system

requested_delivery_datestring (date-time)

The delivery date requested by the source platform for the order in UTC

retailer_program_dataany

Required when type is DropShip or B2B. Omitting this object entirely, or supplying a retailer_program_type that is unrecognized or not enrolled, returns a 422 validation error; including the object without its required purchase_order_number or retailer_program_type fields returns a 400 validation error instead. Not used for DTC orders, where the API ignores this object.

sales_channelstring

One ofamazonbigcommerceebayfairemacymagentosheinshopifysquarespacetargetplustemutiktokunleashedwalmartwoocommerce

shipping_methodstringrequired

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

shipping_termsany

Required when type is DropShip or B2B. For those order types both carrier_type and payment_term must be present. A carrier_type of Freight with a payment_term of ThirdParty is rejected. For DTC orders the only accepted combination is a carrier_type of Parcel with a payment_term of Prepaid, or both values left empty.

tagsarray<object>

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.

namestringrequired

The key of the tag

valuestringrequired

The value of the tag

typeanyrequired

Order type. Accepted values are DTC, DropShip and B2B. DropShip and B2B orders must also include retailer_program_data and shipping_terms, or the create request fails validation with a 422 response. For DTC orders the API ignores retailer_program_data.

json

{
  "products": [
    null
  ],
  "recipient": {
    "address": null,
    "name": "John Doe",
    "email": "john@example.com",
    "phone_number": "555-555-5555"
  },
  "reference_id": "string",
  "shipping_method": "Free 2-day Shipping",
  "type": null,
  "financials": {
    "total_price": 0
  },
  "gift_message": "string",
  "location_id": 0,
  "order_number": "string",
  "origin_platform_program": "FBM",
  "purchase_date": "2025-01-01T00:00:00Z",
  "requested_delivery_date": "2025-01-01T00:00:00Z"
}

Response

Returns 201 with an object. Read it in later steps with {{post202607Order.response.data.<field>}}.

channelobject

Created by channel metadata

idinteger (int32)

Unique id of the channel

namestring

Name of the channel

created_datestring (date-time)

Date this order was created

financialsobject

total_pricenumber (double)

Sum of all line item prices, discounts, and taxes in USD

gift_messagestring

Gift message associated with the order

idinteger (int32)

Unique id of the order

order_numberstring

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

productsarray<object>

List of products included in the order

external_line_idinteger (int32)

Numeric assignment per item. Used as a reference number for multiple purposes such as split orders, split containers, etc.

gtinstring

Global Trade Item Number - unique and internationally recognized identifier assigned to item by company GS1

idinteger (int32)

Unique id of the product

quantityinteger (int32)

The quantity of this product ordered

quantity_unit_of_measure_codestring

Defined standard for measure for an item (each, inner pack, case, pallet). Values: EA, INP, CS and PL

reference_idstring

Unique reference id of the product

skustring

Stock keeping unit for the product

unit_pricenumber (double)

Price for one item

upcstring

Universal Product Code - Unique external identifier

purchase_datestring (date-time)

Date this order was purchase by the end user

recipientobject

Information about the recipient of an order

addressoneOfrequired

Address of the recipient

emailstring (email)

Email address of the recipient

namestringrequired

Name of the recipient

phone_numberstring

Phone number of the recipient

reference_idstring

Client-defined external unique id of the order

retailer_program_dataobject

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

addressesarray<object>1 fields

Ship From - Certain retailers want to display the ship from address as their return facility, not Shipbob’s warehouse address /// Mark For Address - Final destination address

customer_ticket_numberstring

Customer Ticket Number

delivery_datestring (date-time)

Expected delivery date

departmentstring

Identifies a merchant's store department

do_not_ship_before_datestring (date-time)

The date the retailer does not want the order shipped by.

mark_for_storestring

Store Number

purchase_order_numberstringrequired

First initial documentation sent from buyer to seller with item(s) and quantities.

retailer_program_typestringrequired

Program code that identifies the retailer and merchant combination. The code must already exist in the ShipBob retailer program configuration. Use SB-B2B for a standard ShipBob B2B order, because it is the one code the API accepts without the merchant being enrolled first. Retailer specific codes, for example TGTDS, need ShipBob support to enroll the merchant, otherwise the API returns "Merchant is not enabled for the Retailer Program Type". The code must also agree with the order type, otherwise the API reports a different Retailer Program Type than the one configured for the program code. A carrier_type of Parcel combined with a payment_term of Collect or ThirdParty can also be rejected for SB-B2B, depending on the merchant's retailer configuration.

ship_by_datestring (date-time)

The date the retailer has requested the order to ship by.

shipmentsarray<object>

Shipments affiliated with the order

actual_fulfillment_datestring (date-time)

The datetime of ShipBob’s completion of the fulfillment operation as promised. Currently, this means the shipment has been picked, packed, and label has been printed.

created_datestring (date-time)

Date this shipment was created

delivery_datestring (date-time)

The datetime of Shipment delivered to customer.

estimated_fulfillment_datestring (date-time)

The datetime of ShipBob’s commitment for completing the shipment and handing to the carrier for delivery.

estimated_fulfillment_date_statusstring

One ofAwaitingInventoryAllocationAwaitingResetUnavailablePendingOnTimeFulfilledOnTimePendingLateFulfilledLate

gift_messagestring

Gift message associated with the shipment

idinteger (int32)

Unique id of the shipment

insurance_valuenumber (currency)

Monetary amount that this shipment was insured for

invoice_amountnumber (currency)

Monetary amount that was invoiced for this shipment

invoice_currency_codestring

is_tracking_uploadedboolean

Indicates whether the Shipment was marked with tracking information uploaded to a third-party system where the order originated.

last_tracking_update_atstring (date-time)

Timestamp for the last time this shipment had a tracking update

last_update_atstring (date-time)

Date this shipment was last updated

locationobject2 fields

Information about a fulfillment center that a shipment can belong to

measurementsobject4 fields

Measurements of a shipment

order_idinteger (int32)

Id of the order this shipment belongs to

package_material_typestring

One ofUnknownBoxBubbleMailerPolyMailerFragileBoxPosterTubeCustomBookfoldOwnContainerUndefined

parent_cartonsarray<object>4 fields

Carton information for this shipment

productsarray<object>

Information about the products contained in this shipment

recipientobject5 fields

Information about the recipient of a shipment

reference_idstring

Client-defined external unique id of the order this shipment belongs to

require_signatureboolean

If a shipment requires signature

ship_optionstring

Name of the shipping option used for this shipment

statusstring

One ofNoneProcessingCompletedExceptionOnHoldCancelledCleanSweepedLabeledCreatedImportReview

status_detailsarray<object>6 fields

Additional details about the shipment status

trackingobject8 fields

Tracking information for a shipment

shipping_methodstring

Client-defined shipping method

shipping_termsobject

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

carrier_typestring

One ofParcelFreight

payment_termstring

One ofCollectThirdPartyPrepaidMerchantResponsible

statusstring

One ofProcessingExceptionPartiallyFulfilledFulfilledCancelledImportReview

tagsarray<object>

Client-defined order tags

namestringrequired

The key of the tag

valuestringrequired

The value of the tag

typestring

Order type. DTC is a direct to consumer order. DropShip and B2B are retailer program order types.

One ofDTCDropShipB2B

json

{
  "channel": {
    "id": 0,
    "name": "ShipBobs-Shopify-Store"
  },
  "created_date": "2025-01-01T00:00:00Z",
  "financials": {
    "total_price": 0
  },
  "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,
      "upc": "string"
    }
  ],
  "purchase_date": "2025-01-01T00:00:00Z",
  "recipient": {
    "address": null,
    "name": "John Doe",
    "email": "john@example.com",
    "phone_number": "555-555-5555"
  },
  "reference_id": "string",
  "retailer_program_data": {
    "purchase_order_number": "string",
    "retailer_program_type": "string",
    "addresses": [
      {
        "type": "MarkFor"
      }
    ],
    "customer_ticket_number": "string",
    "delivery_date": "2025-01-01T00:00:00Z",
    "department": "string",
    "do_not_ship_before_date": "2025-01-01T00:00:00Z",
    "mark_for_store": "string",
    "ship_by_date": "2025-01-01T00:00:00Z"
  },
  "shipments": [
    {
      "actual_fulfillment_date": "2025-01-01T00:00:00Z",
      "created_date": "2025-01-01T00:00:00Z",
      "delivery_date": "2025-01-01T00:00:00Z",
      "estimated_fulfillment_date": "2025-01-01T00:00:00Z",
      "estimated_fulfillment_date_status": "AwaitingInventoryAllocation",
      "gift_message": "string",
      "id": 0,
      "insurance_value": 0,
      "invoice_amount": 0,
      "invoice_currency_code": "string",
      "is_tracking_uploaded": false,
      "last_tracking_update_at": "2025-01-01T00:00:00Z"
    }
  ]
}

Need more? See the ShipBob guide for connection setup and behaviour shared by every action.

Was this page helpful?