ShipBob · Capability
API Reference — subpackage_orders
API Reference — subpackage_orders. 22 operations. Lead operation: Create Order. Self-contained Naftiko capability covering one Shipbob business surface.
What You Can Do
POST
Createorder
— Create Order
/v1/2026-01/order
GET
Getorders
— Get Orders
/v1/2026-01/order
GET
Getorder
— Get Order
/v1/2026-01/order/{orderid}
GET
Getallshipmentsfororder
— Get All Shipments for Order
/v1/2026-01/order/{orderid}/shipment
GET
Getshipmentbyorderidandshipmentid
— Get Shipment by Order ID and Shipment ID
/v1/2026-01/order/{orderid}/shipment/{shipmentid}
GET
Getshipmentlogsbyorderidandshipmentid
— Get Shipment Logs by Order ID and Shipment ID
/v1/2026-01/order/{orderid}/shipment/{shipmentid}/logs
GET
Getshipmentstatustimelinebyorderidandshipmentid
— Get Shipment Status Timeline by Order ID and Shipment ID
/v1/2026-01/order/{orderid}/shipment/{shipmentid}/timeline
POST
Cancelshipmentbyorderidandshipmentid
— Cancel Shipment by Order ID and Shipment ID
/v1/2026-01/order/{orderid}/shipment/shipmentid-cancel
GET
Getorderstoredata
— Get Order Store Data
/v1/2026-01/order/{orderid}/store-order-json
POST
Cancelorder
— Cancel Order
/v1/2026-01/order/orderid-cancel
POST
Estimatefulfillmentcostfororder
— Estimate Fulfillment Cost For Order
/v1/2026-01/order-estimate
GET
Getshipment
— Get Shipment
/v1/2026-01/shipment/{shipmentid}
GET
Getshipmentlogs
— Get Shipment Logs
/v1/2026-01/shipment/{shipmentid}/logs
GET
Getshipmenttimeline
— Get Shipment Timeline
/v1/2026-01/shipment/{shipmentid}/timeline
POST
Cancelshipment
— Cancel Shipment
/v1/2026-01/shipment/shipmentid-cancel
GET
Getshipmentlineitems
— Get Shipment Line Items
/v1/2026-01/shipment/shipmentid-getlineitems
PUT
Updateshipmentaddress
— Update Shipment Address
/v1/2026-01/shipment/shipmentid-updateaddress
POST
Updateshipmentlineitems
— Update Shipment Line Items
/v1/2026-01/shipment/shipmentid-updatelineitems
POST
Batchcancelshipments
— Batch Cancel Shipments
/v1/2026-01/shipment-batchcancel
POST
Marktrackinguploaded
— Mark Tracking Uploaded
/v1/2026-01/shipment-batchupdatetrackingupload
PUT
Bulkupdateshippingservice
— Bulk Update Shipping Service
/v1/2026-01/shipment-bulkupdateshippingservice
GET
Getshippingmethods
— Get Shipping Methods
/v1/2026-01/shipping-method
MCP Tools
create-order
Create Order
get-orders
Get Orders
read-only
idempotent
get-order
Get Order
read-only
idempotent
get-all-shipments-order
Get All Shipments for Order
read-only
idempotent
get-shipment-order-id-and
Get Shipment by Order ID and Shipment ID
read-only
idempotent
get-shipment-logs-order-id
Get Shipment Logs by Order ID and Shipment ID
read-only
idempotent
get-shipment-status-timeline-order
Get Shipment Status Timeline by Order ID and Shipment ID
read-only
idempotent
cancel-shipment-order-id-and
Cancel Shipment by Order ID and Shipment ID
get-order-store-data
Get Order Store Data
read-only
idempotent
cancel-order
Cancel Order
estimate-fulfillment-cost-order
Estimate Fulfillment Cost For Order
get-shipment
Get Shipment
read-only
idempotent
get-shipment-logs
Get Shipment Logs
read-only
idempotent
get-shipment-timeline
Get Shipment Timeline
read-only
idempotent
cancel-shipment
Cancel Shipment
get-shipment-line-items
Get Shipment Line Items
read-only
idempotent
update-shipment-address
Update Shipment Address
idempotent
update-shipment-line-items
Update Shipment Line Items
batch-cancel-shipments
Batch Cancel Shipments
mark-tracking-uploaded
Mark Tracking Uploaded
bulk-update-shipping-service
Bulk Update Shipping Service
idempotent
get-shipping-methods
Get Shipping Methods
read-only
idempotent
Capability Spec
naftiko: 1.0.0-alpha2
info:
label: API Reference — subpackage_orders
description: 'API Reference — subpackage_orders. 22 operations. Lead operation: Create Order. Self-contained Naftiko capability
covering one Shipbob business surface.'
tags:
- Shipbob
- subpackage_orders
created: '2026-05-19'
modified: '2026-05-19'
binds:
- namespace: env
keys:
SHIPBOB_API_KEY: SHIPBOB_API_KEY
capability:
consumes:
- type: http
namespace: shipbob-subpackage-orders
baseUri: https://api.shipbob.com
description: API Reference — subpackage_orders business capability. Self-contained, no shared references.
resources:
- name: 2026-01-order
path: /2026-01/order
operations:
- name: createorder
method: POST
description: Create Order
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: Authorization
in: header
type: string
description: Authentication using Personal Access Token (PAT) token or OAuth2
required: true
- name: shipbob_channel_id
in: header
type: string
description: Retrieve your channel ID from the [GET /channel](/api/channels/get-channels) endpoint. Use the channel
ID that has write scopes.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: getorders
method: GET
description: Get Orders
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: Page
in: query
type: integer
description: Page of orders to get
- name: Limit
in: query
type: integer
description: Amount of orders per page to request
- name: IDs
in: query
type: string
description: order ids to filter by, comma separated <br /><strong>Example:</strong> ?IDs=1,2
- name: ReferenceIds
in: query
type: string
description: Reference ids to filter by, comma separated <br /><strong>Example:</strong> ?ReferenceIds=Ref1,Ref2
- name: StartDate
in: query
type: string
description: Start date to filter orders inserted later than
- name: EndDate
in: query
type: string
description: End date to filter orders inserted earlier than
- name: SortOrder
in: query
type: string
description: Order to sort results in
- name: HasTracking
in: query
type: boolean
description: Has any portion of this order been assigned a tracking number
- name: LastUpdateStartDate
in: query
type: string
description: Start date to filter orders updated later than
- name: LastUpdateEndDate
in: query
type: string
description: End date to filter orders updated later than
- name: IsTrackingUploaded
in: query
type: boolean
description: Filter orders that their tracking information was fully uploaded
- name: LastTrackingUpdateStartDate
in: query
type: string
description: Start date to filter orders with tracking updates later than the supplied date. Will only return orders
that have tracking information
- name: LastTrackingUpdateEndDate
in: query
type: string
description: End date to filter orders updated later than the supplied date. Will only return orders that have tracking
information
- name: Authorization
in: header
type: string
description: Authentication using Personal Access Token (PAT) token or OAuth2
required: true
- name: shipbob_channel_id
in: header
type: string
description: Retrieve your channel ID from the [GET /channel](/api/channels/get-channels) endpoint. Use the channel
ID that has write scopes.
- name: 2026-01-order-orderId
path: /2026-01/order/{orderId}
operations:
- name: getorder
method: GET
description: Get Order
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: orderId
in: path
type: string
required: true
- name: Authorization
in: header
type: string
description: Authentication using Personal Access Token (PAT) token or OAuth2
required: true
- name: shipbob_channel_id
in: header
type: string
description: Retrieve your channel ID from the [GET /channel](/api/channels/get-channels) endpoint. Use the channel
ID that has write scopes.
- name: 2026-01-order-orderId-shipment
path: /2026-01/order/{orderId}/shipment
operations:
- name: getallshipmentsfororder
method: GET
description: Get All Shipments for Order
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: orderId
in: path
type: string
description: The order id to get shipments for
required: true
- name: Authorization
in: header
type: string
description: Authentication using Personal Access Token (PAT) token or OAuth2
required: true
- name: shipbob_channel_id
in: header
type: string
description: Retrieve your channel ID from the [GET /channel](/api/channels/get-channels) endpoint. Use the channel
ID that has write scopes.
- name: 2026-01-order-orderId-shipment-shipmentId
path: /2026-01/order/{orderId}/shipment/{shipmentId}
operations:
- name: getshipmentbyorderidandshipmentid
method: GET
description: Get Shipment by Order ID and Shipment ID
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: orderId
in: path
type: string
description: The order id to get the shipment for
required: true
- name: shipmentId
in: path
type: string
description: The shipment id to get
required: true
- name: Authorization
in: header
type: string
description: Authentication using Personal Access Token (PAT) token or OAuth2
required: true
- name: shipbob_channel_id
in: header
type: string
description: Retrieve your channel ID from the [GET /channel](/api/channels/get-channels) endpoint. Use the channel
ID that has write scopes.
- name: 2026-01-order-orderId-shipment-shipmentId-logs
path: /2026-01/order/{orderId}/shipment/{shipmentId}/logs
operations:
- name: getshipmentlogsbyorderidandshipmentid
method: GET
description: Get Shipment Logs by Order ID and Shipment ID
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: orderId
in: path
type: string
description: The order id to get the shipment for
required: true
- name: shipmentId
in: path
type: string
description: The shipment id to get
required: true
- name: Authorization
in: header
type: string
description: Authentication using Personal Access Token (PAT) token or OAuth2
required: true
- name: 2026-01-order-orderId-shipment-shipmentId-timeline
path: /2026-01/order/{orderId}/shipment/{shipmentId}/timeline
operations:
- name: getshipmentstatustimelinebyorderidandshipmentid
method: GET
description: Get Shipment Status Timeline by Order ID and Shipment ID
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: orderId
in: path
type: string
description: The order id to get the shipment for
required: true
- name: shipmentId
in: path
type: string
description: The shipment id to get
required: true
- name: Authorization
in: header
type: string
description: Authentication using Personal Access Token (PAT) token or OAuth2
required: true
- name: shipbob_channel_id
in: header
type: string
description: Retrieve your channel ID from the [GET /channel](/api/channels/get-channels) endpoint. Use the channel
ID that has write scopes.
- name: 2026-01-order-orderId-shipment-shipmentId}:cancel
path: /2026-01/order/{orderId}/shipment/{shipmentId}:cancel
operations:
- name: cancelshipmentbyorderidandshipmentid
method: POST
description: Cancel Shipment by Order ID and Shipment ID
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: shipmentId
in: path
type: string
description: The shipment id to get
required: true
- name: orderId
in: path
type: string
required: true
- name: Authorization
in: header
type: string
description: Authentication using Personal Access Token (PAT) token or OAuth2
required: true
- name: 2026-01-order-orderId-store-order-json
path: /2026-01/order/{orderId}/store-order-json
operations:
- name: getorderstoredata
method: GET
description: Get Order Store Data
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: orderId
in: path
type: string
description: The order ID to Get the JSON Stored
required: true
- name: Authorization
in: header
type: string
description: Authentication using Personal Access Token (PAT) token or OAuth2
required: true
- name: 2026-01-order-orderId}:cancel
path: /2026-01/order/{orderId}:cancel
operations:
- name: cancelorder
method: POST
description: Cancel Order
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: orderId
in: path
type: string
description: The order ID to cancel
required: true
- name: Authorization
in: header
type: string
description: Authentication using Personal Access Token (PAT) token or OAuth2
required: true
- name: 2026-01-order:estimate
path: /2026-01/order:estimate
operations:
- name: estimatefulfillmentcostfororder
method: POST
description: Estimate Fulfillment Cost For Order
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: Authorization
in: header
type: string
description: Authentication using Personal Access Token (PAT) token or OAuth2
required: true
- name: shipbob_channel_id
in: header
type: string
description: Retrieve your channel ID from the [GET /channel](/api/channels/get-channels) endpoint. Use the channel
ID that has write scopes.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: 2026-01-shipment-shipmentId
path: /2026-01/shipment/{shipmentId}
operations:
- name: getshipment
method: GET
description: Get Shipment
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: shipmentId
in: path
type: string
description: The shipment id to get
required: true
- name: Authorization
in: header
type: string
description: Authentication using Personal Access Token (PAT) token or OAuth2
required: true
- name: shipbob_channel_id
in: header
type: string
description: Retrieve your channel ID from the [GET /channel](/api/channels/get-channels) endpoint. Use the channel
ID that has write scopes.
- name: 2026-01-shipment-shipmentId-logs
path: /2026-01/shipment/{shipmentId}/logs
operations:
- name: getshipmentlogs
method: GET
description: Get Shipment Logs
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: shipmentId
in: path
type: string
description: The shipment id to get
required: true
- name: Authorization
in: header
type: string
description: Authentication using Personal Access Token (PAT) token or OAuth2
required: true
- name: shipbob_channel_id
in: header
type: string
description: Retrieve your channel ID from the [GET /channel](/api/channels/get-channels) endpoint. Use the channel
ID that has write scopes.
- name: 2026-01-shipment-shipmentId-timeline
path: /2026-01/shipment/{shipmentId}/timeline
operations:
- name: getshipmenttimeline
method: GET
description: Get Shipment Timeline
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: shipmentId
in: path
type: string
description: The shipment id to get
required: true
- name: Authorization
in: header
type: string
description: Authentication using Personal Access Token (PAT) token or OAuth2
required: true
- name: shipbob_channel_id
in: header
type: string
description: Retrieve your channel ID from the [GET /channel](/api/channels/get-channels) endpoint. Use the channel
ID that has write scopes.
- name: 2026-01-shipment-shipmentId}:cancel
path: /2026-01/shipment/{shipmentId}:cancel
operations:
- name: cancelshipment
method: POST
description: Cancel Shipment
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: shipmentId
in: path
type: string
description: The shipment id to get
required: true
- name: Authorization
in: header
type: string
description: Authentication using Personal Access Token (PAT) token or OAuth2
required: true
- name: 2026-01-shipment-shipmentId}:getLineItems
path: /2026-01/shipment/{shipmentId}:getLineItems
operations:
- name: getshipmentlineitems
method: GET
description: Get Shipment Line Items
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: shipmentId
in: path
type: integer
description: Unique identifier of the shipment
required: true
- name: Authorization
in: header
type: string
description: Authentication using Personal Access Token (PAT) token or OAuth2
required: true
- name: 2026-01-shipment-shipmentId}:updateAddress
path: /2026-01/shipment/{shipmentId}:updateAddress
operations:
- name: updateshipmentaddress
method: PUT
description: Update Shipment Address
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: shipmentId
in: path
type: integer
description: Unique identifier of the shipment
required: true
- name: Authorization
in: header
type: string
description: Authentication using Personal Access Token (PAT) token or OAuth2
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: 2026-01-shipment-shipmentId}:updateLineItems
path: /2026-01/shipment/{shipmentId}:updateLineItems
operations:
- name: updateshipmentlineitems
method: POST
description: Update Shipment Line Items
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: shipmentId
in: path
type: integer
description: Unique identifier of the shipment
required: true
- name: Authorization
in: header
type: string
description: Authentication using Personal Access Token (PAT) token or OAuth2
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: 2026-01-shipment:batchCancel
path: /2026-01/shipment:batchCancel
operations:
- name: batchcancelshipments
method: POST
description: Batch Cancel Shipments
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: Authorization
in: header
type: string
description: Authentication using Personal Access Token (PAT) token or OAuth2
required: true
- name: shipbob_channel_id
in: header
type: string
description: Retrieve your channel ID from the [GET /channel](/api/channels/get-channels) endpoint. Use the channel
ID that has write scopes.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: 2026-01-shipment:batchUpdateTrackingUpload
path: /2026-01/shipment:batchUpdateTrackingUpload
operations:
- name: marktrackinguploaded
method: POST
description: Mark Tracking Uploaded
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: Authorization
in: header
type: string
description: Authentication using Personal Access Token (PAT) token or OAuth2
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: 2026-01-shipment:bulkUpdateShippingService
path: /2026-01/shipment:bulkUpdateShippingService
operations:
- name: bulkupdateshippingservice
method: PUT
description: Bulk Update Shipping Service
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: Authorization
in: header
type: string
description: Authentication using Personal Access Token (PAT) token or OAuth2
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: 2026-01-shipping-method
path: /2026-01/shipping-method
operations:
- name: getshippingmethods
method: GET
description: Get Shipping Methods
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: Page
in: query
type: integer
description: Page of orders to get
- name: Limit
in: query
type: integer
description: Amount of records per page to request
- name: Authorization
in: header
type: string
description: Authentication using Personal Access Token (PAT) token or OAuth2
required: true
authentication:
type: bearer
token: '{{env.SHIPBOB_API_KEY}}'
exposes:
- type: rest
namespace: shipbob-subpackage-orders-rest
port: 8080
description: REST adapter for API Reference — subpackage_orders. One Spectral-compliant resource per consumed operation,
prefixed with /v1.
resources:
- path: /v1/2026-01/order
name: 2026-01-order
description: REST surface for 2026-01-order.
operations:
- method: POST
name: createorder
description: Create Order
call: shipbob-subpackage-orders.createorder
with:
Authorization: rest.Authorization
shipbob_channel_id: rest.shipbob_channel_id
body: rest.body
outputParameters:
- type: object
mapping: $.
- method: GET
name: getorders
description: Get Orders
call: shipbob-subpackage-orders.getorders
with:
Page: rest.Page
Limit: rest.Limit
IDs: rest.IDs
ReferenceIds: rest.ReferenceIds
StartDate: rest.StartDate
EndDate: rest.EndDate
SortOrder: rest.SortOrder
HasTracking: rest.HasTracking
LastUpdateStartDate: rest.LastUpdateStartDate
LastUpdateEndDate: rest.LastUpdateEndDate
IsTrackingUploaded: rest.IsTrackingUploaded
LastTrackingUpdateStartDate: rest.LastTrackingUpdateStartDate
LastTrackingUpdateEndDate: rest.LastTrackingUpdateEndDate
Authorization: rest.Authorization
shipbob_channel_id: rest.shipbob_channel_id
outputParameters:
- type: object
mapping: $.
- path: /v1/2026-01/order/{orderid}
name: 2026-01-order-orderid
description: REST surface for 2026-01-order-orderId.
operations:
- method: GET
name: getorder
description: Get Order
call: shipbob-subpackage-orders.getorder
with:
orderId: rest.orderId
Authorization: rest.Authorization
shipbob_channel_id: rest.shipbob_channel_id
outputParameters:
- type: object
mapping: $.
- path: /v1/2026-01/order/{orderid}/shipment
name: 2026-01-order-orderid-shipment
description: REST surface for 2026-01-order-orderId-shipment.
operations:
- method: GET
name: getallshipmentsfororder
description: Get All Shipments for Order
call: shipbob-subpackage-orders.getallshipmentsfororder
with:
orderId: rest.orderId
Authorization: rest.Authorization
shipbob_channel_id: rest.shipbob_channel_id
outputParameters:
- type: object
mapping: $.
- path: /v1/2026-01/order/{orderid}/shipment/{shipmentid}
name: 2026-01-order-orderid-shipment-shipmentid
description: REST surface for 2026-01-order-orderId-shipment-shipmentId.
operations:
- method: GET
name: getshipmentbyorderidandshipmentid
description: Get Shipment by Order ID and Shipment ID
call: shipbob-subpackage-orders.getshipmentbyorderidandshipmentid
with:
orderId: rest.orderId
shipmentId: rest.shipmentId
Authorization: rest.Authorization
shipbob_channel_id: rest.shipbob_channel_id
outputParameters:
- type: object
mapping: $.
- path: /v1/2026-01/order/{orderid}/shipment/{shipmentid}/logs
name: 2026-01-order-orderid-shipment-shipmentid-logs
description: REST surface for 2026-01-order-orderId-shipment-shipmentId-logs.
operations:
- method: GET
name: getshipmentlogsbyorderidandshipmentid
description: Get Shipment Logs by Order ID and Shipment ID
call: shipbob-subpackage-orders.getshipmentlogsbyorderidandshipmentid
with:
orderId: rest.orderId
shipmentId: rest.shipmentId
Authorization: rest.Authorization
outputParameters:
- type: object
mapping: $.
- path: /v1/2026-01/order/{orderid}/shipment/{shipmentid}/timeline
name: 2026-01-order-orderid-shipment-shipmentid-timeline
description: REST surface for 2026-01-order-orderId-shipment-shipmentId-timeline.
operations:
- method: GET
name: getshipmentstatustimelinebyorderidandshipmentid
description: Get Shipment Status Timeline by Order ID and Shipment ID
call: shipbob-subpackage-orders.getshipmentstatustimelinebyorderidandshipmentid
with:
orderId: rest.orderId
shipmentId: rest.shipmentId
Authorization: rest.Authorization
shipbob_channel_id: rest.shipbob_channel_id
outputParameters:
- type: object
mapping: $.
- path: /v1/2026-01/order/{orderid}/shipment/shipmentid-cancel
name: 2026-01-order-orderid-shipment-shipmentid-cancel
description: REST surface for 2026-01-order-orderId-shipment-shipmentId}:cancel.
operations:
- method: POST
name: cancelshipmentbyorderidandshipmentid
description: Cancel Shipment by Order ID and Shipment ID
call: shipbob-subpackage-orders.cancelshipmentbyorderidandshipmentid
with:
shipmentId: rest.shipmentId
orderId: rest.orderId
Authorization: rest.Authorization
outputParameters:
- type: object
mapping: $.
- path: /v1/2026-01/order/{orderid}/store-order-json
name: 2026-01-order-orderid-store-order-json
description: REST surface for 2026-01-order-orderId-store-order-json.
operations:
- method: GET
name: getorderstoredata
description: Get Order Store Data
call: shipbob-subpackage-orders.getorderstoredata
with:
orderId: rest.orderId
Authorization: rest.Authorization
outputParameters:
- type: object
mapping: $.
- path: /v1/2026-01/order/orderid-cancel
name: 2026-01-order-orderid-cancel
description: REST surface for 2026-01-order-orderId}:cancel.
operations:
- method: POST
name: cancelorder
description: Cancel Order
call: shipbob-subpackage-orders.cancelorder
with:
orderId: rest.orderId
Authorization: rest.Authorization
outputParameters:
- type: object
mapping: $.
- path: /v1/2026-01/order-estimate
name: 2026-01-order-estimate
description: REST surface for 2026-01-order:estimate.
operations:
- method: POST
name: estimatefulfillmentcostfororder
description: Estimate Fulfillment Cost For Order
call: shipbob-subpackage-orders.estimatefulfillmentcostfororder
with:
Authorization: rest.Authorization
shipbob_channel_id: rest.shipbob_channel_id
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/2026-01/shipment/{shipmentid}
name: 2026-01-shipment-shipmentid
description: REST surface for 2026-01-shipment-shipmentId.
operations:
- method: GET
name: getshipment
description: Get Shipment
call: shipbob-subpackage-orders.getshipment
with:
shipmentId: rest.shipmentId
Authorization: rest.Authorization
shipbob_channel_id: rest.shipbob_channel_id
outputParameters:
- type: object
mapping: $.
- path: /v1/2026-01/shipment/{shipmentid}/logs
name: 2026-01-shipment-shipmentid-logs
description: REST surface for 2026-01-shipment-shipmentId-logs.
operations:
- method: GET
name: getshipmentlogs
description: Get Shipment Logs
call: shipbob-subpackage-orders.getshipmentlogs
with:
shipmentId: rest.shipmentId
Authorization: rest.Authorization
shipbob_channel_id: rest.shipbob_channel_id
outputParameters:
- type: object
mapping: $.
- path: /v1/2026-01/shipment/{shipmentid}/timeline
name: 2026-01-shipment-shipmentid-timeline
description: REST surface for 2026-01-shipment-shipmentId-timeline.
operations:
- method: GET
name: getshipmenttimeline
description: Get Shipment Timeline
call: shipbob-subpackage-orders.getshipmenttimeline
with:
shipmentId: rest.shipmentId
Authorization: rest.Authorization
shipbob_channel_id: rest.shipbob_channel_id
outputParameters:
- type: object
mapping: $.
- path: /v1/2026-01/shipment/shipmentid-cancel
name: 2026-01-shipment-shipmentid-cancel
description: REST surface for 2026-01-shipment-shipmentId}:cancel.
operations:
- method: POST
name: cancelshipment
description: Cancel Shipment
call: shipbob-subpackage-orders.cancelshipment
with:
shipmentId: rest.shipmentId
Authorization: rest.Authorization
outputParameters:
- type: object
mapping: $.
- path: /v1/2026-01/shipment/shipmentid-getlineitems
name: 2026-01-shipment-shipmentid-getlineitems
description: REST surface for 2026-01-shipment-shipmentId}:getLineItems.
operations:
- method: GET
name: getshipmentlineitems
description: Get Shipment Line Items
call: shipbob-subpackage-orders.getshipmentlineitems
with:
shipmentId: rest.shipmentId
Authorization: rest.Authorization
outputParameters:
- type: object
mapping: $.
- path: /v1/2026-01/shipment/shipmentid-updateaddress
name: 2026-01-shipment-shipmentid-updateaddress
description: REST surface for 2026-01-shipment-shipmentId}:updateAddress.
operations:
- method: PUT
name: updateshipmentaddress
description: Update Shipment Address
call: shipbob-subpackage-orders.updateshipmentaddress
with:
shipmentId: rest.shipmentId
Authorization: rest.Authorization
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/2026-01/shipment/shipmentid-updatelineitems
name: 2026-01-shipment-shipmentid-updatelineitems
description: REST surface for 2026-01-shipment-shipmentId}:updateLineItems.
operations:
- method: POST
name: updateshipmentlineitems
description: Update Shipment Line Items
call: shipbob-subpackage-orders.updateshipmentlineitems
with:
shipmentId: rest.shipmentId
Authorization: rest.Authorization
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/2026-01/shipment-batchcancel
name: 2026-01-shipment-batchcancel
description: REST surface for 2026-01-shipment:batchCancel.
operations:
- method: POST
name: batchcancelshipments
description: Batch Cancel Shipments
call: shipbob-subpackage-orders.batchcancelshipments
with:
Authorization: rest.Authorization
shipbob_channel_id: rest.shipbob_channel_id
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/2026-01/shipment-batchupdatetrackingupload
# --- truncated at 32 KB (43 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/shipbob/refs/heads/main/capabilities/shipbob-subpackage-orders.yaml