VTEX Delivery Services API

openapi: 3.2.0
info:
  title: VTEX Tracking Delivery Services API
  description: '

    This API is only available in our Brazilian operation, for VTEX Tracking customers. The APIs are used for consulting and registering services in the VTEX Tracking system.


    > We have unified our VTEX Tracking APIs into a single version, so it''s no longer necessary to specify the version on the URL. We have also translated all paths to english. Check out our [release notes](https://developers.vtex.com/updates/release-notes/vtex-tracking-api-changes-in-all-paths) to know more about the changes.\n\nThe previous paths were not deprecated, and are still being maintained by the VTEX Tracking team. If your business'' integration was built with the previous `v1` and `v1.1` endpoints, it will still run smoothly. No changes in your integrations should be done during critical periods. We will communicate any updates, and deprecations of endpoints in the future.


    >⚠️ We recommend that customers call our GET endpoints only once in every 6 hours. We do not recommend, and consider as a bad practice, to retrieve data from the same endpoint more than once during a 6-hour window. This represents a major load to our API that will slow down the overall usage of our systems.


    ## Index


    ### Authentication


    Acquire the mandatory authentication to access the VTEX Tracking endpoints.


    `POST` [Asynchronous Login](https://developers.vtex.com/vtex-developer-docs/reference/vtex-tracking-api-authentication)


    ### Delivery Services


    Operate all VTEX Tracking Delivery Services funcionalities.


    `POST` [Post Delivery Service](https://developers.vtex.com/vtex-rest-api/reference/post-delivery-service)

    `GET` [Get Delivery Services List](https://developers.vtex.com/vtex-rest-api/reference/get-delivery-service-list)

    `GET` [Get Delivery Service by ID](https://developers.vtex.com/vtex-rest-api/reference/get-delivery-service-by-id)

    `POST` [Post Delivery Service With Route Scheduling](https://developers.vtex.com/vtex-rest-api/reference/post-delivery-service-route-scheduling)

    `GET` [Get Delivery Services List by Route](https://developers.vtex.com/vtex-rest-api/reference/get-delivery-service-list-by-route)

    `GET` [Get Delivery Service by Invoice](https://developers.vtex.com/vtex-rest-api/reference/get-delivery-service-list-by-invoice)'
  contact:
    name: VTEX Tracking
    url: https://vtex.com/br-pt/tracking/
    email: suportetracking@vtex.com.br
  version: '1.1'
servers:
- url: https://api.vtextracking.com/receiver
  variables:
    api.vtextracking.com:
      default: api.vtextracking.com
tags:
- name: Delivery Services
paths:
  /services:
    put:
      tags:
      - Delivery Services
      summary: VTex Remove Packing List
      description: Removes Packing List on your VTEX Tracking configuration. Your request body must contain the invoice and serie fields.
      security:
      - Authorization:
        - Bearer {token}
      parameters:
      - name: Content-Type
        in: header
        description: Type of the content being sent
        required: true
        style: simple
        schema:
          type: string
          default: application/json
      - 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:
        description: ''
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/InvoiceFilter'
      responses:
        '200':
          description: Success
          headers: {}
      deprecated: false
    post:
      tags:
      - Delivery Services
      summary: VTex Post Delivery Service
      description: "Creates a delivery service in your Tracking system. It allows the user to configure the Route Scheduling services, without defining the Delivery Person or Route Date. \n\n### Request body example\n\n```json\n[\n    {\n        \"deliveryServiceType\": \"Entrega\",\n        \"shipperCustomer\": {\n            \"legalType\": \"PJ\",\n            \"companyName\": \"COMP. BRAS. DE TECN. PARA E-COMMERCE\",\n            \"cnpj\": \"05314972000174\",\n            \"addressStreet\": \"Rua Praia de Botafogo\",\n            \"addressNumber\": \"300\",\n            \"addressComplement\": \"SL\",\n            \"addressNeighborhood\": \"Botafogo\",\n            \"addressCity\": \"Rio de Janeiro\",\n            \"postalCode\": \"22250040\",\n            \"state\": \"RJ\",\n            \"phoneAreaCode\": \"21\",\n            \"phoneNumber\": \"999999999\"\n            },\n        \"invoiceOrderOfService\": \"123456\",\n        \"invoiceOrderOfServiceSerie\": \"2\",\n        \"orderNumber\": \"987654321\"\n    },\n    {\n        \"deliveryServiceType\": \"Entrega\",\n        \"shipperCustomer\": {\n            \"legalType\": \"PF\",\n            \"firstName\": \"Pedro\",\n            \"lastName\": \"Silva\",\n            \"cpf\": \"90498365778\",\n            \"addressStreet\": \"Rua Praia de Botafogo\",\n            \"addressNumber\": \"300\",\n            \"addressComplement\": \"SL\",\n            \"addressNeighborhood\": \"Botafogo\",\n            \"addressCity\": \"Rio de Janeiro\",\n            \"postalCode\": \"22250040\",\n            \"state\": \"RJ\",\n            \"phoneAreaCode\": \"21\",\n            \"phoneNumber\": \"999999999\"\n            },\n        \"invoiceOrderOfService\": \"123457\",\n        \"invoiceOrderOfServiceSerie\": \"2\",\n        \"orderNumber\": \"987654322\"\n    }\n]\n```"
      security:
      - Authorization: []
      parameters:
      - name: Content-Type
        in: header
        description: Type of the content being sent
        required: true
        style: simple
        schema:
          type: string
          default: application/json
      - 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:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeliveryService'
        required: true
      responses:
        '200':
          description: Success
          headers: {}
        '400':
          description: Bad Request
      deprecated: false
    get:
      tags:
      - Delivery Services
      summary: VTex Get Delivery Services List
      description: 'Retrieves a list of services with pagination and URLs. You can consult the list using the following filters: the service''s registration date, status, page size, and desired number of pages. Check the parameters documented below to see each filter''s description.

        > We strongly recommend that a call to a VTEX Tracking GET endpoint is made only once every 6 hours. Retrieving data from the same endpoint more than once during a 6-hour window represents a load to our API that will slow down the overall usage of systems.'
      security:
      - Authorization: []
      parameters:
      - name: Content-Type
        in: header
        description: Type of the content being sent
        required: true
        style: simple
        schema:
          type: string
          default: application/json
      - 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
      - name: status
        in: query
        description: 'Current status of the delivery service. The status parameters are not case sensitive, you can write them with upper or lower case. This field includes the following statuses as possible values: Ativo, Roteirizado, Realizado, EmAndamento, NaoRealizado'
        style: form
        schema:
          type: string
          default: Ativo
      - name: dateInit
        in: query
        description: Initial date of registration of the requested service. The date format is `yyyy-mm-dd`.
        style: form
        schema:
          type: string
          format: date
          example: '2023-07-28'
      - name: dateEnd
        in: query
        description: 'End date of registration of the requested service. The date format is `yyyy-mm-dd`.


          Make sure that the period of time between `dateInit` and `dateEnd` is not greater than 30 days.'
        style: form
        schema:
          type: string
          format: date
          example: '2023-07-29'
      - name: pageSize
        in: query
        description: Number of items shown per consultation page. The default is 25
        style: form
        schema:
          type: integer
          format: int32
          default: 40
      - name: page
        in: query
        description: The consultation's desired page
        style: form
        schema:
          type: integer
          format: int32
          default: 1
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginationResultDeliveryServiceResponsev11'
        '400':
          description: Bad Request
        '404':
          description: Not Found
      deprecated: false
  /services/{idDeliveryService}:
    get:
      tags:
      - Delivery Services
      summary: VTex Get Delivery Service by ID
      description: "Retrieves a specific Service's general information by searching through its ID. \n> We strongly recommend that a call to a VTEX Tracking GET endpoint is made only once every 6 hours. Retrieving data from the same endpoint more than once during a 6-hour window represents a load to our API that will slow down the overall usage of systems."
      security:
      - Authorization: []
      parameters:
      - name: Content-Type
        in: header
        description: Type of the content being sent
        required: true
        style: simple
        schema:
          type: string
          default: application/json
      - 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
      - name: idDeliveryService
        in: path
        description: The delivery service's unique identifier
        required: true
        style: simple
        schema:
          type: integer
          default: 1
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryServiceResponse_v1_1'
  /services/routes:
    post:
      tags:
      - Delivery Services
      summary: VTex Post Delivery Service With Route Scheduling
      operationId: PostDeliveryServiceWithRouteAsync
      description: "This endpoint creates a delivery service in your Tracking system. It allows the user to configure the Route Scheduling services with the Delivery Person and Route date already defined.\n\n ### Request body example\n\n```json\n[\n\t{\n\t\t\"deliveryServiceRoute\": {\n\t\t\t\"deliveryServiceDate\": \"2020-09-28\",\n\t\t\t\"displacementType\": \"Caminhão\",\n\t\t\t\"carrier\": {\n\t\t\t\t\"username\": \"empresa-joao.silva\"\n\t\t\t},\n\t\t\t\"vehicle\": {\n\t\t\t\t\"registrationPlate\": \"XPT-0123\"\n\t\t\t},\n\t\t\t\"addressStart\": {\n\t\t\t\t\"addressStreet\": \"Avenida das Américas\",\n\t\t\t\t\"addressNumber\": \"5000\",\n\t\t\t\t\"addressCity\": \"Rio de Janeiro\",\n\t\t\t\t\"postalCode\": \"22640102\",\n\t\t\t\t\"state\": \"RJ\"\n\t\t\t}\n\t\t},\n\t\t\"deliveryService\": [\n\t\t\t{\n\t\t\t\t\"deliveryServiceType\": \"Entrega\",\n\t\t\t\t\"shipperCustomer\": {\n\t\t\t\t\t\"legalType\": \"PJ\",\n\t\t\t\t\t\"companyName\": \"COMP. BRAS. DE TECN. PARA E-COMMERCE\",\n\t\t\t\t\t\"cnpj\": \"05314972000174\",\n\t\t\t\t\t\"addressStreet\": \"Rua Praia de Botafogo\",\n\t\t\t\t\t\"addressNumber\": \"300\",\n\t\t\t\t\t\"addressComplement\": \"SL\",\n\t\t\t\t\t\"addressNeighborhood\": \"Botafogo\",\n\t\t\t\t\t\"addressCity\": \"Rio de Janeiro\",\n\t\t\t\t\t\"postalCode\": \"22250040\",\n\t\t\t\t\t\"state\": \"RJ\",\n\t\t\t\t\t\"phoneAreaCode\": \"21\",\n\t\t\t\t\t\"phoneNumber\": \"999999999\"\n\t\t\t\t},\n\t\t\t\t\"invoiceOrderOfService\": \"123456\",\n\t\t\t\t\"invoiceOrderOfServiceSerie\": \"2\",\n\t\t\t\t\"orderNumber\": \"987654321\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"deliveryServiceType\": \"Entrega\",\n\t\t\t\t\"shipperCustomer\": {\n\t\t\t\t\t\"legalType\": \"PF\",\n\t\t\t\t\t\"firstName\": \"Pedro\",\n\t\t\t\t\t\"lastName\": \"Silva\",\n\t\t\t\t\t\"cpf\": \"90498365778\",\n\t\t\t\t\t\"addressStreet\": \"Rua Praia de Botafogo\",\n\t\t\t\t\t\"addressNumber\": \"300\",\n\t\t\t\t\t\"addressComplement\": \"SL\",\n\t\t\t\t\t\"addressNeighborhood\": \"Botafogo\",\n\t\t\t\t\t\"addressCity\": \"Rio de Janeiro\",\n\t\t\t\t\t\"postalCode\": \"22250040\",\n\t\t\t\t\t\"state\": \"RJ\",\n\t\t\t\t\t\"phoneAreaCode\": \"21\",\n\t\t\t\t\t\"phoneNumber\": \"999999999\"\n\t\t\t\t},\n\t\t\t\t\"invoiceOrderOfService\": \"123457\",\n\t\t\t\t\"invoiceOrderOfServiceSerie\": \"2\",\n\t\t\t\t\"orderNumber\": \"987654322\"\n\t\t\t}\n\t\t]\n\t}\n]\n```"
      security:
      - Authorization: []
      parameters:
      - name: Content-Type
        in: header
        description: Type of the content being sent
        required: true
        style: simple
        schema:
          type: string
          default: application/json
      - 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:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostWithRoute'
        required: true
      responses:
        '200':
          description: Success
          headers: {}
      deprecated: false
    get:
      tags:
      - Delivery Services
      summary: VTex Get Delivery Services List by Route
      description: 'This endpoint retrieves a list of Delivery Services by Route Item Date Async.

        > We strongly recommend that a call to a VTEX Tracking GET endpoint is made only once every 6 hours. Retrieving data from the same endpoint more than once during a 6-hour window represents a load to our API that will slow down the overall usage of systems.'
      security:
      - Authorization: []
      parameters:
      - name: Content-Type
        in: header
        description: Type of the content being sent
        required: true
        style: simple
        schema:
          type: string
          default: application/json
      - 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
      - name: status
        in: query
        description: 'Current status of the delivery service. Includes the following statuses as possible values: Ativo, Roteirizado, Realizado, EmAndamento, NaoRealizado'
        style: form
        schema:
          type: string
          default: Ativo
      - name: dateInit
        in: query
        description: Initial date of registration of the requested service. The date format is `yyyy-mm-dd`.
        style: form
        schema:
          type: string
          format: date
          example: '2023-07-28'
      - name: dateEnd
        in: query
        description: 'End date of registration of the requested service. The date format is `yyyy-mm-dd`.


          Make sure that the period of time between `dateInit` and `dateEnd` is not greater than 30 days.'
        style: form
        schema:
          type: string
          format: date
          example: '2023-07-29'
      - name: pageSize
        in: query
        description: Number of items shown per consultation page. The default is 25
        style: form
        schema:
          type: integer
          format: int32
          default: 40
      - name: page
        in: query
        description: The desired page for the consultation
        style: form
        schema:
          type: integer
          format: int32
          default: 1
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginationResultDeliveryServiceResponsev11'
        '400':
          description: Bad Request
        '404':
          description: Not Found
  /services/invoice:
    get:
      tags:
      - Delivery Services
      summary: VTex Get Delivery Service by Invoice
      description: 'This endpoint retrieves a given Service''s information by filtering through the chosen invoice number.

        > We strongly recommend that a call to a VTEX Tracking GET endpoint is made only once every 6 hours. Retrieving data from the same endpoint more than once during a 6-hour window represents a load to our API that will slow down the overall usage of systems.'
      security:
      - Authorization: []
      parameters:
      - name: Content-Type
        in: header
        description: Type of the content being sent
        required: true
        style: simple
        schema:
          type: string
          default: application/json
      - 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
      - name: invoice
        in: query
        description: Invoice code
        style: form
        schema:
          type: string
          default: ''
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginationResultDeliveryServiceResponsev11'
        '400':
          description: Bad Request
        '404':
          description: Not Found
      deprecated: false
components:
  schemas:
    DeliveryService:
      title: DeliveryService
      type: array
      items:
        $ref: '#/components/schemas/DeliveryServiceObject'
    InvoiceFilter:
      title: Request body
      type: object
      properties:
        invoice:
          type: string
          description: Chosen invoice filter
          default: string
        serie:
          type: string
          description: Serie's number on the invoice
          default: string
    StateResponse:
      title: StateResponse
      type: object
      properties:
        name:
          type: string
        code:
          type: string
    Scheduling:
      title: Scheduling
      type: object
      properties:
        shipperCustomerSchedulingDateTime:
          type: string
          format: date-time
        shipperSchedulingDateTime:
          type: string
          format: date-time
        morningPeriod:
          type: boolean
        afternoonPeriod:
          type: boolean
        nightPeriod:
          type: boolean
        origin:
          type: integer
          format: int32
    NonDeliveryReasonResponse:
      title: NonDeliveryReasonResponse
      type: object
      properties:
        description:
          type: string
    DeliveryReasonResponse:
      title: DeliveryReasonResponse
      type: object
      properties:
        description:
          type: string
    DeliveryServiceObject:
      title: Delivery Service Object
      required:
      - deliveryServiceType
      - shipperCustomer
      type: object
      properties:
        deliveryServiceType:
          maxLength: 11
          minLength: 0
          type: string
        idExternalShipperCustomer:
          maxLength: 30
          minLength: 0
          type: string
        shipperCustomer:
          $ref: '#/components/schemas/ShipperCustomer'
        invoiceOrderOfService:
          type: string
        invoiceOrderOfServiceSerie:
          maxLength: 3
          minLength: 0
          type: string
        description:
          type: string
        sender:
          type: string
        cnpjShipperPartner:
          type: string
        orderNumber:
          maxLength: 200
          minLength: 0
          type: string
        deliveryServiceHighLighter:
          maxLength: 11
          minLength: 0
          type: string
        latitude:
          type: number
        longitude:
          type: number
        deliveryServiceScheduling:
          $ref: '#/components/schemas/Scheduling'
        cnpjcarrier:
          type: string
        cnpjbranch:
          type: string
        idExternal:
          maxLength: 30
          minLength: 0
          type: string
        idShippingCompany:
          type: integer
          format: int32
        packingList:
          maxLength: 50
          minLength: 0
          type: string
        packingListDateTime:
          type: string
          format: date-time
        integrationDateTime:
          type: string
          format: date-time
    PostWithRoute:
      title: PostWithRoute
      required:
      - deliveryServiceDate
      type: object
      properties:
        deliveryService:
          type: array
          items:
            $ref: '#/components/schemas/DeliveryService'
          description: ''
        deliveryServiceRoute:
          $ref: '#/components/schemas/DeliveryServiceRoute'
    ShippingCompanyResponse:
      title: ShippingCompanyResponse
      type: object
      properties:
        companyName:
          type: string
        trade:
          type: string
        cnpj:
          type: string
        companyContact:
          type: string
        telephoneArea:
          type: string
        telephone:
          type: string
        mobileArea:
          type: string
        mobile:
          type: string
        email:
          type: string
    DeliveryServiceResponse_v1_1:
      title: Delivery Service Response body _v1_1
      type: object
      properties:
        pictures:
          type: array
          items:
            type: string
          description: ''
        idDeliveryService:
          type: integer
          format: int32
        deliveryServiceType:
          $ref: '#/components/schemas/DeliveryServiceTypeResponse'
        deliveryServiceStatus:
          $ref: '#/components/schemas/DeliveryServiceStatusResponse'
        shipper:
          $ref: '#/components/schemas/ShipperResponse'
        shipperCustomer:
          $ref: '#/components/schemas/ShipperCustomerResponse'
        carrier:
          $ref: '#/components/schemas/CarrierResponse'
        displacementType:
          $ref: '#/components/schemas/DisplacementTypeResponse'
        state:
          $ref: '#/components/schemas/StateResponse'
        country:
          $ref: '#/components/schemas/CountryResponse'
        nonDeliveryReason:
          $ref: '#/components/schemas/NonDeliveryReasonResponse'
        shipperPartner:
          $ref: '#/components/schemas/ShipperPartnerResponse'
        shipperBranch:
          $ref: '#/components/schemas/ShipperBranchResponse'
        freightPrice:
          $ref: '#/components/schemas/FreightPriceResponse'
        shippingCompany:
          $ref: '#/components/schemas/ShippingCompanyResponse'
        invoiceOrderOfService:
          type: string
        description:
          type: string
        addressStreet:
          type: string
        addressNumber:
          type: string
        addressComplement:
          type: string
        addressNeighborhood:
          type: string
        addressCity:
          type: string
        postalCode:
          type: string
        estimateDeliveryHour:
          type: string
          format: date-time
        created:
          type: string
          format: date-time
        initialEstimateDeliveryHour:
          type: string
          format: date-time
        deliveryDateTime:
          type: string
          format: date-time
        estimateDeliveryDistance:
          type: integer
          format: int32
        travelledDeliveryDistance:
          type: integer
          format: int32
        orderNumber:
          type: string
        cteNumber:
          type: string
        cteDate:
          type: string
          format: date-time
        sender:
          type: string
        senderCity:
          type: string
        senderState:
          type: integer
          format: int32
        weight:
          type: number
        cubicMeter:
          type: number
        cubicMeterWeight:
          type: number
        value:
          type: number
        freightPriceReceived:
          type: number
        deliveryAttempts:
          type: integer
          format: int32
        serviceTime:
          type: integer
          format: int32
        invoiceOrderOfServiceSerie:
          type: string
        leadTime:
          type: string
          format: date-time
        cnpjcarrier:
          type: string
        cnpjbranch:
          type: string
        idExternal:
          type: string
        billingInfo:
          type: array
          items:
            $ref: '#/components/schemas/BillingInfoResponse'
          description: ''
        deliveryServiceRouteItem:
          type: array
          items:
            $ref: '#/components/schemas/DeliveryServiceRouteItemResponse'
          description: ''
    ShipperTypeResponse:
      title: ShipperTypeResponse
      type: object
      properties:
        description:
          type: string
    DeliveryServiceRouteStatusResponse:
      title: DeliveryServiceRouteStatusResponse
      type: object
      properties:
        description:
          type: string
    CountryResponse:
      title: CountryResponse
      type: object
      properties:
        name:
          type: string
        code:
          type: string
    DeliveryServiceStatusResponse:
      title: DeliveryServiceStatusResponse
      type: object
      properties:
        description:
          type: string
    DeliveryServiceRoute:
      title: DeliveryServiceRoute
      required:
      - carrier
      - displacementType
      - deliveryServiceDate
      type: object
      properties:
        carrier:
          $ref: '#/components/schemas/Carrier'
        displacementType:
          maxLength: 15
          minLength: 0
          type: string
        vehicle:
          $ref: '#/components/schemas/Vehicle'
        deliveryServiceRouteTimeOfDay:
          maxLength: 10
          minLength: 0
          type: string
        deliveryServiceDate:
          type: string
          format: date-time
        idExternalRoute:
          maxLength: 50
          minLength: 0
          type: string
        itinerantDate:
          type: string
          format: date-time
        addressStart:
          $ref: '#/components/schemas/AddressStart'
    DeliveryServiceTypeResponse:
      title: DeliveryServiceTypeResponse
      type: object
      properties:
        description:
          type: string
    ShipperPartnerResponse:
      title: ShipperPartnerResponse
      type: object
      properties:
        cnpj:
          type: string
        name:
          type: string
    VehicleTypeResponse:
      title: VehicleTypeResponse
      type: object
      properties:
        description:
          type: string
    DeliveryServiceRouteResponse:
      title: DeliveryServiceRouteResponse
      type: object
      properties:
        idDeliveryServiceRoute:
          type: integer
          format: int32
        deliveryServiceRouteStatus:
          $ref: '#/components/schemas/DeliveryServiceRouteStatusResponse'
        deliveryServiceDate:
          type: string
          format: date-time
        created:
          type: string
          format: date-time
        startWorkDayDateTime:
          type: string
          format: date-time
        finishWorkDayDateTime:
          type: string
          format: date-time
        itinerantDate:
          type: string
          format: date-time
    ShipperResponse:
      title: ShipperResponse
      type: object
      properties:
        companyName:
          type: string
    FreightPriceResponse:
      title: FreightPriceResponse
      type: object
      properties:
        description:
          type: string
        firstPostalCodeInterval:
          type: string
        secondPostalCodeInterval:
          type: string
        price:
          type: number
        created:
          type: string
          format: date-time
    PaginationResultDeliveryServiceResponsev11:
      title: Pagination Result[Delivery Service Response _v1_1]
      type: object
      properties:
        page:
          type: integer
          format: int32
        pageSize:
          type: integer
          format: int32
        totalCount:
          type: integer
          format: int32
        data:
          type: array
          items:
            $ref: '#/components/schemas/DeliveryServiceResponse_v1_1'
          description: ''
    Vehicle:
      title: Vehicle
      type: object
      properties:
        registrationPlate:
          maxLength: 50
          minLength: 0
          type: string
    LegalTypeResponse:
      title: LegalTypeResponse
      type: object
      properties:
        description:
          type: string
    Carrier:
      title: Carrier
      required:
      - username
      type: object
      properties:
        username:
          maxLength: 100
          minLength: 0
          type: string
        firstName:
          maxLength: 100
          minLength: 0
          type: string
        lastName:
          maxLength: 100
          minLength: 0
          type: string
        cpf:
          maxLength: 14
          minLength: 0
          type: string
        email:
          maxLength: 254
          minLength: 0
          type: string
        mobileAreaCode:
          maxLength: 3
          minLength: 0
          type: string
        mobile:
          maxLength: 10
          minLength: 0
          type: string
        phoneAreaCode:
          maxLength: 3
          minLength: 0
          type: string
        phone:
          maxLength: 10
          minLength: 0
          type: string
        idExternalCarrier:
          maxLength: 30
          minLength: 0
          type: string
        rg:
          maxLength: 12
          minLength: 0
          type: string
        idShipperBranch:
          type: integer
          format: int32
        idShippingCompany:
          type: integer
          format: int32
    DisplacementTypeResponse:
      title: DisplacementTypeResponse
      type: object
      properties:
        description:
          type: string
        vehicleType:
          $ref: '#/components/schemas/VehicleTypeResponse'
    DeliveryServiceRouteItemResponse:
      title: DeliveryServiceRouteItemResponse
      type: object
      properties:
        idDeliveryServiceRouteItem:
          type: integer
          format: int32
        deliveryServiceRoute:
          $ref: '#/components/schemas/DeliveryServiceRouteResponse'
        deliveryServiceRouteItemStatus:
          $ref: '#/components/schemas/DeliveryServiceRouteItemStatusResponse'
        nonDeliveryDescription:
          type: string
        index:
          type: integer
          format: int32
        created:
          type: string
          format: date-time
        startDisplacementDateTime:
          type: string
          format: date-time
        startDisplacementLatitude:
          type: number
        startDisplacementLongitude:
          type: number
        finishedDisplacementLatitude:
          type: number
        finishedDisplacementLongitude:
          type: number
        receiverName:
          type: string
        receiverDocument:
          type: string
        description:
          type: string
        deliveryArrived:
          type: string
          fo

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