Toys R Us Commerce API — Shipments

naftiko: 1.0.0-alpha2
info:
  label: Toys R Us Commerce API — Shipments
  description: 'Toys R Us Commerce API — Shipments. 2 operations. Lead operation: Get Shipments. Self-contained Naftiko capability
    covering one Toys R Us business surface.'
  tags:
  - Toys R Us
  - Shipments
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TOYS_R_US_API_KEY: TOYS_R_US_API_KEY
capability:
  consumes:
  - type: http
    namespace: commerce-shipments
    baseUri: https://commerceapi.io
    description: Toys R Us Commerce API — Shipments business capability. Self-contained, no shared references.
    resources:
    - name: api-v2-shipments
      path: /api/v2/shipments
      operations:
      - name: getshipments
        method: GET
        description: Get Shipments
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: status
          in: query
          type: integer
          description: Filter shipments by status code.
        - name: page
          in: query
          type: integer
          description: Page number for paginated results.
    - name: api-v2-shipments-import
      path: /api/v2/shipments/import
      operations:
      - name: createshipment
        method: POST
        description: Create Shipment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: subscription-key
      value: '{{env.TOYS_R_US_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: commerce-shipments-rest
    port: 8080
    description: REST adapter for Toys R Us Commerce API — Shipments. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/v2/shipments
      name: api-v2-shipments
      description: REST surface for api-v2-shipments.
      operations:
      - method: GET
        name: getshipments
        description: Get Shipments
        call: commerce-shipments.getshipments
        with:
          status: rest.status
          page: rest.page
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v2/shipments/import
      name: api-v2-shipments-import
      description: REST surface for api-v2-shipments-import.
      operations:
      - method: POST
        name: createshipment
        description: Create Shipment
        call: commerce-shipments.createshipment
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: commerce-shipments-mcp
    port: 9090
    transport: http
    description: MCP adapter for Toys R Us Commerce API — Shipments. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: get-shipments
      description: Get Shipments
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: commerce-shipments.getshipments
      with:
        status: tools.status
        page: tools.page
      outputParameters:
      - type: object
        mapping: $.
    - name: create-shipment
      description: Create Shipment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: commerce-shipments.createshipment
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.