Get Orders - ShipBob

Authorizations

Authorization

string

header

required

Authentication using Personal Access Token (PAT) token

Headers

shipbob_channel_id

string<int32>

Channel Id for Operation

Query Parameters

Page

number<int32>

Page of orders to get

Required range: 1 <= x <= 2147483647

Limit

number<int32>

Amount of orders per page to request

Required range: 1 <= x <= 250

IDs

string

order ids to filter by, comma separated
Example: ?IDs=1,2

ReferenceIds

string

Reference ids to filter by, comma separated
Example: ?ReferenceIds=Ref1,Ref2

StartDate

string<date-time>

Start date to filter orders inserted later than

EndDate

string<date-time>

End date to filter orders inserted earlier than

SortOrder

string

Order to sort results in

HasTracking

boolean

Has any portion of this order been assigned a tracking number

LastUpdateStartDate

string<date-time>

Start date to filter orders updated later than

LastUpdateEndDate

string<date-time>

End date to filter orders updated later than

IsTrackingUploaded

boolean

Filter orders that their tracking information was fully uploaded

LastTrackingUpdateStartDate

string<date-time>

Start date to filter orders with tracking updates later than the supplied date. Will only return orders that have tracking information

LastTrackingUpdateEndDate

string<date-time>

End date to filter orders updated later than the supplied date. Will only return orders that have tracking information

Response

Success

channel

object

Created by channel metadata

Show child attributes

channel.id

integer<int32>

Unique id of the channel

channel.name

string | null

Name of the channel

Example:

"ShipBobs-Shopify-Store"

created_date

string<date-time>

Date this order was created

financials

object

Show child attributes

financials.total_price

number<double> | null

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

gift_message

string | null

Gift message associated with the order

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

Show child attributes

products.external_line_id

integer<int32> | null

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

products.gtin

string | null

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

products.id

integer<int32> | null

Unique id of the product

products.quantity

integer<int32>

The quantity of this product ordered

products.quantity_unit_of_measure_code

string | null

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

products.reference_id

string | null

Unique reference id of the product

Example:

"TShirtBlueM"

products.sku

string | null

Stock keeping unit for the product

Example:

"TShirtBlueM"

products.unit_price

number<double> | null

Price for one item

products.upc

string | null

Universal Product Code - Unique external identifier

purchase_date

string<date-time> | null

Date this order was purchase by the end user

recipient

object

Information about the recipient of an order

Show child attributes

recipient.address

object

required

Address of the recipient

Option 1
Option 2

Show child attributes

recipient.address.address1

string

required

First line of the address

Minimum string length: 1

Example:

"100 Nowhere Blvd"

recipient.address.city

string

required

The city

Minimum string length: 1

Example:

"Gotham City"

recipient.address.country

string

required

The country (Must be ISO Alpha-2 for estimates)

Minimum string length: 1

Example:

"US"

recipient.address.address2

string | null

Second line of the address

Example:

"Suite 100"

recipient.address.company_name

string | null

Name of the company receiving the shipment

Example:

"Wayne Enterprises"

recipient.address.state

string | null

The state or province

Example:

"NJ"

recipient.address.zip_code

string<postal-code> | null

The zip code or postal code

Example:

"07093"

recipient.name

string

required

Name of the recipient

Required string length: 1 - 300

Example:

"John Doe"

recipient.email

string<email> | null

Email address of the recipient

Example:

"[email protected]"

recipient.phone_number

string | null

Phone number of the recipient

Maximum string length: 50

Example:

"555-555-5555"

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.

Show child attributes

retailer_program_data.addresses

object[] | null

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

Show child attributes

retailer_program_data.addresses.address1

string

required

First line of the address

Minimum string length: 1

Example:

"100 Nowhere Blvd"

retailer_program_data.addresses.city

string

required

The city

Minimum string length: 1

Example:

"Gotham City"

retailer_program_data.addresses.country

string

required

The country (Must be ISO Alpha-2 for estimates)

Minimum string length: 1

Example:

"US"

retailer_program_data.addresses.type

enum<string>

required

Available options:

MarkFor,

ShipFrom

retailer_program_data.addresses.address2

string | null

Second line of the address

Example:

"Suite 100"

retailer_program_data.addresses.company_name

string | null

Name of the company receiving the shipment

Example:

"Wayne Enterprises"

retailer_program_data.addresses.state

string | null

The state or province

Example:

"NJ"

retailer_program_data.addresses.zip_code

string<postal-code> | null

The zip code or postal code

Example:

"07093"

retailer_program_data.customer_ticket_number

string | null

Customer Ticket Number

retailer_program_data.delivery_date

string<date-time> | null

Expected delivery date

retailer_program_data.department

string | null

Identifies a merchant's store department

retailer_program_data.doNotShipBeforeDate

string<date-time> | null

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

retailer_program_data.mark_for_store

string | null

Store Number

retailer_program_data.purchase_order_number

string

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

Minimum string length: 1

retailer_program_data.retailer_program_type

string

Identifies retailer-merchant combination

Minimum string length: 1

retailer_program_data.shipByDate

string<date-time> | null

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

shipments

object[] | null

Shipments affiliated with the order

Information about a shipment Information about a shipment

Option 1
Option 2

Show child attributes

shipments.actual_fulfillment_date

string<date-time> | null

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.

shipments.created_date

string<date-time>

Date this shipment was created

shipments.delivery_date

string<date-time> | null

The datetime of Shipment delivered to customer.

shipments.estimated_fulfillment_date

string<date-time> | null

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

shipments.estimated_fulfillment_date_status

enum<string>

Available options:

AwaitingInventoryAllocation,

AwaitingReset,

Unavailable,

PendingOnTime,

FulfilledOnTime,

PendingLate,

FulfilledLate

shipments.gift_message

string | null

Gift message associated with the shipment

Maximum string length: 500

shipments.id

integer<int32>

Unique id of the shipment

shipments.insurance_value

number<currency> | null

Monetary amount that this shipment was insured for

shipments.invoice_amount

number<currency> | null

Monetary amount that was invoiced for this shipment

shipments.invoice_currency_code

string | null

shipments.is_tracking_uploaded

boolean

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

shipments.last_tracking_update_at

string<date-time> | null

Timestamp for the last time this shipment had a tracking update

shipments.last_update_at

string<date-time> | null

Date this shipment was last updated

shipments.location

object

Information about a fulfillment center that a shipment can belong to

Show child attributes

shipments.location.id

integer<int32>

Id of the fulfillment center

shipments.location.name

string | null

Name of the fulfillment center

Example:

"Cicero (IL)"

shipments.measurements

object

Measurements of a shipment

Show child attributes

shipments.measurements.depth_in

integer<int32>

Total depth in inches

shipments.measurements.length_in

integer<int32>

Total length in inches

shipments.measurements.total_weight_oz

integer<int32>

Total weight in ounces

shipments.measurements.width_in

integer<int32>

Total width in inches

shipments.order_id

integer<int32>

Id of the order this shipment belongs to

shipments.package_material_type

enum<string>

Available options:

Unknown,

Box,

BubbleMailer,

PolyMailer,

FragileBox,

PosterTube,

Custom,

Bookfold,

OwnContainer,

Undefined

shipments.parent_cartons

object[] | null

Carton information for this shipment

Show child attributes

shipments.parent_cartons.barcode

string | null

Barcode assigned to this carton

shipments.parent_cartons.cartons

object[] | null

Cartons packed inside this parent container

Show child attributes

shipments.parent_cartons.cartons.barcode

string | null

Barcode assigned to this carton

shipments.parent_cartons.cartons.carton_details

object[] | null

Details about the contents of this carton

Show child attributes

shipments.parent_cartons.cartons.carton_details.products

object[] | null

List of what is packed in this carton

Show child attributes

shipments.parent_cartons.cartons.carton_details.products.id

integer<int32>

Unique id of the product

shipments.parent_cartons.cartons.carton_details.products.inventory_items

object[] | null

Information about fulfillable inventory items belonging to this product

Show child attributes

shipments.parent_cartons.cartons.carton_details.products.inventory_items.expiration_date

string<date-time> | null

Expiration date of the inventory

shipments.parent_cartons.cartons.carton_details.products.inventory_items.id

integer<int32>

Unique id of the inventory

shipments.parent_cartons.cartons.carton_details.products.inventory_items.is_dangerous_goods

boolean

Is inventory Dangerous Good

Example:

true

shipments.parent_cartons.cartons.carton_details.products.inventory_items.lot

string | null

Lot number of the inventory

Example:

"22222"

shipments.parent_cartons.cartons.carton_details.products.inventory_items.name

string | null

Name of the inventory item

Example:

"Medium Blue T-Shirt"

shipments.parent_cartons.cartons.carton_details.products.inventory_items.quantity

integer<int32>

Quantity of the inventory item to be included in the fulfillment

shipments.parent_cartons.cartons.carton_details.products.inventory_items.quantity_committed

integer<int32>

The quantity of the inventory item allocated from the assigned fulfillment center and committed to the order. If quantity committed is less than order quantity, then the inventory item is out of stock at the assigned fulfillment center.

shipments.parent_cartons.cartons.carton_details.products.inventory_items.serial_numbers

string[] | null

Serial number of the inventory

shipments.parent_cartons.cartons.carton_details.products.name

string | null

Name of the product

Example:

"Medium Blue T-Shirt"

shipments.parent_cartons.cartons.carton_details.products.reference_id

string | null

Unique reference id of the product

Example:

"TShirtBlueM"

shipments.parent_cartons.cartons.carton_details.products.sku

string | null

Stock keeping unit for the product

Example:

"TShirtBlueM"

shipments.parent_cartons.cartons.id

integer<int32>

ID assigned to this carton

shipments.parent_cartons.cartons.measurements

object

Measurements of a carton

Show child attributes

shipments.parent_cartons.cartons.measurements.depth_in

number<double>

Total depth in inches

shipments.parent_cartons.cartons.measurements.length_in

number<double>

Total length in inches

shipments.parent_cartons.cartons.measurements.total_weight_oz

number<double>

Total weight in ounces

shipments.parent_cartons.cartons.measurements.width_in

number<double>

Total width in inches

shipments.parent_cartons.cartons.type

string | null

Type of this carton container

Example:

"Box or pallet"

shipments.parent_cartons.measurements

object

Measurements of a carton

Show child attributes

shipments.parent_cartons.measurements.depth_in

number<double>

Total depth in inches

shipments.parent_cartons.measurements.length_in

number<double>

Total length in inches

shipments.parent_cartons.measurements.total_weight_oz

number<double>

Total weight in ounces

shipments.parent_cartons.measurements.width_in

number<double>

Total width in inches

shipments.parent_cartons.type

string | null

Type of this carton container

Example:

"Box or pallet"

shipments.products

object[] | null

Information about the products contained in this shipment

Show child attributes

shipments.products.id

integer<int32>

Unique id of the product

shipments.products.inventory_items

object[] | null

Information about fulfillable inventory items belonging to this product

Show child attributes

shipments.products.inventory_items.expiration_date

string<date-time> | null

Expiration date of the inventory

shipments.products.inventory_items.id

integer<int32>

Unique id of the inventory

shipments.products.inventory_items.is_dangerous_goods

boolean

Is inventory Dangerous Good

Example:

true

shipments.products.inventory_items.lot

string | null

Lot number of the inventory

Example:

"22222"

shipments.products.inventory_items.name

string | null

Name of the inventory item

Example:

"Medium Blue T-Shirt"

shipments.products.inventory_items.quantity

integer<int32>

Quantity of the inventory item to be included in the fulfillment

shipments.products.inventory_items.quantity_committed

integer<int32>

shipments.products.inventory_items.serial_numbers

string[] | null

Serial number of the inventory

shipments.products.name

string | null

Name of the product

Example:

"Medium Blue T-Shirt"

shipments.products.reference_id

string | null

Unique reference id of the product

Example:

"TShirtBlueM"

shipments.products.sku

string | null

Stock keeping unit for the product

Example:

"TShirtBlueM"

shipments.recipient

object

Information about the recipient of a shipment

Show child attributes

shipments.recipient.address

object

Address of the recipient

Option 1
Option 2

Show child attributes

shipments.recipient.address.address1

string

required

First line of the address

Minimum string length: 1

Example:

"100 Nowhere Blvd"

shipments.recipient.address.city

string

required

The city

Minimum string length: 1

Example:

"Gotham City"

shipments.recipient.address.country

string

required

The country (Must be ISO Alpha-2 for estimates)

Minimum string length: 1

Example:

"US"

shipments.recipient.address.address2

string | null

Second line of the address

Example:

"Suite 100"

shipments.recipient.address.company_name

string | null

Name of the company receiving the shipment

Example:

"Wayne Enterprises"

shipments.recipient.address.state

string | null

The state or province

Example:

"NJ"

shipments.recipient.address.zip_code

string<postal-code> | null

The zip code or postal code

Example:

"07093"

shipments.recipient.email

string<email> | null

Email address of the recipient

Example:

"[email protected]"

shipments.recipient.full_name

string | null

FullName of the recipient

Example:

"John Doe"

shipments.recipient.name

string | null

Name of the recipient

Example:

"John Doe"

shipments.recipient.phone_number

string<tel> | null

Phone number of the recipient

Example:

"555-555-5555"

shipments.reference_id

string | null

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

shipments.require_signature

boolean

If a shipment requires signature

shipments.ship_option

string | null

Name of the shipping option used for this shipment

Example:

"Standard"

shipments.status

enum<string>

Available options:

None,

Processing,

Completed,

Exception,

OnHold,

Cancelled,

CleanSweeped,

LabeledCreated,

ImportReview

shipments.status_details

object[] | null

Additional details about the shipment status

Show child attributes

shipments.status_details.description

string | null

Describes what the status detail means

shipments.status_details.exception_fulfillment_center_id

integer<int32> | null

shipments.status_details.extra_information

object

Show child attributes

shipments.status_details.extra_information.validation_messages

string[] | null

shipments.status_details.id

integer<int32>

The id of the status detail

shipments.status_details.inventory_id

integer<int32> | null

Inventory Id the detail applies to (if applicable)

shipments.status_details.name

string | null

Short name of the status detail

shipments.tracking

object

Tracking information for a shipment

Show child attributes

shipments.tracking.bol

string | null

Bill of lading (BOL) number. Document acknowledging receipt of cargo for shipment.

shipments.tracking.carrier

string | null

Carrier of the shipment

Example:

"USPS"

shipments.tracking.carrier_service

string | null

The carrier's service which was used for this shipment

Example:

"Priority"

shipments.tracking.pro_number

string | null

Tracking number used for freight carriers

shipments.tracking.scac

string | null

Standard Carrier Alpha Code (SCAC). Unique 2-4 letter code used to identify transportation companies.

shipments.tracking.shipping_date

string<date-time> | null

Date freight was shipped on

shipments.tracking.tracking_number

string | null

Tracking number of the shipment

Example:

"860C8CDC8F0B4FC7AB69AC86C20539EC"

shipments.tracking.tracking_url

string | null

URL to the website where a shipment can be tracked

Example:

"https://www.example.com/tracking?id=860C8CDC8F0B4FC7AB69AC86C20539EC"

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.

Show child attributes

shipping_terms.carrier_type

enum<string>

Available options:

Parcel,

Freight

shipping_terms.payment_term

enum<string>

Available options:

Collect,

ThirdParty,

Prepaid,

MerchantResponsible

status

enum<string>

Available options:

Processing,

Exception,

PartiallyFulfilled,

Fulfilled,

Cancelled,

ImportReview

API Reference

Authorizations

Headers

Query Parameters

Response