Walmart Ship With Walmart — Ship with Walmart

naftiko: 1.0.0-alpha2
info:
  label: Walmart Ship With Walmart — Ship with Walmart
  description: 'Walmart Ship With Walmart — Ship with Walmart. 8 operations. Lead operation: Walmart Create Label. Self-contained
    Naftiko capability covering one Walmart business surface.'
  tags:
  - Walmart
  - Ship with Walmart
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WALMART_API_KEY: WALMART_API_KEY
capability:
  consumes:
  - type: http
    namespace: marketplace-shipping-ship-with-walmart
    baseUri: https://marketplace.walmartapis.com
    description: Walmart Ship With Walmart — Ship with Walmart business capability. Self-contained, no shared references.
    resources:
    - name: v3-shipping-labels
      path: /v3/shipping/labels
      operations:
      - name: createlabel
        method: POST
        description: Walmart Create Label
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: WM_SEC.ACCESS_TOKEN
          in: header
          type: string
          description: The access token retrieved in the Token API call
          required: true
        - name: WM_CONSUMER.CHANNEL.TYPE
          in: header
          type: string
          description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during
            onboarding
        - name: WM_QOS.CORRELATION_ID
          in: header
          type: string
          description: A unique ID which identifies each API call and used to track and debug issues; use a random generated
            GUID for this ID
          required: true
        - name: WM_SVC.NAME
          in: header
          type: string
          description: Walmart Service Name
          required: true
        - name: Accept
          in: header
          type: string
          description: 'Only supported Media Type : application/json'
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v3-shipping-labels-carriers
      path: /v3/shipping/labels/carriers
      operations:
      - name: getcarriers
        method: GET
        description: Walmart Supported Carriers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: WM_SEC.ACCESS_TOKEN
          in: header
          type: string
          description: The access token retrieved in the Token API call
          required: true
        - name: WM_CONSUMER.CHANNEL.TYPE
          in: header
          type: string
          description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during
            onboarding
        - name: WM_QOS.CORRELATION_ID
          in: header
          type: string
          description: A unique ID which identifies each API call and used to track and debug issues; use a random generated
            GUID for this ID
          required: true
        - name: WM_SVC.NAME
          in: header
          type: string
          description: Walmart Service Name
          required: true
        - name: Accept
          in: header
          type: string
          description: 'Only supported Media Type : application/json'
          required: true
    - name: v3-shipping-labels-carriers-carrierShortName-package-types
      path: /v3/shipping/labels/carriers/{carrierShortName}/package-types
      operations:
      - name: getcarrierpackagetypes
        method: GET
        description: Walmart Supported Carrier Package Types
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: carrierShortName
          in: path
          type: string
          description: carrierShortName fetched from carrier API response or pass 'ALL' to fetch all package types of supported
            carriers
          required: true
        - name: WM_SEC.ACCESS_TOKEN
          in: header
          type: string
          description: The access token retrieved in the Token API call
          required: true
        - name: WM_CONSUMER.CHANNEL.TYPE
          in: header
          type: string
          description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during
            onboarding
        - name: WM_QOS.CORRELATION_ID
          in: header
          type: string
          description: A unique ID which identifies each API call and used to track and debug issues; use a random generated
            GUID for this ID
          required: true
        - name: WM_SVC.NAME
          in: header
          type: string
          description: Walmart Service Name
          required: true
        - name: Accept
          in: header
          type: string
          description: 'Only supported Media Type : application/json'
          required: true
    - name: v3-shipping-labels-carriers-carrierShortName-trackings-trackingNo
      path: /v3/shipping/labels/carriers/{carrierShortName}/trackings/{trackingNo}
      operations:
      - name: getlabelbytrackingandcarrier
        method: GET
        description: Walmart Download Label
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: carrierShortName
          in: path
          type: string
          description: carrierShortName
          required: true
        - name: trackingNo
          in: path
          type: string
          description: trackingNo
          required: true
        - name: WM_SEC.ACCESS_TOKEN
          in: header
          type: string
          description: The access token retrieved in the Token API call
          required: true
        - name: WM_CONSUMER.CHANNEL.TYPE
          in: header
          type: string
          description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during
            onboarding
        - name: WM_QOS.CORRELATION_ID
          in: header
          type: string
          description: A unique ID which identifies each API call and used to track and debug issues; use a random generated
            GUID for this ID
          required: true
        - name: WM_SVC.NAME
          in: header
          type: string
          description: Walmart Service Name
          required: true
        - name: Accept
          in: header
          type: string
          description: 'Only supported Media Type : application/json'
          required: true
      - name: discardlabel
        method: DELETE
        description: Walmart Discard Label
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: carrierShortName
          in: path
          type: string
          description: carrierShortName from getCarriers API
          required: true
        - name: trackingNo
          in: path
          type: string
          description: trackingNo
          required: true
        - name: WM_SEC.ACCESS_TOKEN
          in: header
          type: string
          description: The access token retrieved in the Token API call
          required: true
        - name: WM_CONSUMER.CHANNEL.TYPE
          in: header
          type: string
          description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during
            onboarding
        - name: WM_QOS.CORRELATION_ID
          in: header
          type: string
          description: A unique ID which identifies each API call and used to track and debug issues; use a random generated
            GUID for this ID
          required: true
        - name: WM_SVC.NAME
          in: header
          type: string
          description: Walmart Service Name
          required: true
        - name: Accept
          in: header
          type: string
          description: 'Only supported Media Type : application/json'
          required: true
    - name: v3-shipping-labels-carriers-carrierShortName-trackings-trackingNo-CI
      path: /v3/shipping/labels/carriers/{carrierShortName}/trackings/{trackingNo}/CI
      operations:
      - name: getciforcarrierandtrackingnumber
        method: GET
        description: Walmart Download Commercial Invoice
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: carrierShortName
          in: path
          type: string
          description: carrierShortName
          required: true
        - name: trackingNo
          in: path
          type: string
          description: trackingNo
          required: true
        - name: WM_SEC.ACCESS_TOKEN
          in: header
          type: string
          description: The access token retrieved in the Token API call
          required: true
        - name: WM_CONSUMER.CHANNEL.TYPE
          in: header
          type: string
          description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during
            onboarding
        - name: WM_QOS.CORRELATION_ID
          in: header
          type: string
          description: A unique ID which identifies each API call and used to track and debug issues; use a random generated
            GUID for this ID
          required: true
        - name: WM_SVC.NAME
          in: header
          type: string
          description: Walmart Service Name
          required: true
        - name: Accept
          in: header
          type: string
          description: 'Only supported Media Type : application/json'
          required: true
    - name: v3-shipping-labels-purchase-orders-purchaseOrderId
      path: /v3/shipping/labels/purchase-orders/{purchaseOrderId}
      operations:
      - name: getlabel
        method: GET
        description: Walmart Labels Detail by Purchase Order Id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: purchaseOrderId
          in: path
          type: string
          description: purchaseOrderId
          required: true
        - name: WM_SEC.ACCESS_TOKEN
          in: header
          type: string
          description: The access token retrieved in the Token API call
          required: true
        - name: WM_CONSUMER.CHANNEL.TYPE
          in: header
          type: string
          description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during
            onboarding
        - name: WM_QOS.CORRELATION_ID
          in: header
          type: string
          description: A unique ID which identifies each API call and used to track and debug issues; use a random generated
            GUID for this ID
          required: true
        - name: WM_SVC.NAME
          in: header
          type: string
          description: Walmart Service Name
          required: true
        - name: Accept
          in: header
          type: string
          description: 'Only supported Media Type : application/json'
          required: true
    - name: v3-shipping-labels-shipping-estimates
      path: /v3/shipping/labels/shipping-estimates
      operations:
      - name: getshippingestimate
        method: POST
        description: Walmart Shipping Estimates
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: WM_SEC.ACCESS_TOKEN
          in: header
          type: string
          description: The access token retrieved in the Token API call
          required: true
        - name: WM_CONSUMER.CHANNEL.TYPE
          in: header
          type: string
          description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during
            onboarding
        - name: WM_QOS.CORRELATION_ID
          in: header
          type: string
          description: A unique ID which identifies each API call and used to track and debug issues; use a random generated
            GUID for this ID
          required: true
        - name: WM_SVC.NAME
          in: header
          type: string
          description: Walmart Service Name
          required: true
        - name: Accept
          in: header
          type: string
          description: 'Only supported Media Type : application/json'
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
  exposes:
  - type: rest
    namespace: marketplace-shipping-ship-with-walmart-rest
    port: 8080
    description: REST adapter for Walmart Ship With Walmart — Ship with Walmart. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/v3/shipping/labels
      name: v3-shipping-labels
      description: REST surface for v3-shipping-labels.
      operations:
      - method: POST
        name: createlabel
        description: Walmart Create Label
        call: marketplace-shipping-ship-with-walmart.createlabel
        with:
          WM_SEC.ACCESS_TOKEN: rest.WM_SEC.ACCESS_TOKEN
          WM_CONSUMER.CHANNEL.TYPE: rest.WM_CONSUMER.CHANNEL.TYPE
          WM_QOS.CORRELATION_ID: rest.WM_QOS.CORRELATION_ID
          WM_SVC.NAME: rest.WM_SVC.NAME
          Accept: rest.Accept
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/shipping/labels/carriers
      name: v3-shipping-labels-carriers
      description: REST surface for v3-shipping-labels-carriers.
      operations:
      - method: GET
        name: getcarriers
        description: Walmart Supported Carriers
        call: marketplace-shipping-ship-with-walmart.getcarriers
        with:
          WM_SEC.ACCESS_TOKEN: rest.WM_SEC.ACCESS_TOKEN
          WM_CONSUMER.CHANNEL.TYPE: rest.WM_CONSUMER.CHANNEL.TYPE
          WM_QOS.CORRELATION_ID: rest.WM_QOS.CORRELATION_ID
          WM_SVC.NAME: rest.WM_SVC.NAME
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/shipping/labels/carriers/{carriershortname}/package-types
      name: v3-shipping-labels-carriers-carriershortname-package-types
      description: REST surface for v3-shipping-labels-carriers-carrierShortName-package-types.
      operations:
      - method: GET
        name: getcarrierpackagetypes
        description: Walmart Supported Carrier Package Types
        call: marketplace-shipping-ship-with-walmart.getcarrierpackagetypes
        with:
          carrierShortName: rest.carrierShortName
          WM_SEC.ACCESS_TOKEN: rest.WM_SEC.ACCESS_TOKEN
          WM_CONSUMER.CHANNEL.TYPE: rest.WM_CONSUMER.CHANNEL.TYPE
          WM_QOS.CORRELATION_ID: rest.WM_QOS.CORRELATION_ID
          WM_SVC.NAME: rest.WM_SVC.NAME
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/shipping/labels/carriers/{carriershortname}/trackings/{trackingno}
      name: v3-shipping-labels-carriers-carriershortname-trackings-trackingno
      description: REST surface for v3-shipping-labels-carriers-carrierShortName-trackings-trackingNo.
      operations:
      - method: GET
        name: getlabelbytrackingandcarrier
        description: Walmart Download Label
        call: marketplace-shipping-ship-with-walmart.getlabelbytrackingandcarrier
        with:
          carrierShortName: rest.carrierShortName
          trackingNo: rest.trackingNo
          WM_SEC.ACCESS_TOKEN: rest.WM_SEC.ACCESS_TOKEN
          WM_CONSUMER.CHANNEL.TYPE: rest.WM_CONSUMER.CHANNEL.TYPE
          WM_QOS.CORRELATION_ID: rest.WM_QOS.CORRELATION_ID
          WM_SVC.NAME: rest.WM_SVC.NAME
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: discardlabel
        description: Walmart Discard Label
        call: marketplace-shipping-ship-with-walmart.discardlabel
        with:
          carrierShortName: rest.carrierShortName
          trackingNo: rest.trackingNo
          WM_SEC.ACCESS_TOKEN: rest.WM_SEC.ACCESS_TOKEN
          WM_CONSUMER.CHANNEL.TYPE: rest.WM_CONSUMER.CHANNEL.TYPE
          WM_QOS.CORRELATION_ID: rest.WM_QOS.CORRELATION_ID
          WM_SVC.NAME: rest.WM_SVC.NAME
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/shipping/labels/carriers/{carriershortname}/trackings/{trackingno}/ci
      name: v3-shipping-labels-carriers-carriershortname-trackings-trackingno-ci
      description: REST surface for v3-shipping-labels-carriers-carrierShortName-trackings-trackingNo-CI.
      operations:
      - method: GET
        name: getciforcarrierandtrackingnumber
        description: Walmart Download Commercial Invoice
        call: marketplace-shipping-ship-with-walmart.getciforcarrierandtrackingnumber
        with:
          carrierShortName: rest.carrierShortName
          trackingNo: rest.trackingNo
          WM_SEC.ACCESS_TOKEN: rest.WM_SEC.ACCESS_TOKEN
          WM_CONSUMER.CHANNEL.TYPE: rest.WM_CONSUMER.CHANNEL.TYPE
          WM_QOS.CORRELATION_ID: rest.WM_QOS.CORRELATION_ID
          WM_SVC.NAME: rest.WM_SVC.NAME
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/shipping/labels/purchase-orders/{purchaseorderid}
      name: v3-shipping-labels-purchase-orders-purchaseorderid
      description: REST surface for v3-shipping-labels-purchase-orders-purchaseOrderId.
      operations:
      - method: GET
        name: getlabel
        description: Walmart Labels Detail by Purchase Order Id
        call: marketplace-shipping-ship-with-walmart.getlabel
        with:
          purchaseOrderId: rest.purchaseOrderId
          WM_SEC.ACCESS_TOKEN: rest.WM_SEC.ACCESS_TOKEN
          WM_CONSUMER.CHANNEL.TYPE: rest.WM_CONSUMER.CHANNEL.TYPE
          WM_QOS.CORRELATION_ID: rest.WM_QOS.CORRELATION_ID
          WM_SVC.NAME: rest.WM_SVC.NAME
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/shipping/labels/shipping-estimates
      name: v3-shipping-labels-shipping-estimates
      description: REST surface for v3-shipping-labels-shipping-estimates.
      operations:
      - method: POST
        name: getshippingestimate
        description: Walmart Shipping Estimates
        call: marketplace-shipping-ship-with-walmart.getshippingestimate
        with:
          WM_SEC.ACCESS_TOKEN: rest.WM_SEC.ACCESS_TOKEN
          WM_CONSUMER.CHANNEL.TYPE: rest.WM_CONSUMER.CHANNEL.TYPE
          WM_QOS.CORRELATION_ID: rest.WM_QOS.CORRELATION_ID
          WM_SVC.NAME: rest.WM_SVC.NAME
          Accept: rest.Accept
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: marketplace-shipping-ship-with-walmart-mcp
    port: 9090
    transport: http
    description: MCP adapter for Walmart Ship With Walmart — Ship with Walmart. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: walmart-create-label
      description: Walmart Create Label
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: marketplace-shipping-ship-with-walmart.createlabel
      with:
        WM_SEC.ACCESS_TOKEN: tools.WM_SEC.ACCESS_TOKEN
        WM_CONSUMER.CHANNEL.TYPE: tools.WM_CONSUMER.CHANNEL.TYPE
        WM_QOS.CORRELATION_ID: tools.WM_QOS.CORRELATION_ID
        WM_SVC.NAME: tools.WM_SVC.NAME
        Accept: tools.Accept
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: walmart-supported-carriers
      description: Walmart Supported Carriers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: marketplace-shipping-ship-with-walmart.getcarriers
      with:
        WM_SEC.ACCESS_TOKEN: tools.WM_SEC.ACCESS_TOKEN
        WM_CONSUMER.CHANNEL.TYPE: tools.WM_CONSUMER.CHANNEL.TYPE
        WM_QOS.CORRELATION_ID: tools.WM_QOS.CORRELATION_ID
        WM_SVC.NAME: tools.WM_SVC.NAME
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.
    - name: walmart-supported-carrier-package-types
      description: Walmart Supported Carrier Package Types
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: marketplace-shipping-ship-with-walmart.getcarrierpackagetypes
      with:
        carrierShortName: tools.carrierShortName
        WM_SEC.ACCESS_TOKEN: tools.WM_SEC.ACCESS_TOKEN
        WM_CONSUMER.CHANNEL.TYPE: tools.WM_CONSUMER.CHANNEL.TYPE
        WM_QOS.CORRELATION_ID: tools.WM_QOS.CORRELATION_ID
        WM_SVC.NAME: tools.WM_SVC.NAME
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.
    - name: walmart-download-label
      description: Walmart Download Label
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: marketplace-shipping-ship-with-walmart.getlabelbytrackingandcarrier
      with:
        carrierShortName: tools.carrierShortName
        trackingNo: tools.trackingNo
        WM_SEC.ACCESS_TOKEN: tools.WM_SEC.ACCESS_TOKEN
        WM_CONSUMER.CHANNEL.TYPE: tools.WM_CONSUMER.CHANNEL.TYPE
        WM_QOS.CORRELATION_ID: tools.WM_QOS.CORRELATION_ID
        WM_SVC.NAME: tools.WM_SVC.NAME
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.
    - name: walmart-discard-label
      description: Walmart Discard Label
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: marketplace-shipping-ship-with-walmart.discardlabel
      with:
        carrierShortName: tools.carrierShortName
        trackingNo: tools.trackingNo
        WM_SEC.ACCESS_TOKEN: tools.WM_SEC.ACCESS_TOKEN
        WM_CONSUMER.CHANNEL.TYPE: tools.WM_CONSUMER.CHANNEL.TYPE
        WM_QOS.CORRELATION_ID: tools.WM_QOS.CORRELATION_ID
        WM_SVC.NAME: tools.WM_SVC.NAME
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.
    - name: walmart-download-commercial-invoice
      description: Walmart Download Commercial Invoice
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: marketplace-shipping-ship-with-walmart.getciforcarrierandtrackingnumber
      with:
        carrierShortName: tools.carrierShortName
        trackingNo: tools.trackingNo
        WM_SEC.ACCESS_TOKEN: tools.WM_SEC.ACCESS_TOKEN
        WM_CONSUMER.CHANNEL.TYPE: tools.WM_CONSUMER.CHANNEL.TYPE
        WM_QOS.CORRELATION_ID: tools.WM_QOS.CORRELATION_ID
        WM_SVC.NAME: tools.WM_SVC.NAME
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.
    - name: walmart-labels-detail-purchase-order
      description: Walmart Labels Detail by Purchase Order Id
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: marketplace-shipping-ship-with-walmart.getlabel
      with:
        purchaseOrderId: tools.purchaseOrderId
        WM_SEC.ACCESS_TOKEN: tools.WM_SEC.ACCESS_TOKEN
        WM_CONSUMER.CHANNEL.TYPE: tools.WM_CONSUMER.CHANNEL.TYPE
        WM_QOS.CORRELATION_ID: tools.WM_QOS.CORRELATION_ID
        WM_SVC.NAME: tools.WM_SVC.NAME
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.
    - name: walmart-shipping-estimates
      description: Walmart Shipping Estimates
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: marketplace-shipping-ship-with-walmart.getshippingestimate
      with:
        WM_SEC.ACCESS_TOKEN: tools.WM_SEC.ACCESS_TOKEN
        WM_CONSUMER.CHANNEL.TYPE: tools.WM_CONSUMER.CHANNEL.TYPE
        WM_QOS.CORRELATION_ID: tools.WM_QOS.CORRELATION_ID
        WM_SVC.NAME: tools.WM_SVC.NAME
        Accept: tools.Accept
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.