VTEX SLA API

openapi: 3.0.0
info:
  title: VTex Anti-fraud Provider Account SLA API
  description: ">ℹ️ Onboarding guide\r\n>\r\n> Check the new [Payments onboarding guide](https://developers.vtex.com/docs/guides/payments-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Payments and is organized by focusing on the developer's journey.\r\n\r\nThe Anti-fraud Provider Protocol is a set of definitions to help you integrate your anti-fraud service API into VTEX platform.\r\n\r\nTo achieve this, you need to implement a web API (REST) following the specifications described in this documentation.\r\n\r\n>⚠️ You can also access our [template on GitHub](https://github.com/vtex-apps/antifraud-provider-example) to help you quickly develop your anti-fraud connector using the Anti-fraud Provider Protocol and VTEX IO.\r\n\r\nTo learn more about the Anti-fraud Provider Protocol, check our [developer guide](https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works).\r\n\r\n## Anti-fraud Provider API Index\r\n\r\n### Anti-fraud  Flow\r\n\r\n- `POST` [Send Anti-fraud Pre-Analysis Data (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/pre-analysis)\r\n- `POST` [Send Anti-fraud Data](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/transactions)\r\n- `PUT` [Update Anti-fraud Transactions (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#put-/transactions/-transactionId-)\r\n- `GET` [List Anti-fraud Provider Manifest](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/manifest)\r\n- `GET` [Get Anti-fraud Status](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/transactions/-transactions.id-)\r\n- `DELETE` [Stop Anti-fraud Analysis (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#delete-/transactions/-transactions.Id-)\r\n\r\n### OAuth Flow\r\n\r\n1. `POST` [Retrieve Token](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/authorization/token)\r\n2. `GET` [Redirect](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/redirect)\r\n3. `GET` [Return to VTEX](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorizationCode)\r\n4. `GET` [Get Credentials](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorization/credentials)"
  version: '1.0'
servers:
- url: https://{providerApiEndpoint}
  description: Anti-fraud provider endpoint URL.
  variables:
    providerApiEndpoint:
      description: Anti-fraud provider endpoint URL.
      default: '{providerApiEndpoint}'
tags:
- name: SLA
paths:
  /api/logistics/pvt/shipping/calculate:
    post:
      tags:
      - SLA
      summary: VTex Calculate SLA
      description: "Endpoint used by the checkout to calculate the Service Level Agreement (SLA), a contract between the store and shoppers on the order's fulfillment conditions, such as the shipping estimated date. \r\n\r\nThe calculation of the estimated date considers the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) and [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) related to the order."
      operationId: CalculateSLA
      parameters:
      - name: Content-Type
        in: header
        description: Type of the content being sent.
        required: true
        style: simple
        schema:
          type: string
          default: application/json; charset=utf-8
      - name: Accept
        in: header
        description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
        required: true
        style: simple
        schema:
          type: string
          default: application/json
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              type: array
              items:
                title: CalculateSLARequest
                required:
                - items
                - location
                - salesChannel
                type: object
                properties:
                  items:
                    type: array
                    items:
                      title: Item3
                      required:
                      - id
                      - groupItemId
                      - kitItem
                      - quantity
                      - price
                      - additionalHandlingTime
                      - dimension
                      type: object
                      properties:
                        id:
                          type: string
                        groupItemId:
                          type: string
                          nullable: true
                        kitItem:
                          type: array
                          items:
                            title: KitItem
                            required:
                            - id
                            - groupItemId
                            - kitItem
                            - quantity
                            - price
                            - additionalHandlingTime
                            - dimension
                            type: object
                            properties:
                              id:
                                type: string
                              groupItemId:
                                type: string
                                nullable: true
                              kitItem:
                                type: array
                                items:
                                  type: string
                                description: '[Kit item](https://help.vtex.com/en/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28) details.'
                              quantity:
                                type: integer
                                format: int32
                              price:
                                type: integer
                                format: int32
                              additionalHandlingTime:
                                type: string
                              dimension:
                                title: Dimension
                                required:
                                - weight
                                - height
                                - width
                                - length
                                type: object
                                properties:
                                  weight:
                                    type: integer
                                    format: int32
                                  height:
                                    type: integer
                                    format: int32
                                  width:
                                    type: integer
                                    format: int32
                                  length:
                                    type: integer
                                    format: int32
                                example:
                                  weight: 150
                                  height: 1
                                  width: 1
                                  length: 1
                            example:
                              id: '2000042'
                              groupItemId: null
                              kitItem: []
                              quantity: 1
                              price: 0
                              additionalHandlingTime: 00:00:00
                              dimension:
                                weight: 150
                                height: 5
                                width: 17
                                length: 17
                          description: '[Kit](https://help.vtex.com/en/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28) item information.'
                        quantity:
                          type: integer
                          format: int32
                        price:
                          type: integer
                          format: int32
                        additionalHandlingTime:
                          type: string
                        dimension:
                          title: Dimension
                          required:
                          - weight
                          - height
                          - width
                          - length
                          type: object
                          properties:
                            weight:
                              type: integer
                              format: int32
                            height:
                              type: integer
                              format: int32
                            width:
                              type: integer
                              format: int32
                            length:
                              type: integer
                              format: int32
                          example:
                            weight: 150
                            height: 1
                            width: 1
                            length: 1
                      example:
                        id: '1'
                        groupItemId: null
                        kitItem:
                        - id: '2000042'
                          groupItemId: null
                          kitItem: []
                          quantity: 1
                          price: 0
                          additionalHandlingTime: 00:00:00
                          dimension:
                            weight: 150
                            height: 5
                            width: 17
                            length: 17
                        - id: '2390059'
                          groupItemId: null
                          kitItem: []
                          quantity: 1
                          price: 0
                          additionalHandlingTime: 00:00:00
                          dimension:
                            weight: 150
                            height: 5
                            width: 17
                            length: 17
                        quantity: 1
                        price: 0
                        additionalHandlingTime: 00:00:00
                        dimension:
                          weight: 150
                          height: 5
                          width: 17
                          length: 17
                    description: ''
                  location:
                    title: Location3
                    required:
                    - zipCode
                    - country
                    - point
                    type: object
                    properties:
                      zipCode:
                        type: string
                      country:
                        type: string
                      point:
                        type: array
                        items:
                          type: number
                        description: ''
                    example:
                      zipCode: '22780084'
                      country: BRA
                      point:
                      - -43.32475950000003
                      - -22.9999575
                  salesChannel:
                    type: string
                example:
                  items:
                  - id: '1'
                    groupItemId: null
                    kitItem:
                    - id: '2000042'
                      groupItemId: null
                      kitItem: []
                      quantity: 1
                      price: 0
                      additionalHandlingTime: 00:00:00
                      dimension:
                        weight: 150
                        height: 5
                        width: 17
                        length: 17
                    - id: '2390059'
                      groupItemId: null
                      kitItem: []
                      quantity: 1
                      price: 0
                      additionalHandlingTime: 00:00:00
                      dimension:
                        weight: 150
                        height: 5
                        width: 17
                        length: 17
                    quantity: 1
                    price: 0
                    additionalHandlingTime: 00:00:00
                    dimension:
                      weight: 150
                      height: 5
                      width: 17
                      length: 17
                  location:
                    zipCode: '22780084'
                    country: BRA
                    point:
                    - -43.32475950000003
                    - -22.9999575
                  salesChannel: '1'
              description: ''
            example:
            - items:
              - id: '1'
                groupItemId: null
                kitItem:
                - id: '2000042'
                  groupItemId: null
                  kitItem: []
                  quantity: 1
                  price: 0
                  additionalHandlingTime: 00:00:00
                  dimension:
                    weight: 150
                    height: 5
                    width: 17
                    length: 17
                - id: '2390059'
                  groupItemId: null
                  kitItem: []
                  quantity: 1
                  price: 0
                  additionalHandlingTime: 00:00:00
                  dimension:
                    weight: 150
                    height: 5
                    width: 17
                    length: 17
                quantity: 1
                price: 0
                additionalHandlingTime: 00:00:00
                dimension:
                  weight: 150
                  height: 5
                  width: 17
                  length: 17
              location:
                zipCode: '22780084'
                country: BRA
                point:
                - -43.32475950000003
                - -22.9999575
              salesChannel: '1'
        required: true
      responses:
        '200':
          description: ''
          headers:
            Cache-Control:
              content:
                text/plain:
                  schema:
                    type: string
                  example: no-cache
            Connection:
              content:
                text/plain:
                  schema:
                    type: string
                  example: keep-alive
            Content-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                  example: gzip
            Content-Length:
              content:
                text/plain:
                  schema:
                    type: string
                  example: '632'
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                  example: Fri, 15 Apr 2016 20:00:26 GMT
            Expires:
              content:
                text/plain:
                  schema:
                    type: string
                  example: '-1'
            Pragma:
              content:
                text/plain:
                  schema:
                    type: string
                  example: no-cache
            Server:
              content:
                text/plain:
                  schema:
                    type: string
                  example: nginx
            Vary:
              content:
                text/plain:
                  schema:
                    type: string
                  example: Accept-Encoding
            X-CDNIgnore:
              content:
                text/plain:
                  schema:
                    type: string
                  example: '1'
            X-CacheServer:
              content:
                text/plain:
                  schema:
                    type: string
                  example: janus-apicache-nginx1
            X-Powered-by-VTEX-Janus-ApiCache:
              content:
                text/plain:
                  schema:
                    type: string
                  example: v1.3.8
            X-Powered-by-VTEX-Janus-Edge:
              content:
                text/plain:
                  schema:
                    type: string
                  example: v1.26.4
            X-Powered-by-VTEX-Janus-Router:
              content:
                text/plain:
                  schema:
                    type: string
                  example: 2.1.155
            X-Track:
              content:
                text/plain:
                  schema:
                    type: string
                  example: stable
            X-VTEX-Janus-Router-Backend-App:
              content:
                text/plain:
                  schema:
                    type: string
                  example: logist-v6.2.96-stable+863
            x-vtex-operation-id:
              content:
                text/plain:
                  schema:
                    type: string
                  example: 0c124229-3bb5-4fc2-9d4e-94b9cbe4281f
          content:
            application/json; charset=utf-8:
              schema:
                type: array
                items:
                  type: array
                  items:
                    required:
                    - itemId
                    - quantity
                    - availabilityQuantity
                    - salesChannel
                    - slaType
                    - slaTypeName
                    - freightTableName
                    - freightTableId
                    - listPrice
                    - transitTime
                    - dockTime
                    - timeToDockPlusDockTime
                    - aditionalTimeBlockedDays
                    - totalTime
                    - deliveryWindows
                    - wareHouseId
                    - dockId
                    - location
                    - deliveryOnWeekends
                    - carrierSchedule
                    - restrictedFreight
                    - coordinates
                    - pickupStoreInfo
                    type: object
                    properties:
                      itemId:
                        type: string
                      quantity:
                        type: integer
                        format: int32
                      availabilityQuantity:
                        type: integer
                        format: int32
                      salesChannel:
                        type: string
                      slaType:
                        type: string
                      slaTypeName:
                        type: string
                      freightTableName:
                        type: string
                      freightTableId:
                        type: string
                      listPrice:
                        type: number
                      transitTime:
                        type: string
                      dockTime:
                        type: string
                      timeToDockPlusDockTime:
                        type: string
                      aditionalTimeBlockedDays:
                        type: string
                      totalTime:
                        type: string
                      deliveryWindows:
                        type: array
                        items:
                          title: DeliveryWindow
                          type: object
                          properties:
                            startDateUtc:
                              type: string
                            endDateUtc:
                              type: string
                            listPrice:
                              type: number
                          example:
                            startDateUtc: '2016-04-20T08:00:00+00:00'
                            endDateUtc: '2016-04-20T12:00:00+00:00'
                            listPrice: 10
                        description: ''
                      wareHouseId:
                        type: string
                      dockId:
                        type: string
                      location:
                        title: Location1
                        required:
                        - zipCode
                        - country
                        - deliveryPointId
                        - point
                        - inStore
                        type: object
                        properties:
                          zipCode:
                            type: string
                          country:
                            type: string
                          deliveryPointId:
                            type: string
                            nullable: true
                          point:
                            type: string
                            nullable: true
                          inStore:
                            title: InStore1
                            required:
                            - IsCheckedIn
                            - StoreId
                            type: object
                            properties:
                              IsCheckedIn:
                                type: boolean
                              StoreId:
                                type: string
                            example:
                              IsCheckedIn: false
                              StoreId: '180082'
                        example:
                          zipCode: '22220070'
                          country: BRA
                          deliveryPointId: null
                          point: null
                          inStore:
                            IsCheckedIn: false
                            StoreId: '180082'
                      deliveryOnWeekends:
                        type: boolean
                      carrierSchedule:
                        type: array
                        items:
                          type: string
                        description: ''
                      restrictedFreight:
                        type: string
                        nullable: true
                      coordinates:
                        type: string
                        nullable: true
                      pickupStoreInfo:
                        type: string
                        nullable: true
                    example:
                      itemId: '2389945'
                      quantity: 1
                      availabilityQuantity: 500
                      salesChannel: '1'
                      slaType: Entrega Agendada
                      slaTypeName: Entrega Agendada
                      freightTableName: Entrega Agendada
                      freightTableId: teste1
                      listPrice: 5.25
                      transitTime: 2.00:00:00
                      dockTime: 00:00:00
                      timeToDockPlusDockTime: 1.00:00:00
                      aditionalTimeBlockedDays: 00:00:00
                      totalTime: 3.00:00:00
                      deliveryWindows:
                      - startDateUtc: '2016-04-20T08:00:00+00:00'
                        endDateUtc: '2016-04-20T12:00:00+00:00'
                        listPrice: 10
                      - startDateUtc: '2016-04-20T12:01:00+00:00'
                        endDateUtc: '2016-04-20T18:00:00+00:00'
                        listPrice: 10
                      - startDateUtc: '2016-04-21T08:00:00+00:00'
                        endDateUtc: '2016-04-21T12:00:00+00:00'
                        listPrice: 10
                      - startDateUtc: '2016-04-21T12:01:00+00:00'
                        endDateUtc: '2016-04-21T18:00:00+00:00'
                        listPrice: 10
                      - startDateUtc: '2016-04-22T08:00:00+00:00'
                        endDateUtc: '2016-04-22T12:00:00+00:00'
                        listPrice: 10
                      - startDateUtc: '2016-04-22T12:01:00+00:00'
                        endDateUtc: '2016-04-22T18:00:00+00:00'
                        listPrice: 10
                      - startDateUtc: '2016-04-23T08:00:00+00:00'
                        endDateUtc: '2016-04-23T12:00:00+00:00'
                        listPrice: 10
                      - startDateUtc: '2016-04-23T12:01:00+00:00'
                        endDateUtc: '2016-04-23T18:00:00+00:00'
                        listPrice: 10
                      - startDateUtc: '2016-04-24T08:00:00+00:00'
                        endDateUtc: '2016-04-24T12:00:00+00:00'
                        listPrice: 10
                      - startDateUtc: '2016-04-24T12:01:00+00:00'
                        endDateUtc: '2016-04-24T18:00:00+00:00'
                        listPrice: 10
                      - startDateUtc: '2016-04-25T08:00:00+00:00'
                        endDateUtc: '2016-04-25T12:00:00+00:00'
                        listPrice: 10
                      - startDateUtc: '2016-04-25T12:01:00+00:00'
                        endDateUtc: '2016-04-25T18:00:00+00:00'
                        listPrice: 10
                      - startDateUtc: '2016-04-26T08:00:00+00:00'
                        endDateUtc: '2016-04-26T12:00:00+00:00'
                        listPrice: 10
                      - startDateUtc: '2016-04-26T12:01:00+00:00'
                        endDateUtc: '2016-04-26T18:00:00+00:00'
                        listPrice: 10
                      wareHouseId: '1937054'
                      dockId: '1_1_1'
                      location:
                        zipCode: '22220070'
                        country: BRA
                        deliveryPointId: null
                        point: null
                        inStore:
                          IsCheckedIn: false
                          StoreId: '180082'
                      deliveryOnWeekends: false
                      carrierSchedule: []
                      restrictedFreight: null
                      coordinates: null
                      pickupStoreInfo: null
              example:
              - - itemId: '2389945'
                  quantity: 1
                  availabilityQuantity: 500
                  salesChannel: '1'
                  slaType: Entrega Agendada
                  slaTypeName: Entrega Agendada
                  freightTableName: Entrega Agendada
                  freightTableId: teste1
                  listPrice: 5.25
                  transitTime: 2.00:00:00
                  dockTime: 00:00:00
                  timeToDockPlusDockTime: 1.00:00:00
                  aditionalTimeBlockedDays: 00:00:00
                  totalTime: 3.00:00:00
                  deliveryWindows:
                  - startDateUtc: '2016-04-20T08:00:00+00:00'
                    endDateUtc: '2016-04-20T12:00:00+00:00'
                    listPrice: 10
                  - startDateUtc: '2016-04-20T12:01:00+00:00'
                    endDateUtc: '2016-04-20T18:00:00+00:00'
                    listPrice: 10
                  - startDateUtc: '2016-04-21T08:00:00+00:00'
                    endDateUtc: '2016-04-21T12:00:00+00:00'
                    listPrice: 10
                  - startDateUtc: '2016-04-21T12:01:00+00:00'
                    endDateUtc: '2016-04-21T18:00:00+00:00'
                    listPrice: 10
                  - startDateUtc: '2016-04-22T08:00:00+00:00'
                    endDateUtc: '2016-04-22T12:00:00+00:00'
                    listPrice: 10
                  - startDateUtc: '2016-04-22T12:01:00+00:00'
                    endDateUtc: '2016-04-22T18:00:00+00:00'
                    listPrice: 10
                  - startDateUtc: '2016-04-23T08:00:00+00:00'
                    endDateUtc: '2016-04-23T12:00:00+00:00'
                    listPrice: 10
                  - startDateUtc: '2016-04-23T12:01:00+00:00'
                    endDateUtc: '2016-04-23T18:00:00+00:00'
                    listPrice: 10
                  - startDateUtc: '2016-04-24T08:00:00+00:00'
                    endDateUtc: '2016-04-24T12:00:00+00:00'
                    listPrice: 10
                  - startDateUtc: '2016-04-24T12:01:00+00:00'
                    endDateUtc: '2016-04-24T18:00:00+00:00'
                    listPrice: 10
                  - startDateUtc: '2016-04-25T08:00:00+00:00'
                    endDateUtc: '2016-04-25T12:00:00+00:00'
                    listPrice: 10
                  - startDateUtc: '2016-04-25T12:01:00+00:00'
                    endDateUtc: '2016-04-25T18:00:00+00:00'
                    listPrice: 10
                  - startDateUtc: '2016-04-26T08:00:00+00:00'
                    endDateUtc: '2016-04-26T12:00:00+00:00'
                    listPrice: 10
                  - startDateUtc: '2016-04-26T12:01:00+00:00'
                    endDateUtc: '2016-04-26T18:00:00+00:00'
                    listPrice: 10
                  wareHouseId: '1937054'
                  dockId: '1_1_1'
                  location:
                    zipCode: '22220070'
                    country: BRA
                    deliveryPointId: null
                    point: null
                    inStore:
                      IsCheckedIn: false
                      StoreId: '180082'
                  deliveryOnWeekends: false
                  carrierSchedule: []
                  restrictedFreight: null
                  coordinates: null
                  pickupStoreInfo: null
                - itemId: '2390059'
                  quantity: 1
                  availabilityQuantity: 500
                  salesChannel: '1'
                  slaType: Entrega Agendada
                  slaTypeName: Entrega Agendada
                  freightTableName: Entrega Agendada
                  freightTableId: teste1
                  listPrice: 5.25
                  transitTime: 2.00:00:00
                  dockTime: 00:00:00
                  timeToDockPlusDockTime: 1.00:00:00
                  aditionalTimeBlockedDays: 00:00:00
                  totalTime: 3.00:00:00
                  deliveryWindows:
                  - startDateUtc: '2016-04-20T08:00:00+00:00'
                    endDateUtc: '2016-04-20T12:00:00+00:00'
                    listPrice: 10
                  - startDateUtc: '2016-04-20T12:01:00+00:00'
                    endDateUtc: '2016-04-20T18:00:00+00:00'
                    listPrice: 10
                  - startDateUtc: '2016-04-21T08:00:00+00:00'
                    endDateUtc: '2016-04-21T12:00:00+00:00'
                    listPrice: 10
                  - startDateUtc: '2016-04-21T12:01:00+00:00'
                    endDateUtc: '2016-04-21T18:00:00+00:00'
                    listPrice: 10
                  - startDateUtc: '2016-04-22T08:00:00+00:00'
                    endDateUtc: '2016-04-22T12:00:00+00:00'
                    listPrice: 10
                  - startDateUtc: '2016-04-22T12:01:00+00:00'
                    endDateUtc: '2016-04-22T18:00:00+00:00'
                    listPrice: 10
                  - startDateUtc: '2016-04-23T08:00:00+00:00'
                    endDateUtc: '2016-04-23T12:00:00+00:00'
                    listPrice: 10
                  - startDateUtc: '2016-04-23T12:01:00+00:00'
                    endDateUtc: '2016-04-23T18:00:00+00:00'
                    listPrice: 10
                  - startDateUtc: '2016-04-24T08:00:00+00:00'
                    endDateUtc: '2016-04-24T12:00:00+00:00'
                    listPrice: 10
                  - startDateUtc: '2016-04-24T12:01:00+00:00'
                    endDateUtc: '2016-04-24T18:00:00+00:00'
                    listPrice: 10
                  - startDateUtc: '2016-04-25T08:00:00+00:00'
                    endDateUtc: '2016-04-25T12:00:00+00:00'
                    listPrice: 10
                  - startDateUtc: '2016-04-25T12:01:00+00:00'
                    endDateUtc: '2016-04-25T18:00:00+00:00'
                    listPrice: 10
                  - startDateUtc: '2016-04-26T08:00:00+0

# --- truncated at 32 KB (35 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vtex/refs/heads/main/openapi/vtex-sla-api-openapi.yml