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
      name: 2026-01-shipment-batchupdatetrackingupload
      description: REST surface for 2026-01-shipment:batchUpdateTrackingUpload.
      operations:
      - method: POST
        name: marktrackinguploaded
        description: Mark Tracking Uploaded
        call: shipbob-subpackage-orders.marktrackinguploaded
        with:
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/2026-01/shipment-bulkupdateshippingservice
      name: 2026-01-shipment-bulkupdateshippingservice
      description: REST surface for 2026-01-shipment:bulkUpdateShippingService.
      operations:
      - method: PUT
        name: bulkupdateshippingservice
        description: Bulk Update Shipping Service
        call: shipbob-subpackage-orders.bulkupdateshippingservice
        with:
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/2026-01/shipping-method
      name: 2026-01-shipping-method
      description: REST surface for 2026-01-shipping-method.
      operations:
      - method: GET
        name: getshippingmethods
        description: Get Shipping Methods
        call: shipbob-subpackage-orders.getshippingmethods
        with:
          Page: rest.Page
          Limit: rest.Limit
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: shipbob-subpackage-orders-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — subpackage_orders. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: create-order
      description: Create Order
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: shipbob-subpackage-orders.createorder
      with:
        Authorization: tools.Authorization
        shipbob_channel_id: tools.shipbob_channel_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-orders
      description: Get Orders
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shipbob-subpackage-orders.getorders
      with:
        Page: tools.Page
        Limit: tools.Limit
        IDs: tools.IDs
        ReferenceIds: tools.ReferenceIds
        StartDate: tools.StartDate
        EndDate: tools.EndDate
        SortOrder: tools.SortOrder
        HasTracking: tools.HasTracking
        LastUpdateStartDate: tools.LastUpdateStartDate
        LastUpdateEndDate: tools.LastUpdateEndDate
        IsTrackingUploaded: tools.IsTrackingUploaded
        LastTrackingUpdateStartDate: tools.LastTrackingUpdateStartDate
        LastTrackingUpdateEndDate: tools.LastTrackingUpdateEndDate
        Authorization: tools.Authorization
        shipbob_channel_id: tools.shipbob_channel_id
      outputParameters:
      - type: object
        mapping: $.
    - name: get-order
      description: Get Order
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shipbob-subpackage-orders.getorder
      with:
        orderId: tools.orderId
        Authorization: tools.Authorization
        shipbob_channel_id: tools.shipbob_channel_id
      outputParameters:
      - type: object
        mapping: $.
    - name: get-all-shipments-order
      description: Get All Shipments for Order
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shipbob-subpackage-orders.getallshipmentsfororder
      with:
        orderId: tools.orderId
        Authorization: tools.Authorization
        shipbob_channel_id: tools.shipbob_channel_id
      outputParameters:
      - type: object
        mapping: $.
    - name: get-shipment-order-id-and
      description: Get Shipment by Order ID and Shipment ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shipbob-subpackage-orders.getshipmentbyorderidandshipmentid
      with:
        orderId: tools.orderId
        shipmentId: tools.shipmentId
        Authorization: tools.Authorization
        shipbob_channel_id: tools.shipbob_channel_id
      outputParameters:
      - type: object
        mapping: $.
    - name: get-shipment-logs-order-id
      description: Get Shipment Logs by Order ID and Shipment ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shipbob-subpackage-orders.getshipmentlogsbyorderidandshipmentid
      with:
        orderId: tools.orderId
        shipmentId: tools.shipmentId
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: get-shipment-status-timeline-order
      description: Get Shipment Status Timeline by Order ID and Shipment ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shipbob-subpackage-orders.getshipmentstatustimelinebyorderidandshipmentid
      with:
        orderId: tools.orderId
        shipmentId: tools.shipmentId
        Authorization: tools.Authorization
        shipbob_channel_id: tools.shipbob_channel_id
      outputParameters:
      - type: object
        mapping: $.
    - name: cancel-shipment-order-id-and
      description: Cancel Shipment by Order ID and Shipment ID
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: shipbob-subpackage-orders.cancelshipmentbyorderidandshipmentid
      with:
        shipmentId: tools.shipmentId
        orderId: tools.orderId
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: get-order-store-data
      description: Get Order Store Data
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shipbob-subpackage-orders.getorderstoredata
      with:
        orderId: tools.orderId
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: cancel-order
      description: Cancel Order
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: shipbob-subpackage-orders.cancelorder
      with:
        orderId: tools.orderId
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: estimate-fulfillment-cost-order
      description: Estimate Fulfillment Cost For Order
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: shipbob-subpackage-orders.estimatefulfillmentcostfororder
      with:
        Authorization: tools.Authorization
        shipbob_channel_id: tools.shipbob_channel_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-shipment
      description: Get Shipment
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shipbob-subpackage-orders.getshipment
      with:
        shipmentId: tools.shipmentId
        Authorization: tools.Authorization
        shipbob_channel_id: tools.shipbob_channel_id
      outputParameters:
      - type: object
        mapping: $.
    - name: get-shipment-logs
      description: Get Shipment Logs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shipbob-subpackage-orders.getshipmentlogs
      with:
        shipmentId: tools.shipmentId
        Authorization: tools.Authorization
        shipbob_channel_id: tools.shipbob_channel_id
      outputParameters:
      - type: object
        mapping: $.
    - name: get-shipment-timeline
      description: Get Shipment Timeline
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shipbob-subpackage-orders.getshipmenttimeline
      with:
        shipmentId: tools.shipmentId
        Authorization: tools.Authorization
        shipbob_channel_id: tools.shipbob_channel_id
      outputParameters:
      - type: object
        mapping: $.
    - name: cancel-shipment
      description: Cancel Shipment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: shipbob-subpackage-orders.cancelshipment
      with:
        shipmentId: tools.shipmentId
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: get-shipment-line-items
      description: Get Shipment Line Items
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shipbob-subpackage-orders.getshipmentlineitems
      with:
        shipmentId: tools.shipmentId
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: update-shipment-address
      description: Update Shipment Address
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: shipbob-subpackage-orders.updateshipmentaddress
      with:
        shipmentId: tools.shipmentId
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: update-shipment-line-items
      description: Update Shipment Line Items
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: shipbob-subpackage-orders.updateshipmentlineitems
      with:
        shipmentId: tools.shipmentId
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: batch-cancel-shipments
      description: Batch Cancel Shipments
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: shipbob-subpackage-orders.batchcancelshipments
      with:
        Authorization: tools.Authorization
        shipbob_channel_id: tools.shipbob_channel_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: mark-tracking-uploaded
      description: Mark Tracking Uploaded
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: shipbob-subpackage-orders.marktrackinguploaded
      with:
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: bulk-update-shipping-service
      description: Bulk Update Shipping Service
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: shipbob-subpackage-orders.bulkupdateshippingservice
      with:
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-shipping-methods
      description: Get Shipping Methods
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shipbob-subpackage-orders.getshippingmethods
      with:
        Page: tools.Page
        Limit: tools.Limit
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.