{
  "opencollection": "1.0.0",
  "info": {
    "name": "VTex Anti-fraud Provider Account Delivery Services API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Delivery Services",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "VTex Get Delivery Services List",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/services",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "status",
                "value": "",
                "type": "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"
              },
              {
                "name": "dateInit",
                "value": "",
                "type": "query",
                "description": "Initial date of registration of the requested service. The date format is `yyyy-mm-dd`."
              },
              {
                "name": "dateEnd",
                "value": "",
                "type": "query",
                "description": "End date of registration of the requested service. The date format is `yyyy-mm-dd`.\n\r\n\rMake sure that the period of time between `dateInit` and `dateEnd` is not greater than 30 days."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of items shown per consultation page. The default is 25"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The consultation's desired page"
              }
            ]
          },
          "docs": "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.\r\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 overal"
        },
        {
          "info": {
            "name": "VTex Post Delivery Service",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/services",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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. \r\n\r\n### Request body example\r\n\r\n```json\r\n[\r\n    {\r\n        \"deliveryServiceType\": \"Entrega\",\r\n        \"shipperCustomer\": {\r\n            \"legalType\": \"PJ\",\r\n            \"companyName\": \"COMP. BRAS. DE TECN. PARA E-COMMERCE\",\r\n            \"cnpj\": \"05314972000174\",\r\n            \"addressStreet\": \"Rua Praia de Botafogo\",\r\n            \"ad"
        },
        {
          "info": {
            "name": "VTex Remove Packing List",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{providerApiEndpoint}/services",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Removes Packing List on your VTEX Tracking configuration. Your request body must contain the invoice and serie fields."
        },
        {
          "info": {
            "name": "VTex Get Delivery Service by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/services/:idDeliveryService",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "idDeliveryService",
                "value": "",
                "type": "path",
                "description": "The delivery service's unique identifier"
              }
            ]
          },
          "docs": "Retrieves a specific Service's general information by searching through its ID. \r\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."
        },
        {
          "info": {
            "name": "VTex Get Delivery Services List by Route",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/services/routes",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Current status of the delivery service. Includes the following statuses as possible values: Ativo, Roteirizado, Realizado, EmAndamento, NaoRealizado"
              },
              {
                "name": "dateInit",
                "value": "",
                "type": "query",
                "description": "Initial date of registration of the requested service. The date format is `yyyy-mm-dd`."
              },
              {
                "name": "dateEnd",
                "value": "",
                "type": "query",
                "description": "End date of registration of the requested service. The date format is `yyyy-mm-dd`.\n\r\n\rMake sure that the period of time between `dateInit` and `dateEnd` is not greater than 30 days."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of items shown per consultation page. The default is 25"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The desired page for the consultation"
              }
            ]
          },
          "docs": "This endpoint retrieves a list of Delivery Services by Route Item Date Async.\r\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."
        },
        {
          "info": {
            "name": "VTex Post Delivery Service With Route Scheduling",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/services/routes",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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.\r\n\r\n ### Request body example\r\n\r\n```json\r\n[\r\n\t{\r\n\t\t\"deliveryServiceRoute\": {\r\n\t\t\t\"deliveryServiceDate\": \"2020-09-28\",\r\n\t\t\t\"displacementType\": \"Caminhão\",\r\n\t\t\t\"carrier\": {\r\n\t\t\t\t\"username\": \"empresa-joao.silva\"\r\n\t\t\t},\r\n\t\t\t\"vehicle\": {\r\n\t\t\t\t\"registrationPlate\": \"XPT-0123\"\r\n\t\t\t},\r\n\t\t\t\"addressStart\": {\r\n\t\t\t\t\"addressStre"
        },
        {
          "info": {
            "name": "VTex Get Delivery Service by Invoice",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/services/invoice",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "invoice",
                "value": "",
                "type": "query",
                "description": "Invoice code"
              }
            ]
          },
          "docs": "This endpoint retrieves a given Service's information by filtering through the chosen invoice number.\r\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."
        }
      ]
    }
  ],
  "bundled": true
}