openapi: 3.0.1
info:
  title: Walmart Lag Time
  description: This API allows the retrieval of Lag Time for an item with a given SKU.
servers:
  - url: https://marketplace.walmartapis.com
    description: Production URL
  - url: https://sandbox.walmartapis.com
    description: Sandbox URL
security:
  - basicScheme: []
paths:
  "/v3/feeds":
    post:
      tags:
        - Lag Time
      summary: Walmart Update Lag Time
      description: |-
        This API allows the update of lag time for items in bulk.

        Lag Time is the number of days between when an item is ordered and when it is shipped. Lag time of two days or more requires approval at the item setup category level. Please refer to the Request Lag Time Exceptions article for more details on this process.

        Download the Lag Time Exception XSDs from the below directory:

        xsd/LagTimeException.zip.
      operationId: updateLagTimeBulk
      parameters:
        - name: feedType
          in: query
          description: Use 'lagtime'
          required: true
          schema:
            type: string
        - in: header
          name: WM_SEC.ACCESS_TOKEN
          description: The access token retrieved in the Token API call
          required: true
          schema:
            type: string
          example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM.....
        - in: header
          name: WM_CONSUMER.CHANNEL.TYPE
          description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
          required: false
          schema:
            type: string
        - in: header
          name: WM_QOS.CORRELATION_ID
          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
          schema:
            type: string
          example: b3261d2d-028a-4ef7-8602-633c23200af6
        - in: header
          name: WM_SVC.NAME
          description: Walmart Service Name
          required: true
          schema:
            type: string
          example: Walmart Service Name
      requestBody:
        description: File fields
        content:
          application/json:
            schema:
              required:
                - lagTimeHeader
              type: object
              properties:
                lagTimeHeader:
                  type: object
                  properties:
                    version:
                      type: string
                    feedDate:
                      type: string
                lagTime:
                  type: array
                  xml:
                    namespace: http://walmart.com/
                  items:
                    required:
                      - sku
                    type: object
                    properties:
                      sku:
                        type: string
                        description: A seller-provided Product ID. Response will have decoded value.
                        xml:
                          namespace: http://walmart.com/
                      fulfillmentLagTime:
                        type: integer
                        description: The number of days between when the item is ordered and when it is shipped
                        format: int32
                        xml:
                          namespace: http://walmart.com/
                      additionalAttributes:
                        type: array
                        xml:
                          namespace: http://walmart.com/
                        items:
                          required:
                            - name
                            - value
                          type: object
                          properties:
                            name:
                              type: string
                              xml:
                                namespace: http://walmart.com/
                            value:
                              type: string
                              xml:
                                namespace: http://walmart.com/
                    xml:
                      name: lagTime
              xml:
                name: lagTimeFeed
            examples:
              json1:
                value:
                  LagTimeHeader:
                    version: '1.0'
                  lagTime:
                    - sku: 30348_KFTest
                      fulfillmentLagTime: '1'
          application/xml:
            schema:
              required:
                - lagTimeHeader
              type: object
              properties:
                lagTimeHeader:
                  type: object
                  properties:
                    version:
                      type: string
                    feedDate:
                      type: string
                lagTime:
                  type: array
                  xml:
                    namespace: http://walmart.com/
                  items:
                    required:
                      - sku
                    type: object
                    properties:
                      sku:
                        type: string
                        description: A seller-provided Product ID. Response will have decoded value.
                        xml:
                          namespace: http://walmart.com/
                      fulfillmentLagTime:
                        type: integer
                        description: The number of days between when the item is ordered and when it is shipped
                        format: int32
                        xml:
                          namespace: http://walmart.com/
                      additionalAttributes:
                        type: array
                        xml:
                          namespace: http://walmart.com/
                        items:
                          required:
                            - name
                            - value
                          type: object
                          properties:
                            name:
                              type: string
                              xml:
                                namespace: http://walmart.com/
                            value:
                              type: string
                              xml:
                                namespace: http://walmart.com/
                    xml:
                      name: lagTime
              xml:
                name: lagTimeFeed
            examples:
              xml1:
                value: |
                  <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
                  <LagTimeFeed xmlns="http://walmart.com/">
                      <LagTimeHeader>
                          <version>1.0</version>
                      </LagTimeHeader>
                      <lagTime>
                          <sku>30348_KFTest</sku>
                          <fulfillmentLagTime>0</fulfillmentLagTime>
                      </lagTime>
                      <lagTime>
                          <sku>10210321</sku>
                          <fulfillmentLagTime>0</fulfillmentLagTime>
                      </lagTime>
                  </LagTimeFeed>
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  feedId:
                    type: string
                    description: A unique ID, returned from the Bulk Upload API, used for tracking the Feed File.
              example:
                feedId: E7BB7DBAF3FF461AB63A2169F3BEAADE@AVQBAgA
            application/xml:
              schema:
                type: object
                properties:
                  feedId:
                    type: string
                    description: A unique ID, returned from the Bulk Upload API, used for tracking the Feed File.
              example: |-
                <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
                <ns2:FeedAcknowledgement xmlns:ns2="http://walmart.com/">
                    <ns2:feedId>76D440717BFD429DAD28AC01D42AE90D@AR0BAQA</ns2:feedId>
                </ns2:FeedAcknowledgement>
  "/v3/lagtime":
    get:
      tags:
        - Lag Time
      summary: Walmart Lag Time
      description: |-
        This API allows the retrieval of Lag Time for an item with a given SKU.

        Lag Time is the number of days between when an item is ordered and when it is shipped. Lag time of two days or more requires approval at the item setup category level. Please refer to the Request Lag Time Exceptions article for more details on this process.

        Download the Lag Time Exception XSDs from the below directory:

        xsd/LagTimeException.zip.

        Download the Lag Time JSON schema from the below directory:

        xsd/LagTimeException.zip.
      operationId: getLagTime
      parameters:
        - name: sku
          in: query
          description: 'An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item. This will be used by the seller in the XSD file to refer to each item. Special characters in the sku needing encoding are: '':'', ''/'', ''?'', ''#'', ''['', '']'', ''@'', ''!'', ''$'', ''&'', "''", ''('', '')'', ''*'', ''+'', '','', '';'', ''='', ‘ ’, ''{'', ''}'' as well as ''%'' itself if it''s a part of sku. Make sure to encode space with %20. Other characters don''t need to be encoded.'
          required: true
          schema:
            type: string
        - in: header
          name: WM_SEC.ACCESS_TOKEN
          description: The access token retrieved in the Token API call
          required: true
          schema:
            type: string
          example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM.....
        - in: header
          name: WM_CONSUMER.CHANNEL.TYPE
          description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
          required: false
          schema:
            type: string
        - in: header
          name: WM_QOS.CORRELATION_ID
          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
          schema:
            type: string
          example: b3261d2d-028a-4ef7-8602-633c23200af6
        - in: header
          name: WM_SVC.NAME
          description: Walmart Service Name
          required: true
          schema:
            type: string
          example: Walmart Service Name
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                required:
                  - fulfillmentLagTime
                  - sku
                type: object
                properties:
                  sku:
                    type: string
                    description: A seller-provided Product ID. Response will have decoded value.
                    xml:
                      namespace: http://walmart.com/
                  fulfillmentLagTime:
                    type: integer
                    description: The number of days between when the item is ordered and when it is shipped
                    format: int32
                    xml:
                      namespace: http://walmart.com/
                xml:
                  name: lagTime
              example:
                sku: '183688'
                fulfillmentLagTime: 0
            application/xml:
              schema:
                required:
                  - fulfillmentLagTime
                  - sku
                type: object
                properties:
                  sku:
                    type: string
                    description: A seller-provided Product ID. Response will have decoded value.
                    xml:
                      namespace: http://walmart.com/
                  fulfillmentLagTime:
                    type: integer
                    description: The number of days between when the item is ordered and when it is shipped
                    format: int32
                    xml:
                      namespace: http://walmart.com/
                xml:
                  name: lagTime
              example: |-
                <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
                <lagTime xmlns="http://walmart.com/">
                    <sku>1068155</sku>
                    <fulfillmentLagTime>1</fulfillmentLagTime>
                </lagTime>
components:
  schemas:
    FeedId:
      type: object
      properties:
        feedId:
          type: string
          description: A unique ID, returned from the Bulk Upload API, used for tracking the Feed File.
    AdditionalAttributes:
      required:
        - name
        - value
      type: object
      properties:
        name:
          type: string
          xml:
            namespace: http://walmart.com/
        value:
          type: string
          xml:
            namespace: http://walmart.com/
    LagTime:
      required:
        - sku
      type: object
      properties:
        sku:
          type: string
          description: A seller-provided Product ID. Response will have decoded value.
          xml:
            namespace: http://walmart.com/
        fulfillmentLagTime:
          type: integer
          description: The number of days between when the item is ordered and when it is shipped
          format: int32
          xml:
            namespace: http://walmart.com/
        additionalAttributes:
          type: array
          xml:
            namespace: http://walmart.com/
          items:
            required:
              - name
              - value
            type: object
            properties:
              name:
                type: string
                xml:
                  namespace: http://walmart.com/
              value:
                type: string
                xml:
                  namespace: http://walmart.com/
      xml:
        name: lagTime
    LagTimeFeed:
      required:
        - lagTimeHeader
      type: object
      properties:
        lagTimeHeader:
          type: object
          properties:
            version:
              type: string
            feedDate:
              type: string
        lagTime:
          type: array
          xml:
            namespace: http://walmart.com/
          items:
            required:
              - sku
            type: object
            properties:
              sku:
                type: string
                description: A seller-provided Product ID. Response will have decoded value.
                xml:
                  namespace: http://walmart.com/
              fulfillmentLagTime:
                type: integer
                description: The number of days between when the item is ordered and when it is shipped
                format: int32
                xml:
                  namespace: http://walmart.com/
              additionalAttributes:
                type: array
                xml:
                  namespace: http://walmart.com/
                items:
                  required:
                    - name
                    - value
                  type: object
                  properties:
                    name:
                      type: string
                      xml:
                        namespace: http://walmart.com/
                    value:
                      type: string
                      xml:
                        namespace: http://walmart.com/
            xml:
              name: lagTime
      xml:
        name: lagTimeFeed
    LagTimeHeader:
      type: object
      properties:
        version:
          type: string
        feedDate:
          type: string
    LagTimeResponse:
      required:
        - fulfillmentLagTime
        - sku
      type: object
      properties:
        sku:
          type: string
          description: A seller-provided Product ID. Response will have decoded value.
          xml:
            namespace: http://walmart.com/
        fulfillmentLagTime:
          type: integer
          description: The number of days between when the item is ordered and when it is shipped
          format: int32
          xml:
            namespace: http://walmart.com/
      xml:
        name: lagTime
  parameters:
    authorization:
      name: Authorization
      in: header
      description: Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps.
      required: true
      schema:
        type: string
      example: Basic YzcyOTFjNmItNzI5MC00....
    accessToken:
      name: WM_SEC.ACCESS_TOKEN
      in: header
      description: The access token retrieved in the Token API call
      required: true
      schema:
        type: string
      example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM.....
    channelType:
      name: WM_CONSUMER.CHANNEL.TYPE
      in: header
      description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
      required: false
      schema:
        type: string
    correlationId:
      name: WM_QOS.CORRELATION_ID
      in: header
      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
      schema:
        type: string
      example: b3261d2d-028a-4ef7-8602-633c23200af6
    svcName:
      name: WM_SVC.NAME
      in: header
      description: Walmart Service Name
      required: true
      schema:
        type: string
      example: Walmart Service Name
    accept:
      name: Accept
      in: header
      description: 'Only supported Media Type : application/json'
      required: true
      schema:
        type: string
      example: application/json
    content-type:
      name: Content-Type
      in: header
      description: 'Only supported Media Type : application/json'
      required: true
      schema:
        type: string
      example: application/json
tags:
  - name: Lag Time