{ "openapi": "3.0.0", "info": { "title": "VTEX Tracking API", "description": "This API allows consulting and registering services in the [VTEX Tracking](https://help.vtex.com/en/tutorial/vtex-tracking-overview--1uDRquVudbPuoK05MtbZGh) system. Its use is exclusive to VTEX Tracking customers and is only available for Brazilian operations.\r\n\r\n> We have unified our VTEX Tracking API endpoints 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. The 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 deprecation of endpoints in the future.\r\n\r\n>⚠️ 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.\r\n\r\n## Common parameters\r\n\r\n| **Parameter name** | **Description** | **Type** |\r\n| --- | --- | :--- |\r\n| `{{accountName}}` | Name of the VTEX account. Used as part of the URL. | Server variable. |\r\n| `{{environment}}` | Environment to use. Used as part of the URL. The default value is `vtexcommercestable`. | Server variable. |\r\n| `X-VTEX-API-AppKey` | Unique identifier of the [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys). | Authentication header. Must be used together with `X-VTEX-API-AppToken`. Not necessary when using `VtexIdclientAutCookie`. |\r\n| `X-VTEX-API-AppToken` | Secret token of the [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys). | Authentication header. Must be used together with X-VTEX-API-AppKey. Not necessary when using `VtexIdclientAutCookie`. |\r\n| `VtexIdclientAutCookie` | [User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours. | Authentication header. Not necessary when using `X-VTEX-API-AppKey` and `X-VTEX-API-AppToken`. |", "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" } ], "paths": { "/auth": { "post": { "tags": [ "Authentication" ], "summary": "Asynchronous login", "description": "This endpoint permits the user to acquire the mandatory authentication to access the [VTEX Tracking](https://help.vtex.com/en/tutorial/vtex-tracking-overview--1uDRquVudbPuoK05MtbZGh) endpoints. \r\n> There is a single version of VTEX Tracking API, so it is no longer necessary to specify the version on the URL, as explained in this [release note](https://developers.vtex.com/updates/release-notes/vtex-tracking-api-changes-in-all-paths). The previous routes were not deprecated and can still be used, and if there is a breaking change, it will be informed.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).", "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "username", "password" ], "properties": { "username": { "type": "string", "description": "Add client's username.", "example": "clientUserName" }, "password": { "type": "string", "description": "Add client's password.", "example": "32gv34fs" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "authenticated": { "type": "boolean", "description": "If the authentication was successful (`true`) or not (`false`)." }, "created": { "type": "string", "description": "Creation date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." }, "expiration": { "type": "string", "description": "Expiration date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." }, "accessToken": { "type": "string", "description": "Acess token." }, "message": { "type": "string", "description": "Authentication message." } } }, "example": { "authenticated": true, "created": "2024-04-11T09:14:41.3695207Z", "expiration": "2024-05-11T09:14:41.3695207Z", "accessToken": "32985745", "message": "Authenticated" } } } }, "401": { "description": "Unauthorized" } } } }, "/services": { "put": { "tags": [ "Delivery services" ], "summary": "Remove packing list", "description": "Removes Packing List on your VTEX Tracking configuration. Your request body must contain the invoice and serie fields.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).", "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "Service information.", "properties": { "invoice": { "type": "string", "description": "Chosen invoice filter.", "example": "string" }, "serie": { "type": "string", "description": "Serie's number on the invoice.", "example": "string" } } } } } } }, "responses": { "200": { "description": "Success", "headers": {} } } }, "post": { "tags": [ "Delivery services" ], "summary": "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. \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 \"addressNumber\": \"300\",\r\n \"addressComplement\": \"SL\",\r\n \"addressNeighborhood\": \"Botafogo\",\r\n \"addressCity\": \"Rio de Janeiro\",\r\n \"postalCode\": \"22250040\",\r\n \"state\": \"RJ\",\r\n \"phoneAreaCode\": \"21\",\r\n \"phoneNumber\": \"999999999\"\r\n },\r\n \"invoiceOrderOfService\": \"123456\",\r\n \"invoiceOrderOfServiceSerie\": \"2\",\r\n \"orderNumber\": \"987654321\"\r\n },\r\n {\r\n \"deliveryServiceType\": \"Entrega\",\r\n \"shipperCustomer\": {\r\n \"legalType\": \"PF\",\r\n \"firstName\": \"Pedro\",\r\n \"lastName\": \"Silva\",\r\n \"cpf\": \"90498365778\",\r\n \"addressStreet\": \"Rua Praia de Botafogo\",\r\n \"addressNumber\": \"300\",\r\n \"addressComplement\": \"SL\",\r\n \"addressNeighborhood\": \"Botafogo\",\r\n \"addressCity\": \"Rio de Janeiro\",\r\n \"postalCode\": \"22250040\",\r\n \"state\": \"RJ\",\r\n \"phoneAreaCode\": \"21\",\r\n \"phoneNumber\": \"999999999\"\r\n },\r\n \"invoiceOrderOfService\": \"123457\",\r\n \"invoiceOrderOfServiceSerie\": \"2\",\r\n \"orderNumber\": \"987654322\"\r\n }\r\n]\r\n```\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).", "security": [ { "Authorization": [] } ], "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryService" } } } }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" } } }, "get": { "tags": [ "Delivery services" ], "summary": "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.\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.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).", "security": [ { "Authorization": [] } ], "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" }, { "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", "example": "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", "example": "2024-05-28" } }, { "name": "dateEnd", "in": "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.", "style": "form", "schema": { "type": "string", "example": "2024-05-29" } }, { "name": "pageSize", "in": "query", "description": "Number of items shown per consultation page. The default is `25`.", "style": "form", "schema": { "type": "integer", "example": 40 } }, { "name": "page", "in": "query", "description": "The consultation's desired page.", "style": "form", "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginationResultDeliveryServiceResponsev11" }, "example": { "page": 1, "pageSize": 1, "totalCount": 1, "data": [ { "pictures": [ "https://lojadobreno.vteximg.com.br/arquivos/ids/155467-292-292/image-5d7ad76ad1954c53adecab4138319034.jpg?v=637321899584500000", "https://lojadobreno.vteximg.com.br/arquivos/ids/155467-292-292/image-5d7ad76ad1954c53adecab4138319034.jpg?v=5435795425346573450" ], "idDeliveryService": 2878267, "deliveryServiceType": { "description": "Entrega" }, "deliveryServiceStatus": { "description": "Ativo" }, "shipper": { "companyName": "My Example Store" }, "shipperCustomer": { "idShipperCustomer": 2766024, "email": "expedicao@bramamateriais.com.br", "firstName": "Clark", "lastName": "Kent", "cpf": "12345678900", "addressStreet": "R. Dr. Manoel Normando Lima", "addressNumber": "25", "addressComplement": "Apartment 3058", "addressNeighborhood": "Downtown", "addressCity": "Curitiba", "postalCode": "57072710", "state": { "name": "Alagoas", "code": "AL" }, "country": { "name": "Brasil", "code": "BR" }, "created": "2024-06-17T17:04:07.457", "companyName": "Gil", "cnpj": "20212790000186", "legalType": { "description": "PJ" }, "idExternalShipperCustomer": "123456abc", "phoneAreaCode": "11", "phoneNumber": "97238885" }, "carrier": { "username": "clark_kent", "firstName": "Clark", "lastName": "Kent", "cpf": "61266367080", "email": "clark_kent@examplemail.com", "cnpjtransportCompany": "20212790000186", "mobileAreaCode": "11", "mobile": "78244657", "phoneAreaCode": "11", "phone": "55558898", "created": "2020-07-15T10:30:00Z", "idExternalCarrier": "123456789-abc", "isCarrierAppOnline": true, "shippingCompany": { "companyName": "Fast Shipz", "trade": "Shipping goods", "cnpj": "55912377000109", "companyContact": "Lois Lane", "telephoneArea": "11", "telephone": "55447799", "mobileArea": "11", "mobile": "77889922", "email": "lois_lane@fastshipz.com" }, "rg": "199178744" }, "displacementType": { "description": "moto", "vehicleType": { "description": "Motorcycle" } }, "state": { "name": "Alagoas", "code": "AL" }, "country": { "name": "Brasil", "code": "BR" }, "nonDeliveryReason": { "description": "Nobody answered the door." }, "shipperPartner": { "cnpj": "98269947000105", "name": "partner shipz" }, "shipperBranch": { "shipperType": { "description": "Urban transport." }, "companyName": "Great shipz", "trade": "Transport of goods.", "cnpj": "57972034000165", "companyContact": "Lois Lane", "telephoneArea": "11", "telephone": "22113355", "mobileArea": "11", "mobile": "77885511", "email": "lois_lane@greatshipz.com" }, "freightPrice": { "description": "Freight price for neighborhood Cidade Universitária.", "firstPostalCodeInterval": "60530000", "secondPostalCodeInterval": "60539999", "price": 9.99, "created": "2022-07-15T10:30:00Z" }, "shippingCompany": { "companyName": "Fast Shipz", "trade": "Shipping goods", "cnpj": "55912377000109", "companyContact": "Lois Lane", "telephoneArea": "11", "telephone": "55447799", "mobileArea": "11", "mobile": "77889922", "email": "lois_lane@fastshipz.com" }, "invoiceOrderOfService": "73893", "description": "Leave it at the reception", "addressStreet": "R. Dr. Manoel Normando Lima", "addressNumber": "25", "addressComplement": "apartment 3058", "addressNeighborhood": "Downtown", "addressCity": "Curitiba", "postalCode": "57582000", "estimateDeliveryHour": "2024-07-18T10:30:00Z", "created": "2024-07-02T18:41:01.933", "initialEstimateDeliveryHour": "2024-07-18T10:30:00Z", "deliveryDateTime": "2024-07-18T10:30:00Z", "estimateDeliveryDistance": 40, "travelledDeliveryDistance": 40, "orderNumber": "839748", "cteNumber": "123456789", "cteDate": "2024-07-02T10:30:00Z", "sender": "Sports store", "senderCity": "Curitiba", "senderState": 11, "weight": 430, "cubicMeter": 0.5, "cubicMeterWeight": 430, "value": 150.75, "freightPriceReceived": 9.99, "deliveryAttempts": 2, "serviceTime": 60, "invoiceOrderOfServiceSerie": "457", "leadTime": "2024-07-20T15:00:00Z", "cnpjcarrier": "12345678000195", "cnpjbranch": "98765432000100", "idExternal": "EXT123456", "billingInfo": [ { "receivableAmount": 150.75, "money": 50.00, "cheque": 0.00, "creditCard": 100.75, "webComment": "Payment received in full.", "carrierComment": "Customer paid with credit card.", "billingConfirmDate": "2024-07-15T14:00:00Z", "created": "2024-07-15T12:00:00Z" } ], "deliveryServiceRouteItem": [ { "idDeliveryServiceRouteItem": 1, "deliveryServiceRoute": { "idDeliveryServiceRoute": 101, "deliveryServiceRouteStatus": { "description": "In transit" }, "deliveryServiceDate": "2024-07-20T10:00:00", "created": "2024-07-10T08:00:00", "startWorkDayDateTime": "2024-07-20T08:00:00", "finishWorkDayDateTime": "2024-07-20T18:00:00", "itinerantDate": "2024-07-20T10:00:00" }, "deliveryServiceRouteItemStatus": { "description": "Completed" }, "nonDeliveryDescription": "N/A", "index": 1, "created": "2024-07-15T12:00:00", "startDisplacementDateTime": "2024-07-20T09:00:00", "startDisplacementLatitude": -23.55052, "startDisplacementLongitude": -46.633308, "finishedDisplacementLatitude": -23.551520, "finishedDisplacementLongitude": -46.632308, "receiverName": "Jane Smith", "receiverDocument": "ID123456789", "description": "Package delivered successfully.", "deliveryArrived": "2024-07-20T10:30:00", "comment": "Customer was satisfied with the delivery.", "rating": 5, "pauseDisplacementDateTime": "2024-07-20T10:00:00", "deliveryLeft": "2024-07-20T10:45:00", "deliveryReason": { "description": "Regular scheduled delivery." } } ] } ] } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } } } }, "/services/{idDeliveryService}": { "get": { "tags": [ "Delivery services" ], "summary": "Get delivery service by ID", "description": "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.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).", "security": [ { "Authorization": [] } ], "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" }, { "name": "idDeliveryService", "in": "path", "description": "The delivery service's unique identifier.", "required": true, "style": "simple", "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryServiceResponse_v1_1" }, "example": { "pictures": [ "https://lojadobreno.vteximg.com.br/arquivos/ids/155467-292-292/image-5d7ad76ad1954c53adecab4138319034.jpg?v=637321899584500000", "https://lojadobreno.vteximg.com.br/arquivos/ids/155467-292-292/image-5d7ad76ad1954c53adecab4138319034.jpg?v=5435795425346573450" ], "idDeliveryService": 2878267, "deliveryServiceType": { "description": "Entrega" }, "deliveryServiceStatus": { "description": "Ativo" }, "shipper": { "companyName": "My Example Store" }, "shipperCustomer": { "idShipperCustomer": 2766024, "email": "expedicao@bramamateriais.com.br", "firstName": "Clark", "lastName": "Kent", "cpf": "12345678900", "addressStreet": "R. Dr. Manoel Normando Lima", "addressNumber": "25", "addressComplement": "Apartment 3058", "addressNeighborhood": "Downtown", "addressCity": "Curitiba", "postalCode": "57072710", "state": { "name": "Alagoas", "code": "AL" }, "country": { "name": "Brasil", "code": "BR" }, "created": "2024-06-17T17:04:07.457", "companyName": "Gil", "cnpj": "20212790000186", "legalType": { "description": "PJ" }, "idExternalShipperCustomer": "123456abc", "phoneAreaCode": "11", "phoneNumber": "97238885" }, "carrier": { "username": "clark_kent", "firstName": "Clark", "lastName": "Kent", "cpf": "61266367080", "email": "clark_kent@examplemail.com", "cnpjtransportCompany": "20212790000186", "mobileAreaCode": "11", "mobile": "78244657", "phoneAreaCode": "11", "phone": "55558898", "created": "2020-07-15T10:30:00Z", "idExternalCarrier": "123456789-abc", "isCarrierAppOnline": true, "shippingCompany": { "companyName": "Fast Shipz", "trade": "Shipping goods", "cnpj": "55912377000109", "companyContact": "Lois Lane", "telephoneArea": "11", "telephone": "55447799", "mobileArea": "11", "mobile": "77889922", "email": "lois_lane@fastshipz.com" }, "rg": "199178744" }, "displacementType": { "description": "moto", "vehicleType": { "description": "Motorcycle" } }, "state": { "name": "Alagoas", "code": "AL" }, "country": { "name": "Brasil", "code": "BR" }, "nonDeliveryReason": { "description": "Nobody answered the door." }, "shipperPartner": { "cnpj": "98269947000105", "name": "partner shipz" }, "shipperBranch": { "shipperType": { "description": "Urban transport." }, "companyName": "Great shipz", "trade": "Transport of goods.", "cnpj": "57972034000165", "companyContact": "Lois Lane", "telephoneArea": "11", "telephone": "22113355", "mobileArea": "11", "mobile": "77885511", "email": "lois_lane@greatshipz.com" }, "freightPrice": { "description": "Freight price for neighborhood Cidade Universitária.", "firstPostalCodeInterval": "60530000", "secondPostalCodeInterval": "60539999", "price": 9.99, "created": "2022-07-15T10:30:00Z" }, "shippingCompany": { "companyName": "Fast Shipz", "trade": "Shipping goods", "cnpj": "55912377000109", "companyContact": "Lois Lane", "telephoneArea": "11", "telephone": "55447799", "mobileArea": "11", "mobile": "77889922", "email": "lois_lane@fastshipz.com" }, "invoiceOrderOfService": "73893", "description": "Leave it at the reception", "addressStreet": "R. Dr. Manoel Normando Lima", "addressNumber": "25", "addressComplement": "apartment 3058", "addressNeighborhood": "Downtown", "addressCity": "Curitiba", "postalCode": "57582000", "estimateDeliveryHour": "2024-07-18T10:30:00Z", "created": "2024-07-02T18:41:01.933", "initialEstimateDeliveryHour": "2024-07-18T10:30:00Z", "deliveryDateTime": "2024-07-18T10:30:00Z", "estimateDeliveryDistance": 40, "travelledDeliveryDistance": 40, "orderNumber": "839748", "cteNumber": "123456789", "cteDate": "2024-07-02T10:30:00Z", "sender": "Sports store", "senderCity": "Curitiba", "senderState": 11, "weight": 430, "cubicMeter": 0.5, "cubicMeterWeight": 430, "value": 150.75, "freightPriceReceived": 9.99, "deliveryAttempts": 2, "serviceTime": 60, "invoiceOrderOfServiceSerie": "457", "leadTime": "2024-07-20T15:00:00Z", "cnpjcarrier": "12345678000195", "cnpjbranch": "98765432000100", "idExternal": "EXT123456", "billingInfo": [ { "receivableAmount": 150.75, "money": 50.00, "cheque": 0.00, "creditCard": 100.75, "webComment": "Payment received in full.", "carrierComment": "Customer paid with credit card.", "billingConfirmDate": "2024-07-15T14:00:00Z", "created": "2024-07-15T12:00:00Z" } ], "deliveryServiceRouteItem": [ { "idDeliveryServiceRouteItem": 1, "deliveryServiceRoute": { "idDeliveryServiceRoute": 101, "deliveryServiceRouteStatus": { "description": "In transit" }, "deliveryServiceDate": "2024-07-20T10:00:00", "created": "2024-07-10T08:00:00", "startWorkDayDateTime": "2024-07-20T08:00:00", "finishWorkDayDateTime": "2024-07-20T18:00:00", "itinerantDate": "2024-07-20T10:00:00" }, "deliveryServiceRouteItemStatus": { "description": "Completed" }, "nonDeliveryDescription": "N/A", "index": 1, "created": "2024-07-15T12:00:00", "startDisplacementDateTime": "2024-07-20T09:00:00", "startDisplacementLatitude": -23.55052, "startDisplacementLongitude": -46.633308, "finishedDisplacementLatitude": -23.551520, "finishedDisplacementLongitude": -46.632308, "receiverName": "Jane Smith", "receiverDocument": "ID123456789", "description": "Package delivered successfully.", "deliveryArrived": "2024-07-20T10:30:00", "comment": "Customer was satisfied with the delivery.", "rating": 5, "pauseDisplacementDateTime": "2024-07-20T10:00:00", "deliveryLeft": "2024-07-20T10:45:00", "deliveryReason": { "description": "Regular scheduled delivery." } } ] } } } } } } }, "/services/routes": { "post": { "tags": [ "Delivery services" ], "summary": "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.\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\"addressStreet\": \"Avenida das Américas\",\r\n\t\t\t\t\"addressNumber\": \"5000\",\r\n\t\t\t\t\"addressCity\": \"Rio de Janeiro\",\r\n\t\t\t\t\"postalCode\": \"22640102\",\r\n\t\t\t\t\"state\": \"RJ\"\r\n\t\t\t}\r\n\t\t},\r\n\t\t\"deliveryService\": [\r\n\t\t\t{\r\n\t\t\t\t\"deliveryServiceType\": \"Entrega\",\r\n\t\t\t\t\"shipperCustomer\": {\r\n\t\t\t\t\t\"legalType\": \"PJ\",\r\n\t\t\t\t\t\"companyName\": \"COMP. BRAS. DE TECN. PARA E-COMMERCE\",\r\n\t\t\t\t\t\"cnpj\": \"05314972000174\",\r\n\t\t\t\t\t\"addressStreet\": \"Rua Praia de Botafogo\",\r\n\t\t\t\t\t\"addressNumber\": \"300\",\r\n\t\t\t\t\t\"addressComplement\": \"SL\",\r\n\t\t\t\t\t\"addressNeighborhood\": \"Botafogo\",\r\n\t\t\t\t\t\"addressCity\": \"Rio de Janeiro\",\r\n\t\t\t\t\t\"postalCode\": \"22250040\",\r\n\t\t\t\t\t\"state\": \"RJ\",\r\n\t\t\t\t\t\"phoneAreaCode\": \"21\",\r\n\t\t\t\t\t\"phoneNumber\": \"999999999\"\r\n\t\t\t\t},\r\n\t\t\t\t\"invoiceOrderOfService\": \"123456\",\r\n\t\t\t\t\"invoiceOrderOfServiceSerie\": \"2\",\r\n\t\t\t\t\"orderNumber\": \"987654321\"\r\n\t\t\t},\r\n\t\t\t{\r\n\t\t\t\t\"deliveryServiceType\": \"Entrega\",\r\n\t\t\t\t\"shipperCustomer\": {\r\n\t\t\t\t\t\"legalType\": \"PF\",\r\n\t\t\t\t\t\"firstName\": \"Pedro\",\r\n\t\t\t\t\t\"lastName\": \"Silva\",\r\n\t\t\t\t\t\"cpf\": \"90498365778\",\r\n\t\t\t\t\t\"addressStreet\": \"Rua Praia de Botafogo\",\r\n\t\t\t\t\t\"addressNumber\": \"300\",\r\n\t\t\t\t\t\"addressComplement\": \"SL\",\r\n\t\t\t\t\t\"addressNeighborhood\": \"Botafogo\",\r\n\t\t\t\t\t\"addressCity\": \"Rio de Janeiro\",\r\n\t\t\t\t\t\"postalCode\": \"22250040\",\r\n\t\t\t\t\t\"state\": \"RJ\",\r\n\t\t\t\t\t\"phoneAreaCode\": \"21\",\r\n\t\t\t\t\t\"phoneNumber\": \"999999999\"\r\n\t\t\t\t},\r\n\t\t\t\t\"invoiceOrderOfService\": \"123457\",\r\n\t\t\t\t\"invoiceOrderOfServiceSerie\": \"2\",\r\n\t\t\t\t\"orderNumber\": \"987654322\"\r\n\t\t\t}\r\n\t\t]\r\n\t}\r\n]\r\n```\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).", "security": [ { "Authorization": [] } ], "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "deliveryServiceDate" ], "type": "object", "properties": { "deliveryService": { "type": "array", "items": { "$ref": "#/components/schemas/DeliveryService" }, "description": "Delivery service array." }, "deliveryServiceRoute": { "required": [ "carrier", "displacementType", "deliveryServiceDate" ], "type": "object", "description": "Delivery service route information.", "properties": { "carrier": { "required": [ "username" ], "type": "object", "description": "Route carrier information.", "properties": { "username": { "maxLength": 100, "minLength": 0, "type": "string", "description": "The username of the user. This field can be used for login purposes and identification.", "example": "john_doe" }, "firstName": { "maxLength": 100, "minLength": 0, "type": "string", "description": "The first name of the user.", "example": "John" }, "lastName": { "maxLength": 100, "minLength": 0, "type": "string", "description": "The last name of the user.", "example": "Doe" }, "cpf": { "maxLength": 14, "minLength": 0, "type": "string", "description": "The CPF document number of the user.", "example": "12345678909" }, "email": { "maxLength": 254, "minLength": 0, "type": "string", "description": "The email address of the user.", "example": "john.doe@example.com" }, "mobileAreaCode": { "maxLength": 3, "minLength": 0, "type": "string", "description": "The area code for the user's mobile phone.", "example": "011" }, "mobile": { "maxLength": 10, "minLength": 0, "type": "string", "description": "The mobile phone number of the user.", "example": "987654321" }, "phoneAreaCode": { "maxLength": 3, "minLength": 0, "type": "string", "description": "The area code for the user's telephone.", "example": "011" }, "phone": { "maxLength": 10, "minLength": 0, "type": "string", "description": "The telephone number of the user.", "example": "123456789" }, "idExternalCarrier": { "maxLength": 30, "minLength": 0, "type": "string", "description": "An external identifier for the carrier associated with the user.", "example": "CARRIER12345" }, "rg": { "maxLength": 12, "minLength": 0, "type": "string", "description": "The RG document number of the user.", "example": "MG12345678" }, "idShipperBranch": { "type": "integer", "format": "int32", "description": "The unique identifier for the shipper branch associated with the user.", "example": 102 }, "idShippingCompany": { "type": "integer", "format": "int32", "description": "The unique identifier for the shipping company associated with the user.", "example": 203 } } }, "displacementType": { "maxLength": 15, "minLength": 0, "type": "string", "description": "Displacement type.", "example": "moto" }, "vehicle": { "type": "object", "description": "Vehicle information.", "properties": { "registrationPlate": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Vehicle registration plate.", "example": "CCC-9999" } } }, "deliveryServiceRouteTimeOfDay": { "maxLength": 10, "minLength": 0, "type": "string", "description": "The time of day for the delivery service route.", "example": "morning" }, "deliveryServiceDate": { "type": "string", "format": "date-time", "description": "The date and time when the delivery service is scheduled to occur.", "example": "2024-07-20T10:00:00Z" }, "idExternalRoute": { "maxLength": 50, "minLength": 0, "type": "string", "description": "An external identifier for the delivery service route.", "example": "ROUTE12345" }, "itinerantDate": { "type": "string", "format": "date-time", "description": "The date and time of the itinerant delivery service.", "example": "2024-07-20T12:00:00Z" }, "addressStart": { "type": "object", "description": "Address of the start of the delivery route.", "properties": { "addressStreet": { "type": "string", "description": "The street of the address.", "example": "Main St" }, "addressNumber": { "type": "string", "description": "The number of the building or house on the street.", "example": "456" }, "postalCode": { "type": "string", "description": "The postal code of the location, which is used for mail delivery purposes.", "example": "12345678" }, "addressCity": { "type": "string", "description": "The city in which the address is located.", "example": "São Paulo" }, "state": { "maxLength": 2, "minLength": 0, "type": "string", "description": "The state or province code where the address is located.", "example": "SP" } } } } } } } } } }, "responses": { "200": { "description": "Success", "headers": {} } } }, "get": { "tags": [ "Delivery services" ], "summary": "Get delivery services list by route", "description": "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.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).", "security": [ { "Authorization": [] } ], "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" }, { "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", "example": "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", "example": "2024-05-28" } }, { "name": "dateEnd", "in": "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.", "style": "form", "schema": { "type": "string", "example": "2024-06-15" } }, { "name": "pageSize", "in": "query", "description": "Number of items shown per consultation page. The default is `25`.", "style": "form", "schema": { "type": "integer", "example": 40 } }, { "name": "page", "in": "query", "description": "The desired page for the consultation.", "style": "form", "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginationResultDeliveryServiceResponsev11" }, "example": { "page": 1, "pageSize": 1, "totalCount": 1, "data": [ { "pictures": [ "https://lojadobreno.vteximg.com.br/arquivos/ids/155467-292-292/image-5d7ad76ad1954c53adecab4138319034.jpg?v=637321899584500000", "https://lojadobreno.vteximg.com.br/arquivos/ids/155467-292-292/image-5d7ad76ad1954c53adecab4138319034.jpg?v=5435795425346573450" ], "idDeliveryService": 2878267, "deliveryServiceType": { "description": "Entrega" }, "deliveryServiceStatus": { "description": "Ativo" }, "shipper": { "companyName": "My Example Store" }, "shipperCustomer": { "idShipperCustomer": 2766024, "email": "expedicao@bramamateriais.com.br", "firstName": "Clark", "lastName": "Kent", "cpf": "12345678900", "addressStreet": "R. Dr. Manoel Normando Lima", "addressNumber": "25", "addressComplement": "Apartment 3058", "addressNeighborhood": "Downtown", "addressCity": "Curitiba", "postalCode": "57072710", "state": { "name": "Alagoas", "code": "AL" }, "country": { "name": "Brasil", "code": "BR" }, "created": "2024-06-17T17:04:07.457", "companyName": "Gil", "cnpj": "20212790000186", "legalType": { "description": "PJ" }, "idExternalShipperCustomer": "123456abc", "phoneAreaCode": "11", "phoneNumber": "97238885" }, "carrier": { "username": "clark_kent", "firstName": "Clark", "lastName": "Kent", "cpf": "61266367080", "email": "clark_kent@examplemail.com", "cnpjtransportCompany": "20212790000186", "mobileAreaCode": "11", "mobile": "78244657", "phoneAreaCode": "11", "phone": "55558898", "created": "2020-07-15T10:30:00Z", "idExternalCarrier": "123456789-abc", "isCarrierAppOnline": true, "shippingCompany": { "companyName": "Fast Shipz", "trade": "Shipping goods", "cnpj": "55912377000109", "companyContact": "Lois Lane", "telephoneArea": "11", "telephone": "55447799", "mobileArea": "11", "mobile": "77889922", "email": "lois_lane@fastshipz.com" }, "rg": "199178744" }, "displacementType": { "description": "moto", "vehicleType": { "description": "Motorcycle" } }, "state": { "name": "Alagoas", "code": "AL" }, "country": { "name": "Brasil", "code": "BR" }, "nonDeliveryReason": { "description": "Nobody answered the door." }, "shipperPartner": { "cnpj": "98269947000105", "name": "partner shipz" }, "shipperBranch": { "shipperType": { "description": "Urban transport." }, "companyName": "Great shipz", "trade": "Transport of goods.", "cnpj": "57972034000165", "companyContact": "Lois Lane", "telephoneArea": "11", "telephone": "22113355", "mobileArea": "11", "mobile": "77885511", "email": "lois_lane@greatshipz.com" }, "freightPrice": { "description": "Freight price for neighborhood Cidade Universitária.", "firstPostalCodeInterval": "60530000", "secondPostalCodeInterval": "60539999", "price": 9.99, "created": "2022-07-15T10:30:00Z" }, "shippingCompany": { "companyName": "Fast Shipz", "trade": "Shipping goods", "cnpj": "55912377000109", "companyContact": "Lois Lane", "telephoneArea": "11", "telephone": "55447799", "mobileArea": "11", "mobile": "77889922", "email": "lois_lane@fastshipz.com" }, "invoiceOrderOfService": "73893", "description": "Leave it at the reception", "addressStreet": "R. Dr. Manoel Normando Lima", "addressNumber": "25", "addressComplement": "apartment 3058", "addressNeighborhood": "Downtown", "addressCity": "Curitiba", "postalCode": "57582000", "estimateDeliveryHour": "2024-07-18T10:30:00Z", "created": "2024-07-02T18:41:01.933", "initialEstimateDeliveryHour": "2024-07-18T10:30:00Z", "deliveryDateTime": "2024-07-18T10:30:00Z", "estimateDeliveryDistance": 40, "travelledDeliveryDistance": 40, "orderNumber": "839748", "cteNumber": "123456789", "cteDate": "2024-07-02T10:30:00Z", "sender": "Sports store", "senderCity": "Curitiba", "senderState": 11, "weight": 430, "cubicMeter": 0.5, "cubicMeterWeight": 430, "value": 150.75, "freightPriceReceived": 9.99, "deliveryAttempts": 2, "serviceTime": 60, "invoiceOrderOfServiceSerie": "457", "leadTime": "2024-07-20T15:00:00Z", "cnpjcarrier": "12345678000195", "cnpjbranch": "98765432000100", "idExternal": "EXT123456", "billingInfo": [ { "receivableAmount": 150.75, "money": 50.00, "cheque": 0.00, "creditCard": 100.75, "webComment": "Payment received in full.", "carrierComment": "Customer paid with credit card.", "billingConfirmDate": "2024-07-15T14:00:00Z", "created": "2024-07-15T12:00:00Z" } ], "deliveryServiceRouteItem": [ { "idDeliveryServiceRouteItem": 1, "deliveryServiceRoute": { "idDeliveryServiceRoute": 101, "deliveryServiceRouteStatus": { "description": "In transit" }, "deliveryServiceDate": "2024-07-20T10:00:00", "created": "2024-07-10T08:00:00", "startWorkDayDateTime": "2024-07-20T08:00:00", "finishWorkDayDateTime": "2024-07-20T18:00:00", "itinerantDate": "2024-07-20T10:00:00" }, "deliveryServiceRouteItemStatus": { "description": "Completed" }, "nonDeliveryDescription": "N/A", "index": 1, "created": "2024-07-15T12:00:00", "startDisplacementDateTime": "2024-07-20T09:00:00", "startDisplacementLatitude": -23.55052, "startDisplacementLongitude": -46.633308, "finishedDisplacementLatitude": -23.551520, "finishedDisplacementLongitude": -46.632308, "receiverName": "Jane Smith", "receiverDocument": "ID123456789", "description": "Package delivered successfully.", "deliveryArrived": "2024-07-20T10:30:00", "comment": "Customer was satisfied with the delivery.", "rating": 5, "pauseDisplacementDateTime": "2024-07-20T10:00:00", "deliveryLeft": "2024-07-20T10:45:00", "deliveryReason": { "description": "Regular scheduled delivery." } } ] } ] } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } } } }, "/services/invoice": { "get": { "tags": [ "Delivery services" ], "summary": "Get delivery service by invoice", "description": "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.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).", "security": [ { "Authorization": [] } ], "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" }, { "name": "invoice", "in": "query", "description": "Invoice code.", "style": "form", "schema": { "type": "string", "example": "24382" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginationResultDeliveryServiceResponsev11" }, "example": { "page": 1, "pageSize": 1, "totalCount": 1, "data": [ { "pictures": [ "https://lojadobreno.vteximg.com.br/arquivos/ids/155467-292-292/image-5d7ad76ad1954c53adecab4138319034.jpg?v=637321899584500000", "https://lojadobreno.vteximg.com.br/arquivos/ids/155467-292-292/image-5d7ad76ad1954c53adecab4138319034.jpg?v=5435795425346573450" ], "idDeliveryService": 2878267, "deliveryServiceType": { "description": "Entrega" }, "deliveryServiceStatus": { "description": "Ativo" }, "shipper": { "companyName": "My Example Store" }, "shipperCustomer": { "idShipperCustomer": 2766024, "email": "expedicao@bramamateriais.com.br", "firstName": "Clark", "lastName": "Kent", "cpf": "12345678900", "addressStreet": "R. Dr. Manoel Normando Lima", "addressNumber": "25", "addressComplement": "Apartment 3058", "addressNeighborhood": "Downtown", "addressCity": "Curitiba", "postalCode": "57072710", "state": { "name": "Alagoas", "code": "AL" }, "country": { "name": "Brasil", "code": "BR" }, "created": "2024-06-17T17:04:07.457", "companyName": "Gil", "cnpj": "20212790000186", "legalType": { "description": "PJ" }, "idExternalShipperCustomer": "123456abc", "phoneAreaCode": "11", "phoneNumber": "97238885" }, "carrier": { "username": "clark_kent", "firstName": "Clark", "lastName": "Kent", "cpf": "61266367080", "email": "clark_kent@examplemail.com", "cnpjtransportCompany": "20212790000186", "mobileAreaCode": "11", "mobile": "78244657", "phoneAreaCode": "11", "phone": "55558898", "created": "2020-07-15T10:30:00Z", "idExternalCarrier": "123456789-abc", "isCarrierAppOnline": true, "shippingCompany": { "companyName": "Fast Shipz", "trade": "Shipping goods", "cnpj": "55912377000109", "companyContact": "Lois Lane", "telephoneArea": "11", "telephone": "55447799", "mobileArea": "11", "mobile": "77889922", "email": "lois_lane@fastshipz.com" }, "rg": "199178744" }, "displacementType": { "description": "moto", "vehicleType": { "description": "Motorcycle" } }, "state": { "name": "Alagoas", "code": "AL" }, "country": { "name": "Brasil", "code": "BR" }, "nonDeliveryReason": { "description": "Nobody answered the door." }, "shipperPartner": { "cnpj": "98269947000105", "name": "partner shipz" }, "shipperBranch": { "shipperType": { "description": "Urban transport." }, "companyName": "Great shipz", "trade": "Transport of goods.", "cnpj": "57972034000165", "companyContact": "Lois Lane", "telephoneArea": "11", "telephone": "22113355", "mobileArea": "11", "mobile": "77885511", "email": "lois_lane@greatshipz.com" }, "freightPrice": { "description": "Freight price for neighborhood Cidade Universitária.", "firstPostalCodeInterval": "60530000", "secondPostalCodeInterval": "60539999", "price": 9.99, "created": "2022-07-15T10:30:00Z" }, "shippingCompany": { "companyName": "Fast Shipz", "trade": "Shipping goods", "cnpj": "55912377000109", "companyContact": "Lois Lane", "telephoneArea": "11", "telephone": "55447799", "mobileArea": "11", "mobile": "77889922", "email": "lois_lane@fastshipz.com" }, "invoiceOrderOfService": "73893", "description": "Leave it at the reception", "addressStreet": "R. Dr. Manoel Normando Lima", "addressNumber": "25", "addressComplement": "apartment 3058", "addressNeighborhood": "Downtown", "addressCity": "Curitiba", "postalCode": "57582000", "estimateDeliveryHour": "2024-07-18T10:30:00Z", "created": "2024-07-02T18:41:01.933", "initialEstimateDeliveryHour": "2024-07-18T10:30:00Z", "deliveryDateTime": "2024-07-18T10:30:00Z", "estimateDeliveryDistance": 40, "travelledDeliveryDistance": 40, "orderNumber": "839748", "cteNumber": "123456789", "cteDate": "2024-07-02T10:30:00Z", "sender": "Sports store", "senderCity": "Curitiba", "senderState": 11, "weight": 430, "cubicMeter": 0.5, "cubicMeterWeight": 430, "value": 150.75, "freightPriceReceived": 9.99, "deliveryAttempts": 2, "serviceTime": 60, "invoiceOrderOfServiceSerie": "457", "leadTime": "2024-07-20T15:00:00Z", "cnpjcarrier": "12345678000195", "cnpjbranch": "98765432000100", "idExternal": "EXT123456", "billingInfo": [ { "receivableAmount": 150.75, "money": 50.00, "cheque": 0.00, "creditCard": 100.75, "webComment": "Payment received in full.", "carrierComment": "Customer paid with credit card.", "billingConfirmDate": "2024-07-15T14:00:00Z", "created": "2024-07-15T12:00:00Z" } ], "deliveryServiceRouteItem": [ { "idDeliveryServiceRouteItem": 1, "deliveryServiceRoute": { "idDeliveryServiceRoute": 101, "deliveryServiceRouteStatus": { "description": "In transit" }, "deliveryServiceDate": "2024-07-20T10:00:00", "created": "2024-07-10T08:00:00", "startWorkDayDateTime": "2024-07-20T08:00:00", "finishWorkDayDateTime": "2024-07-20T18:00:00", "itinerantDate": "2024-07-20T10:00:00" }, "deliveryServiceRouteItemStatus": { "description": "Completed" }, "nonDeliveryDescription": "N/A", "index": 1, "created": "2024-07-15T12:00:00", "startDisplacementDateTime": "2024-07-20T09:00:00", "startDisplacementLatitude": -23.55052, "startDisplacementLongitude": -46.633308, "finishedDisplacementLatitude": -23.551520, "finishedDisplacementLongitude": -46.632308, "receiverName": "Jane Smith", "receiverDocument": "ID123456789", "description": "Package delivered successfully.", "deliveryArrived": "2024-07-20T10:30:00", "comment": "Customer was satisfied with the delivery.", "rating": 5, "pauseDisplacementDateTime": "2024-07-20T10:00:00", "deliveryLeft": "2024-07-20T10:45:00", "deliveryReason": { "description": "Regular scheduled delivery." } } ] } ] } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } } } } }, "components": { "securitySchemes": { "Authorization": { "type": "http", "scheme": "bearer", "description": "To use the endpoints, please login through the [Asynchronous login](https://developers.vtex.com/docs/api-reference/tracking#post-/auth) endpoint, and copy the access token in the response." } }, "parameters": { "Content-Type": { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, "Accept": { "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", "example": "application/json" } } }, "schemas": { "PaginationResultDeliveryServiceResponsev11": { "description": "Paginated delivery service response.", "type": "object", "properties": { "page": { "type": "integer", "format": "int32", "description": "Number of the page that was returned." }, "pageSize": { "type": "integer", "format": "int32", "description": "Number of items per returned page." }, "totalCount": { "type": "integer", "format": "int32", "description": "Total number of pages given the page size and total results." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DeliveryServiceResponse_v1_1" }, "description": "Array where each item contains information of a delivery service." } } }, "DeliveryService": { "type": "array", "description": "Array of delivery services.", "items": { "type": "object", "description": "Delivery service information.", "properties": { "deliveryServiceType": { "maxLength": 11, "minLength": 0, "type": "string", "description": "The type of delivery service being provided. The maximum length is 11 characters.", "example": "Express" }, "idExternalShipperCustomer": { "maxLength": 30, "minLength": 0, "type": "string", "description": "External identifier for the shipper customer. The maximum length is 30 characters.", "example": "EXT123456" }, "shipperCustomer": { "required": [ "legalType", "addressStreet", "postalCode" ], "type": "object", "description": "Shipper customer information.", "properties": { "legalType": { "maxLength": 2, "minLength": 2, "type": "string", "description": "The legal type of the shipper customer. It is a 2-character code representing the legal classification.", "example": "PF" }, "email": { "maxLength": 254, "minLength": 0, "type": "string", "description": "The email address of the shipper customer. The maximum length is 254 characters.", "example": "customer@example.com" }, "firstName": { "maxLength": 100, "minLength": 0, "type": "string", "description": "The first name of the shipper customer. The maximum length is 100 characters.", "example": "John" }, "lastName": { "maxLength": 100, "minLength": 0, "type": "string", "description": "The last name of the shipper customer. The maximum length is 100 characters.", "example": "Doe" }, "cpf": { "maxLength": 50, "minLength": 0, "type": "string", "description": "The CPF (Cadastro de Pessoas Físicas) number of the shipper customer. This is a unique identifier for individuals in Brazil.", "example": "12345678900" }, "addressStreet": { "maxLength": 150, "minLength": 0, "type": "string", "description": "The street address of the shipper customer. The maximum length is 150 characters.", "example": "Avenida Teodoro Sampaio" }, "addressNumber": { "maxLength": 50, "minLength": 0, "type": "string", "description": "The address number of the shipper customer. The maximum length is 50 characters.", "example": "456" }, "addressComplement": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Additional address information, such as apartment or suite number. The maximum length is 50 characters.", "example": "Apt 789" }, "addressNeighborhood": { "maxLength": 150, "minLength": 0, "type": "string", "description": "The neighborhood of the shipper customer's address. The maximum length is 150 characters.", "example": "Brás" }, "addressCity": { "maxLength": 100, "minLength": 0, "type": "string", "description": "The city of the shipper customer's address. The maximum length is 100 characters.", "example": "São Paulo" }, "postalCode": { "maxLength": 9, "minLength": 0, "type": "string", "description": "The postal code of the shipper customer's address. The maximum length is 9 characters.", "example": "12345-678" }, "state": { "maxLength": 2, "minLength": 2, "type": "string", "description": "The state code of the shipper customer's address. It is a 2-character code.", "example": "SP" }, "companyName": { "maxLength": 150, "minLength": 0, "type": "string", "description": "The name of the shipper customer's company. The maximum length is 150 characters.", "example": "ABC Corp" }, "cnpj": { "maxLength": 50, "minLength": 0, "type": "string", "description": "The CNPJ (Cadastro Nacional da Pessoa Jurídica) number of the shipper customer's company. This is a unique identifier for Brazilian companies.", "example": "12345678000195" }, "idExternalShipperCustomer": { "maxLength": 30, "minLength": 0, "type": "string", "description": "An external identifier for the shipper customer, used for integration with other systems. The maximum length is 30 characters.", "example": "EXT123456" }, "phoneAreaCode": { "maxLength": 3, "minLength": 0, "type": "string", "description": "The area code of the shipper customer's phone number. The maximum length is 3 characters.", "example": "11" }, "phoneNumber": { "maxLength": 12, "minLength": 0, "type": "string", "description": "The phone number of the shipper customer. The maximum length is 12 characters.", "example": "987654321" } } }, "invoiceOrderOfService": { "type": "string", "description": "The order of service associated with the invoice.", "example": "INV123456" }, "invoiceOrderOfServiceSerie": { "maxLength": 3, "minLength": 0, "type": "string", "description": "A series or batch identifier for the invoice order of service, with a maximum length of 3 characters.", "example": "A12" }, "description": { "type": "string", "description": "Description of the service or delivery. This field provides additional information about the order.", "example": "Delivery of electronics from warehouse to customer." }, "sender": { "type": "string", "description": "The name or identifier of the sender of the delivery.", "example": "John Doe" }, "cnpjShipperPartner": { "type": "string", "description": "The CNPJ of the shipper partner. This is a unique identifier for Brazilian companies.", "example": "12345678000195" }, "orderNumber": { "maxLength": 200, "minLength": 0, "type": "string", "description": "Order number.", "example": "987654321" }, "deliveryServiceHighLighter": { "maxLength": 11, "minLength": 0, "type": "string", "description": "A highlighter or special identifier for the delivery service, with a maximum length of 11 characters.", "example": "HIGHLIGHT1" }, "latitude": { "type": "number", "description": "The geographic latitude of the delivery location.", "example": -23.55052 }, "longitude": { "type": "number", "description": "The geographic longitude of the delivery location.", "example": -46.633308 }, "deliveryServiceScheduling": { "type": "object", "description": "Delivery service scheduling information.", "properties": { "shipperCustomerSchedulingDateTime": { "type": "string", "format": "date-time", "description": "The date and time when the shipper's customer has scheduled the delivery.", "example": "2024-07-15T10:30:00Z" }, "shipperSchedulingDateTime": { "type": "string", "format": "date-time", "description": "The date and time when the shipper has scheduled the delivery.", "example": "2024-07-14T08:00:00Z" }, "morningPeriod": { "type": "boolean", "description": "Indicates if the delivery is scheduled for the morning period (`true`) or not (`false`).", "example": true }, "afternoonPeriod": { "type": "boolean", "description": "Indicates if the delivery is scheduled for the afternoon period (`true`) or not (`false`).", "example": false }, "nightPeriod": { "type": "boolean", "description": "Indicates if the delivery is scheduled for the night period (`true`) or not (`false`).", "example": false }, "origin": { "type": "integer", "format": "int32", "description": "The origin code of the delivery service, usually an integer representing the location or depot.", "example": 123 } } }, "cnpjcarrier": { "type": "string", "description": "The CNPJ (Cadastro Nacional da Pessoa Jurídica) number of the carrier company.", "example": "04816548000197" }, "cnpjbranch": { "type": "string", "description": "The CNPJ number of the branch of the carrier company.", "example": "05314972000174" }, "idExternal": { "maxLength": 30, "minLength": 0, "type": "string", "description": "External ID of the delivery service.", "example": "987654abc" }, "idShippingCompany": { "type": "integer", "format": "int32", "description": "ID of the shipping company.", "example": 123456 }, "packingList": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Packing list.", "example": "1 x SKU 12; 3 x SKU 57" }, "packingListDateTime": { "type": "string", "format": "date-time", "description": "Date and time of the packing list.", "example": "2024-07-15T15:31:45Z" }, "integrationDateTime": { "type": "string", "format": "date-time", "description": "Date and time of the integration.", "example": "2024-07-15T15:31:45Z" } } } }, "DeliveryServiceResponse_v1_1": { "type": "object", "description": "Delivery service response.", "properties": { "pictures": { "type": "array", "description": "Pictures array.", "items": { "type": "string", "description": "Picture URL." } }, "idDeliveryService": { "type": "integer", "format": "int32", "description": "ID of the delivery service." }, "deliveryServiceType": { "type": "object", "description": "Delivery service type information.", "properties": { "description": { "type": "string", "description": "Description of the delivery service type." } } }, "deliveryServiceStatus": { "type": "object", "description": "Delivery service status information.", "properties": { "description": { "type": "string", "description": "Description of the delivery service status." } } }, "shipper": { "type": "object", "description": "Shipper information.", "properties": { "companyName": { "type": "string", "description": "Shipper company name." } } }, "shipperCustomer": { "type": "object", "description": "Shipper customer information.", "properties": { "idShipperCustomer": { "type": "integer", "format": "int32", "description": "Unique identifier for the shipper customer." }, "email": { "type": "string", "description": "Email address of the shipper customer." }, "firstName": { "type": "string", "description": "First name of the shipper customer." }, "lastName": { "type": "string", "description": "Last name of the shipper customer." }, "cpf": { "type": "string", "description": "CPF number of the shipper customer." }, "addressStreet": { "type": "string", "description": "Street of the shipper customer address." }, "addressNumber": { "type": "string", "description": "Address number of the shipper customer." }, "addressComplement": { "type": "string", "description": "Address complement of the shipper customer." }, "addressNeighborhood": { "type": "string", "description": "Neighborhood of the shipper customer's address." }, "addressCity": { "type": "string", "description": "City of the shipper customer's address." }, "postalCode": { "type": "string", "description": "Postal code of the shipper customer's address." }, "state": { "$ref": "#/components/schemas/StateResponse" }, "country": { "$ref": "#/components/schemas/CountryResponse" }, "created": { "type": "string", "format": "date-time", "description": "Date and time when the shipper customer record was created." }, "companyName": { "type": "string", "description": "Company name of the shipper customer." }, "cnpj": { "type": "string", "description": "CNPJ number of the shipper customer." }, "legalType": { "type": "object", "nullable": true, "description": "Legal type information.", "properties": { "description": { "type": "string", "description": "Description of the legal type of the shipper customer." } } }, "idExternalShipperCustomer": { "type": "string", "nullable": true, "description": "External identifier for the shipper customer." }, "phoneAreaCode": { "type": "string", "description": "Area code for the shipper customer's phone number." }, "phoneNumber": { "type": "string", "description": "Phone number of the shipper customer." } } }, "carrier": { "type": "object", "description": "Carrier information.", "properties": { "username": { "maxLength": 100, "minLength": 0, "type": "string", "description": "A string representing the username of the carrier." }, "firstName": { "maxLength": 100, "minLength": 0, "type": "string", "description": "A string representing the first name of the carrier." }, "lastName": { "maxLength": 100, "minLength": 0, "type": "string", "description": "A string representing the last name of the carrier." }, "cpf": { "maxLength": 14, "minLength": 0, "type": "string", "description": "A string representing the Brazilian CPF number of the carrier." }, "email": { "maxLength": 254, "minLength": 0, "type": "string", "description": "A string representing the email address of the carrier." }, "cnpjtransportCompany": { "type": "string", "description": "A string representing the CNPJ number of the transport company associated with the carrier." }, "mobileAreaCode": { "maxLength": 10, "minLength": 0, "type": "string", "description": "A string representing the area code for the carrier's mobile phone." }, "mobile": { "maxLength": 10, "minLength": 0, "type": "string", "description": "The carrier's mobile phone number." }, "phoneAreaCode": { "maxLength": 3, "minLength": 0, "type": "string", "description": "Area code for the carrier's landline phone." }, "phone": { "maxLength": 10, "minLength": 0, "type": "string", "description": "A string representing the carrier's landline phone number." }, "created": { "type": "string", "format": "date-time", "description": "Date and time when the carrier record was created." }, "idExternalCarrier": { "maxLength": 30, "minLength": 0, "type": "string", "description": "External identifier for the carrier." }, "isCarrierAppOnline": { "type": "boolean", "description": "A boolean indicating whether the carrier is currently online in the carrier application." }, "shippingCompany": { "$ref": "#/components/schemas/ShippingCompanyResponse" }, "rg": { "maxLength": 12, "minLength": 0, "type": "string", "description": "A string representing the Brazilian RG number of the carrier." } } }, "displacementType": { "type": "object", "description": "Displacement type information.", "properties": { "description": { "type": "string", "description": "Displacement type description." }, "vehicleType": { "type": "object", "description": "Vehicle type information.", "properties": { "description": { "type": "string", "description": "Description of the vehicle type." } } } } }, "state": { "$ref": "#/components/schemas/StateResponse" }, "country": { "$ref": "#/components/schemas/CountryResponse" }, "nonDeliveryReason": { "type": "object", "description": "Information about the reason for non-delivery.", "properties": { "description": { "type": "string", "description": "A description explaining the reason for non-delivery." } } }, "shipperPartner": { "type": "object", "description": "Shipper partner information.", "properties": { "cnpj": { "type": "string", "description": "The CNPJ number of the Shipper partner." }, "name": { "type": "string", "description": "Shipper partner name." } } }, "shipperBranch": { "type": "object", "description": "Shipper branch information.", "properties": { "shipperType": { "type": "object", "description": "Shipper type information.", "properties": { "description": { "type": "string", "description": "Description of the type of shipper." } } }, "companyName": { "type": "string", "description": "The name of the shipping company branch." }, "trade": { "type": "string", "description": "The trade or industry in which the shipping company operates." }, "cnpj": { "type": "string", "description": "The CNPJ (Cadastro Nacional da Pessoa Jurídica) number of the shipping company branch." }, "companyContact": { "type": "string", "description": "The primary contact person's name at the shipping company branch." }, "telephoneArea": { "type": "string", "description": "The area code for the shipping company branch's telephone number." }, "telephone": { "type": "string", "description": "The telephone number of the shipping company branch." }, "mobileArea": { "type": "string", "description": "The area code for the shipping company branch's mobile number." }, "mobile": { "type": "string", "description": "The mobile number of the shipping company branch." }, "email": { "type": "string", "description": "The email address of the shipping company branch." } } }, "freightPrice": { "type": "object", "description": "Freight price information.", "properties": { "description": { "type": "string", "description": "Description of the freight price details." }, "firstPostalCodeInterval": { "type": "string", "description": "The starting range of postal codes for which the freight price applies." }, "secondPostalCodeInterval": { "type": "string", "description": "The ending range of postal codes for which the freight price applies." }, "price": { "type": "number", "description": "The price charged for the freight service." }, "created": { "type": "string", "format": "date-time", "description": "The date and time when the freight price was created." } } }, "shippingCompany": { "$ref": "#/components/schemas/ShippingCompanyResponse" }, "invoiceOrderOfService": { "type": "string", "description": "The invoice order number for the service." }, "description": { "type": "string", "description": "Delivery service description." }, "addressStreet": { "type": "string", "description": "The street address for the delivery." }, "addressNumber": { "type": "string", "description": "The number of the building or house for the delivery address." }, "addressComplement": { "type": "string", "description": "Additional address details, such as apartment or suite number." }, "addressNeighborhood": { "type": "string", "description": "The neighborhood of the delivery address." }, "addressCity": { "type": "string", "description": "The city of the delivery address." }, "postalCode": { "type": "string", "description": "The postal code of the delivery address." }, "estimateDeliveryHour": { "type": "string", "format": "date-time", "description": "The estimated delivery time and date." }, "created": { "type": "string", "format": "date-time", "description": "The date and time when the delivery service was created." }, "initialEstimateDeliveryHour": { "type": "string", "format": "date-time", "description": "The initially estimated delivery time and date." }, "deliveryDateTime": { "type": "string", "format": "date-time", "description": "Date and time of delivery." }, "estimateDeliveryDistance": { "type": "integer", "format": "int32", "description": "Delivery service esimate distance." }, "travelledDeliveryDistance": { "type": "integer", "format": "int32", "description": "The total distance traveled for the delivery, measured in kilometers." }, "orderNumber": { "type": "string", "description": "The unique number associated with the order." }, "cteNumber": { "type": "string", "description": "The number of the CTE (Conhecimento de Transporte Eletrônico), an electronic transport document used in Brazil." }, "cteDate": { "type": "string", "format": "date-time", "description": "The date and time when the CTE was issued." }, "sender": { "type": "string", "description": "The name of the sender of the delivery." }, "senderCity": { "type": "string", "description": "The city from which the delivery was sent." }, "senderState": { "type": "integer", "format": "int32", "description": "The state code from which the delivery was sent." }, "weight": { "type": "number", "description": "The weight of the delivery item in kilograms." }, "cubicMeter": { "type": "number", "description": "The volume of the delivery item in cubic meters." }, "cubicMeterWeight": { "type": "number", "description": "The weight of the delivery item calculated based on its volume." }, "value": { "type": "number", "description": "The monetary value of the delivery item." }, "freightPriceReceived": { "type": "number", "description": "The amount received for the freight service." }, "deliveryAttempts": { "type": "integer", "format": "int32", "description": "The number of attempts made to deliver the item." }, "serviceTime": { "type": "integer", "format": "int32", "description": "The time spent on the delivery service, measured in minutes." }, "invoiceOrderOfServiceSerie": { "type": "string", "description": "The series of the invoice order of service." }, "leadTime": { "type": "string", "format": "date-time", "description": "The lead time for the delivery, calculated from the order date to the delivery date." }, "cnpjcarrier": { "type": "string", "description": "The CNPJ (Cadastro Nacional da Pessoa Jurídica) number of the carrier company." }, "cnpjbranch": { "type": "string", "description": "The CNPJ number of the branch of the carrier company." }, "idExternal": { "type": "string", "description": "External ID of the delivery service." }, "billingInfo": { "type": "array", "description": "Billing information array.", "items": { "type": "object", "description": "Billing information.", "properties": { "receivableAmount": { "type": "number", "description": "The total amount receivable for the billing item." }, "money": { "type": "number", "description": "The amount received in cash." }, "cheque": { "type": "number", "description": "The amount received via cheque." }, "creditCard": { "type": "number", "description": "The amount received via credit card." }, "webComment": { "type": "string", "description": "Comments or notes made via the web interface regarding the billing item." }, "carrierComment": { "type": "string", "description": "Comments or notes made by the carrier regarding the billing item." }, "billingConfirmDate": { "type": "string", "format": "date-time", "description": "The date and time when the billing was confirmed." }, "created": { "type": "string", "format": "date-time", "description": "The date and time when the billing item was created." } } } }, "deliveryServiceRouteItem": { "type": "array", "description": "Array in which each item corresponds to a delivery service route.", "items": { "type": "object", "description": "Delivery service route information.", "properties": { "idDeliveryServiceRouteItem": { "type": "integer", "format": "int32", "description": "Unique identifier for the delivery service route item." }, "deliveryServiceRoute": { "description": "Delivery service route.", "type": "object", "properties": { "idDeliveryServiceRoute": { "type": "integer", "format": "int32", "description": "Unique identifier for the delivery service route." }, "deliveryServiceRouteStatus": { "type": "object", "description": "Delivery service route status.", "properties": { "description": { "type": "string", "description": "Delivery service route status response description." } } }, "deliveryServiceDate": { "type": "string", "format": "date-time", "description": "Date and time of the delivery service." }, "created": { "type": "string", "format": "date-time", "description": "Date and time when the delivery service route was created." }, "startWorkDayDateTime": { "type": "string", "format": "date-time", "description": "Start date and time of the workday." }, "finishWorkDayDateTime": { "type": "string", "format": "date-time", "description": "Finish date and time of the workday." }, "itinerantDate": { "type": "string", "format": "date-time", "description": "Date and time of the itinerant delivery service." } } }, "deliveryServiceRouteItemStatus": { "type": "object", "description": "Delivery service route item status.", "properties": { "description": { "type": "string", "description": "Description of the delivery service route item status." } } }, "nonDeliveryDescription": { "type": "string", "description": "Description of why the delivery was not completed." }, "index": { "type": "integer", "format": "int32", "description": "Index of the delivery service route item." }, "created": { "type": "string", "format": "date-time", "description": "Date and time when the delivery service route item was created." }, "startDisplacementDateTime": { "type": "string", "format": "date-time", "description": "Start date and time of the displacement." }, "startDisplacementLatitude": { "type": "number", "description": "Latitude at the start of the displacement." }, "startDisplacementLongitude": { "type": "number", "description": "Longitude at the start of the displacement." }, "finishedDisplacementLatitude": { "type": "number", "description": "Latitude at the end of the displacement." }, "finishedDisplacementLongitude": { "type": "number", "description": "Longitude at the end of the displacement." }, "receiverName": { "type": "string", "description": "Name of the person receiving the delivery." }, "receiverDocument": { "type": "string", "description": "Document or identification of the receiver." }, "description": { "type": "string", "description": "Description of the delivery service route item." }, "deliveryArrived": { "type": "string", "format": "date-time", "description": "Date and time when the delivery arrived." }, "comment": { "type": "string", "description": "Additional comments about the delivery service route item." }, "rating": { "type": "integer", "format": "int32", "description": "Rating given to the delivery service." }, "pauseDisplacementDateTime": { "type": "string", "format": "date-time", "description": "Date and time when the displacement was paused." }, "deliveryLeft": { "type": "string", "format": "date-time", "description": "Date and time when the delivery was left or completed." }, "deliveryReason": { "type": "object", "description": "Delivery reason.", "properties": { "description": { "type": "string", "description": "Description of the reason for the delivery." } } } } } } } }, "StateResponse": { "type": "object", "description": "State response.", "properties": { "name": { "type": "string", "description": "State name." }, "code": { "type": "string", "description": "State code." } } }, "CountryResponse": { "type": "object", "description": "Country response.", "properties": { "name": { "type": "string", "description": "Country name." }, "code": { "type": "string", "description": "Country code." } } }, "ShippingCompanyResponse": { "type": "object", "description": "Shipping company response.", "properties": { "companyName": { "type": "string", "description": "The name of the company." }, "trade": { "type": "string", "description": "The trade or industry in which the company operates." }, "cnpj": { "type": "string", "description": "The CNPJ number, which is the Brazilian national registry of legal entities." }, "companyContact": { "type": "string", "description": "The primary contact person's name at the company." }, "telephoneArea": { "type": "string", "description": "The area code for the company's telephone number." }, "telephone": { "type": "string", "description": "The company's telephone number." }, "mobileArea": { "type": "string", "description": "The area code for the company's mobile number." }, "mobile": { "type": "string", "description": "The company's mobile number." }, "email": { "type": "string", "description": "The company's email address." } } } } }, "tags": [ { "name": "Authentication" }, { "name": "Delivery services" } ] }