API Reference — subpackage_receiving

naftiko: 1.0.0-alpha2
info:
  label: API Reference — subpackage_receiving
  description: 'API Reference — subpackage_receiving. 9 operations. Lead operation: Get Fulfillment Centers. Self-contained
    Naftiko capability covering one Shipbob business surface.'
  tags:
  - Shipbob
  - subpackage_receiving
  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-receiving
    baseUri: https://api.shipbob.com
    description: API Reference — subpackage_receiving business capability. Self-contained, no shared references.
    resources:
    - name: 2026-01-fulfillment-center
      path: /2026-01/fulfillment-center
      operations:
      - name: getfulfillmentcenters
        method: GET
        description: Get Fulfillment Centers
        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: 2026-01-receiving
      path: /2026-01/receiving
      operations:
      - name: createwarehousereceivingorder
        method: POST
        description: Create Warehouse Receiving 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: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: getmultiplewarehousereceivingorders
        method: GET
        description: Get Multiple Warehouse Receiving Orders
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Page
          in: query
          type: string
          description: Page of WROs to get
        - name: Limit
          in: query
          type: string
          description: Number of WROs per page to request
        - name: IDs
          in: query
          type: string
          description: Comma separated list of WRO IDs to filter by
        - name: Statuses
          in: query
          type: string
          description: Comma separated list of WRO statuses to filter by
        - name: InsertStartDate
          in: query
          type: string
          description: Earliest date that a WRO was created
        - name: InsertEndDate
          in: query
          type: string
          description: Latest date that a WRO was created
        - name: FulfillmentCenterIds
          in: query
          type: string
          description: Comma separated list of WRO fulfillment center IDs to filter by
        - name: PurchaseOrderNumbers
          in: query
          type: string
          description: Comma separated list of WRO PO numbers to filter by
        - name: ExternalSync
          in: query
          type: boolean
          description: Flag to return external_sync_timestamp WROs
        - name: CompletedStartDate
          in: query
          type: string
          description: Earliest date that a WRO was completed
        - name: CompletedEndDate
          in: query
          type: string
          description: Latest date that a WRO was completed
        - name: Authorization
          in: header
          type: string
          description: Authentication using Personal Access Token (PAT) token or OAuth2
          required: true
    - name: 2026-01-receiving-id
      path: /2026-01/receiving/{id}
      operations:
      - name: getwarehousereceivingorder
        method: GET
        description: Get Warehouse Receiving Order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Id of the receiving order
          required: true
        - name: Authorization
          in: header
          type: string
          description: Authentication using Personal Access Token (PAT) token or OAuth2
          required: true
    - name: 2026-01-receiving-id-boxes
      path: /2026-01/receiving/{id}/boxes
      operations:
      - name: getwarehousereceivingorderboxes
        method: GET
        description: Get Warehouse Receiving Order Boxes
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Id of the receiving order
          required: true
        - name: Authorization
          in: header
          type: string
          description: Authentication using Personal Access Token (PAT) token or OAuth2
          required: true
    - name: 2026-01-receiving-id-distributions
      path: /2026-01/receiving/{id}/distributions
      operations:
      - name: getinventorydistributionsbywroid
        method: GET
        description: Get Inventory Distributions by WRO ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Id of the receiving order
          required: true
        - name: Authorization
          in: header
          type: string
          description: Authentication using Personal Access Token (PAT) token or OAuth2
          required: true
    - name: 2026-01-receiving-id-labels
      path: /2026-01/receiving/{id}/labels
      operations:
      - name: getwarehousereceivingorderboxlabels
        method: GET
        description: Get Warehouse Receiving Order Box Labels
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Id of the receiving order
          required: true
        - name: Authorization
          in: header
          type: string
          description: Authentication using Personal Access Token (PAT) token or OAuth2
          required: true
    - name: 2026-01-receiving-id}:cancel
      path: /2026-01/receiving/{id}:cancel
      operations:
      - name: cancelwarehousereceivingorder
        method: POST
        description: Cancel Warehouse Receiving Order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Id of the receiving order 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-receiving:setExternalSync
      path: /2026-01/receiving:setExternalSync
      operations:
      - name: setexternalsyncflagforwros
        method: POST
        description: Set ExternalSync flag for Wros
        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
    authentication:
      type: bearer
      token: '{{env.SHIPBOB_API_KEY}}'
  exposes:
  - type: rest
    namespace: shipbob-subpackage-receiving-rest
    port: 8080
    description: REST adapter for API Reference — subpackage_receiving. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/2026-01/fulfillment-center
      name: 2026-01-fulfillment-center
      description: REST surface for 2026-01-fulfillment-center.
      operations:
      - method: GET
        name: getfulfillmentcenters
        description: Get Fulfillment Centers
        call: shipbob-subpackage-receiving.getfulfillmentcenters
        with:
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/2026-01/receiving
      name: 2026-01-receiving
      description: REST surface for 2026-01-receiving.
      operations:
      - method: POST
        name: createwarehousereceivingorder
        description: Create Warehouse Receiving Order
        call: shipbob-subpackage-receiving.createwarehousereceivingorder
        with:
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getmultiplewarehousereceivingorders
        description: Get Multiple Warehouse Receiving Orders
        call: shipbob-subpackage-receiving.getmultiplewarehousereceivingorders
        with:
          Page: rest.Page
          Limit: rest.Limit
          IDs: rest.IDs
          Statuses: rest.Statuses
          InsertStartDate: rest.InsertStartDate
          InsertEndDate: rest.InsertEndDate
          FulfillmentCenterIds: rest.FulfillmentCenterIds
          PurchaseOrderNumbers: rest.PurchaseOrderNumbers
          ExternalSync: rest.ExternalSync
          CompletedStartDate: rest.CompletedStartDate
          CompletedEndDate: rest.CompletedEndDate
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/2026-01/receiving/{id}
      name: 2026-01-receiving-id
      description: REST surface for 2026-01-receiving-id.
      operations:
      - method: GET
        name: getwarehousereceivingorder
        description: Get Warehouse Receiving Order
        call: shipbob-subpackage-receiving.getwarehousereceivingorder
        with:
          id: rest.id
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/2026-01/receiving/{id}/boxes
      name: 2026-01-receiving-id-boxes
      description: REST surface for 2026-01-receiving-id-boxes.
      operations:
      - method: GET
        name: getwarehousereceivingorderboxes
        description: Get Warehouse Receiving Order Boxes
        call: shipbob-subpackage-receiving.getwarehousereceivingorderboxes
        with:
          id: rest.id
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/2026-01/receiving/{id}/distributions
      name: 2026-01-receiving-id-distributions
      description: REST surface for 2026-01-receiving-id-distributions.
      operations:
      - method: GET
        name: getinventorydistributionsbywroid
        description: Get Inventory Distributions by WRO ID
        call: shipbob-subpackage-receiving.getinventorydistributionsbywroid
        with:
          id: rest.id
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/2026-01/receiving/{id}/labels
      name: 2026-01-receiving-id-labels
      description: REST surface for 2026-01-receiving-id-labels.
      operations:
      - method: GET
        name: getwarehousereceivingorderboxlabels
        description: Get Warehouse Receiving Order Box Labels
        call: shipbob-subpackage-receiving.getwarehousereceivingorderboxlabels
        with:
          id: rest.id
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/2026-01/receiving/id-cancel
      name: 2026-01-receiving-id-cancel
      description: REST surface for 2026-01-receiving-id}:cancel.
      operations:
      - method: POST
        name: cancelwarehousereceivingorder
        description: Cancel Warehouse Receiving Order
        call: shipbob-subpackage-receiving.cancelwarehousereceivingorder
        with:
          id: rest.id
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/2026-01/receiving-setexternalsync
      name: 2026-01-receiving-setexternalsync
      description: REST surface for 2026-01-receiving:setExternalSync.
      operations:
      - method: POST
        name: setexternalsyncflagforwros
        description: Set ExternalSync flag for Wros
        call: shipbob-subpackage-receiving.setexternalsyncflagforwros
        with:
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: shipbob-subpackage-receiving-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — subpackage_receiving. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: get-fulfillment-centers
      description: Get Fulfillment Centers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shipbob-subpackage-receiving.getfulfillmentcenters
      with:
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: create-warehouse-receiving-order
      description: Create Warehouse Receiving Order
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: shipbob-subpackage-receiving.createwarehousereceivingorder
      with:
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-multiple-warehouse-receiving-orders
      description: Get Multiple Warehouse Receiving Orders
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shipbob-subpackage-receiving.getmultiplewarehousereceivingorders
      with:
        Page: tools.Page
        Limit: tools.Limit
        IDs: tools.IDs
        Statuses: tools.Statuses
        InsertStartDate: tools.InsertStartDate
        InsertEndDate: tools.InsertEndDate
        FulfillmentCenterIds: tools.FulfillmentCenterIds
        PurchaseOrderNumbers: tools.PurchaseOrderNumbers
        ExternalSync: tools.ExternalSync
        CompletedStartDate: tools.CompletedStartDate
        CompletedEndDate: tools.CompletedEndDate
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: get-warehouse-receiving-order
      description: Get Warehouse Receiving Order
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shipbob-subpackage-receiving.getwarehousereceivingorder
      with:
        id: tools.id
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: get-warehouse-receiving-order-boxes
      description: Get Warehouse Receiving Order Boxes
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shipbob-subpackage-receiving.getwarehousereceivingorderboxes
      with:
        id: tools.id
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: get-inventory-distributions-wro-id
      description: Get Inventory Distributions by WRO ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shipbob-subpackage-receiving.getinventorydistributionsbywroid
      with:
        id: tools.id
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: get-warehouse-receiving-order-box
      description: Get Warehouse Receiving Order Box Labels
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shipbob-subpackage-receiving.getwarehousereceivingorderboxlabels
      with:
        id: tools.id
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: cancel-warehouse-receiving-order
      description: Cancel Warehouse Receiving Order
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: shipbob-subpackage-receiving.cancelwarehousereceivingorder
      with:
        id: tools.id
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: set-externalsync-flag-wros
      description: Set ExternalSync flag for Wros
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: shipbob-subpackage-receiving.setexternalsyncflagforwros
      with:
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.