{ "openapi": "3.0.0", "info": { "title": "Pick and Pack Last Mile Protocol API", "description": "The Pick and Pack Last Mile Protocol API enables seamless integration between the [Pick and Pack](https://help.vtex.com/en/tutorial/vtex-pick-and-pack--1OOops3WrUyz7e0bnhkfXU) app and delivery services. This API allows carriers and brokers to securely and efficiently exchange shipment information with the Pick and Pack app. It streamlines the process of managing orders, updating shipping statuses, and handling various service-related tasks, ensuring timely and accurate delivery updates. \n\n>ℹ️ Blank fields are included as `null` instead of being omitted.", "version": "1.0" }, "servers": [ { "url": "https://auth.pickingnpacking.com/{environment}", "variables": { "environment": { "default": "DefaultParameterValue", "description": "Server to access the authentication necessary to make a request in the Pick and Pack Provider API." } } }, { "url": "https://{store_endpoint}", "variables": { "store_endpoint": { "default": "storeapi.com", "description": "Server from the store." } } }, { "url": "https://api.pickingnpacking.com/{environment}/v1/tracking/hook", "variables": { "environment": { "default": "DefaultParameterValue", "description": "Environment of the Pick and Pack Protocol App." } } } ], "paths": { "/token": { "post": { "tags": [ "Authentication" ], "summary": "Create JWT token", "description": "Creates a `JWT` (JSON Web Token) necessary to access the Pick and Pack Last Mile Protocol API information.\r\n\r\n>ℹ️ To generate the `JWT` it is necessary to have the `API KEY` previously generated by the Pick and Pack team.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).", "operationId": "Createtoken", "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatetokenRequest" }, "example": { "apiKey": "{pnpApiKey}" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string", "description": "Generated `JWT` token." }, "example": "{token}" } } } }, "deprecated": false, "servers": [ { "url": "https://auth.pickingnpacking.com/{environment}", "variables": { "environment": { "default": "DefaultParameterValue", "description": "Server to access the authentication necessary to make a request in the Pick and Pack Last Mile Protocol API." } } } ] } }, "/create-service": { "post": { "tags": [ "Service integration" ], "summary": "Create service", "description": "Creates a service with the information that VTEX will send to the carrier. To understand how to integrate with a carrier, check the [VTEX Pick and Pack Carriers Integration Protocol](https://developers.vtex.com/docs/guides/vtex-pick-and-pack) guide.\r\n\r\nThis endpoint must be developed by the carriers or brokers to integrate into the protocol.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).", "operationId": "Createservice", "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" }, { "$ref": "#/components/parameters/Authorization" } ], "requestBody": { "content": { "application/json": { "example": { "orderId": "SLR-29384924-01", "carrierId": "servientrega-50461c9f3335", "seller": "qaolimpica", "sender": { "name": "Tabitha Sears", "phone": "+57 2305781612", "email": "tabitha_sears@fortean.brother", "city": "Jenkinsville", "state": "Northern Mariana Islands", "country": "US", "address": "77 Sullivan Place, Jenkinsville, Northern Mariana Islands", "addressComplement": "Flat 45", "number": "1029", "reference": "3", "location": { "latitude": -75.269008, "longitude": 137.499833 }, "pickupDate": "2024-04-25T18:06:41.202Z" }, "receiver": { "name": "Pansy Graves", "phone": "+57 4240807147", "email": "pansy_graves@zentime.moda", "city": "Valle", "state": "Marshall Islands", "country": "Iceland", "neighborhood": "Billings", "number": "9840", "reference": "63 Billings Place, Valle, Marshall Islands", "addressComplement": "Flat 45", "location": { "latitude": -33.249891, "longitude": -135.052901 }, "identification": "9541933267", "deliveryDate": "2024-04-16T20:49:36.117Z", "contactName": "Savannah Porter", "deliveryWindow": { "name": "consectetur", "initialDate": "2024-04-25T22:50:41.209Z", "finalDate": "2024-05-05T21:50:41.210Z" } }, "packages": [ { "id": "6266df719ac55224b793ad36", "orderId": "SLR-1221800709659-01", "envelope": "Large", "description": "Delicate package", "categories": [ "Cellphone", "Technology" ], "dimensions": { "width": "68", "height": "43", "length": "13" }, "weight": "19", "totalValue": 5616.01, "items": [ { "id": "6266df71a19ebe35637e1f42", "name": "Tomatos", "ean": "473390795673", "refId": "6266", "image": "https://static9.depositphotos.com/1628352/1107/i/600/depositphotos_11071361-stock-photo-tomato.jpg", "type": "Food", "price": 774230.01, "weight": "4 kg", "quantity": 4 }, { "id": "6266df71803601c3bc4e2d99", "name": "Tomatos", "ean": "329949764612", "refId": "6266", "image": "https://static9.depositphotos.com/1628352/1107/i/600/depositphotos_11071361-stock-photo-cellphone.jpg", "type": "Foods", "price": 23162, "weight": "14 kg", "quantity": 9 } ] } ], "type": "PICKUP_DELIVERY", "carrierServiceType": "OTHERS", "comments": "Delivery comments.", "paymentMethod": "CASH_ON_DELIVERY", "orderValue": 8000, "settings": [ { "label": "Key secret", "value": "keysecret-0122", "key": "secrekey" } ], "timezone": { "offset": 300, "value": "America/Bogota" } }, "schema": { "$ref": "#/components/schemas/CreateServiceBody" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseService" } } } }, "401": { "description": "Required authentication" }, "400": { "description": "Bad request" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal error" } }, "deprecated": false, "servers": [ { "url": "https://{store_endpoint}", "variables": { "store_endpoint": { "default": "storeapi.com", "description": "Server from the store." } } } ] } }, "/rates": { "post": { "tags": [ "Carriers" ], "summary": "Calculate rates", "description": "Retrieves all rates from the carriers. To understand how to integrate with a carrier, check the [VTEX Pick and Pack Carriers Integration Protocol](https://developers.vtex.com/docs/guides/vtex-pick-and-pack) guide.\r\n\r\nThis endpoint must be developed by the carriers or brokers to integrate into the protocol.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).", "operationId": "Createservice", "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" }, { "$ref": "#/components/parameters/Authorization" } ], "requestBody": { "content": { "application/json": { "example": { "orderId": "SLR-29384924-01", "carrierId": "servientrega-50461c9f3335", "seller": "qaolimpica", "sender": { "name": "Tabitha Sears", "phone": "+57 2305781612", "email": "tabitha_sears@fortean.brother", "city": "Jenkinsville", "state": "Northern Mariana Islands", "country": "US", "address": "77 Sullivan Place, Jenkinsville, Northern Mariana Islands", "addressComplement": "Flat 45", "number": "1029", "reference": "3", "location": { "latitude": -75.269008, "longitude": 137.499833 }, "pickupDate": "2024-04-25T18:06:41.202Z" }, "receiver": { "name": "Pansy Graves", "phone": "+57 4240807147", "email": "pansy_graves@zentime.moda", "city": "Valle", "state": "Marshall Islands", "country": "Iceland", "neighborhood": "Billings", "number": "9840", "reference": "63 Billings Place, Valle, Marshall Islands", "addressComplement": "Flat 32", "location": { "latitude": -33.249891, "longitude": -135.052901 }, "identification": "9541933267", "deliveryDate": "2024-04-16T20:49:36.117Z", "contactName": "Savannah Porter", "deliveryWindow": { "name": "consectetur", "initialDate": "2024-04-25T22:50:41.209Z", "finalDate": "2024-05-05T21:50:41.210Z" } }, "packages": [ { "id": "6266df719ac55224b793ad36", "orderId": "SLR-1221800709659-01", "envelope": "Large", "description": "Delicate package", "categories": [ "Foods" ], "dimensions": { "width": "68", "height": "43", "length": "13" }, "weight": "19", "totalValue": 5616.01, "items": [ { "id": "6266df71a19ebe35637e1f42", "name": "Tomatos", "ean": "473390795673", "refId": "6266", "image": "https://static9.depositphotos.com/1628352/1107/i/600/depositphotos_11071361-stock-photo-tomato.jpg", "type": "Food", "price": 774230.01, "weight": "4 kg", "quantity": 4 } ] } ], "type": "PICKUP_DELIVERY", "carrierServiceType": "OTHERS", "comments": "Delivery comments.", "paymentMethod": "CASH_ON_DELIVERY", "orderValue": 8000, "settings": [ { "label": "Key secret", "value": "keysecret-0122", "key": "secrekey" } ], "timezone": { "offset": 300, "value": "America/Bogota" } }, "schema": { "$ref": "#/components/schemas/CreateServiceBody" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceBody" } } } }, "401": { "description": "Required authentication" }, "400": { "description": "Bad request" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal error" } }, "deprecated": false, "servers": [ { "url": "https://{store_endpoint}", "variables": { "store_endpoint": { "default": "storeapi.com", "description": "Server from the store." } } } ] } }, "/list-carriers": { "post": { "tags": [ "Carriers" ], "summary": "List carriers", "description": "Retrieves all carriers from the broker.\r\n\r\nThis endpoint must be developed by the carriers or brokers to integrate into the protocol.\r\n\r\nThis endpoint only applies to multi-carrier integrations such as Shipstation or Shippo.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).", "operationId": "Createservice", "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" }, { "$ref": "#/components/parameters/Authorization" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseService" } } } }, "401": { "description": "Required authentication" }, "400": { "description": "Bad request" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal error" } }, "deprecated": false, "servers": [ { "url": "https://{store_endpoint}", "variables": { "store_endpoint": { "default": "storeapi.com", "description": "Server from the store." } } } ] } }, "/{carrierId}/{serviceId}": { "get": { "tags": [ "Shipping updates" ], "summary": "Get service", "description": "Returns information about a service, which can be queried by providing the carrier ID and the corresponding service ID as query parameters.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).", "operationId": "Getservice", "parameters": [ { "name": "carrierId", "in": "path", "description": "Carrier ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50" } }, { "name": "serviceId", "in": "path", "description": "Service ID generated by the carrier.", "required": true, "style": "simple", "schema": { "type": "string", "example": "78c83922-d658-48bf-89d5-0658a6a94e27" } }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" }, { "$ref": "#/components/parameters/Authorization" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceBody" }, "example": { "message": "success", "data": { "id": "519400fb-f980-4a6a-809c-9f986fdb98a4", "orderId": "46369545534253-01", "carrierId": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50", "serviceId": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50&78c83922-d658-48bf-89d5-0658a6a94e27", "carrierName": "AfterShip", "seller": "lastmile", "status": "DELIVERED", "type": "PICKUP_DELIVERY", "tags": [], "labels": [ { "id": "78c83922-d658-48bf-89d5-0658a6a94e27", "name": "Shipping label", "url": "https://sandbox-download.postmen.com/label/2024-03-09/258a26a4-45ae-49eb-b64d-929d3b81f46d-1709947994279763.pdf", "type": "PDF" } ], "evidences": [], "packages": [ { "id": "a46e5bc1-8959-459f-a094-b6e699f7214c", "orderId": "46369545534253-01", "envelope": "Foam or Plastic Containers", "dimensions": { "height": "5", "length": "11", "width": "7" }, "weight": "48", "totalValue": 5352, "items": [ { "id": "184", "name": "Chicken", "ean": "EAN354", "quantity": 8, "price": 669, "refId": "314", "image": "https://picsum.photos/seed/YtoZ9/128/480", "type": "other", "weight": "6" } ], "categories": [ "Movies", "Garden", "Books" ], "description": "Unde deserunt libero cupiditate illum." } ], "timeline": [ { "id": "77263f59-0ac5-4b0c-bfe5-f17a1648474d", "date": "2024-03-09T01:33:14.917Z", "createdAt": "2024-03-09T01:33:14.917Z", "updatedAt": "2024-03-09T01:33:14.917Z", "type": "STATUS", "description": "Service pending in DEV", "author": "System", "metaData": { "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", "metaData": { "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", "metaData": null, "serviceId": "78c83922-d658-48bf-89d5-0658a6a94e27", "shippingPrice": 284.02, "status": "PENDING", "labels": [ { "name": "Shipping label", "id": "78c83922-d658-48bf-89d5-0658a6a94e27", "type": "PDF", "url": "https://sandbox-download.postmen.com/label/2024-03-09/258a26a4-45ae-49eb-b64d-929d3b81f46d-1709947994279763.pdf" } ] }, "serviceId": "78c83922-d658-48bf-89d5-0658a6a94e27", "shippingPrice": 284.02, "status": "PENDING", "labels": [ { "name": "Shipping label", "id": "78c83922-d658-48bf-89d5-0658a6a94e27", "type": "PDF", "url": "https://sandbox-download.postmen.com/label/2024-03-09/258a26a4-45ae-49eb-b64d-929d3b81f46d-1709947994279763.pdf" } ] } }, { "id": "9906da15-15e4-4dbd-8e90-c34ec43ed446", "date": "2024-03-09T01:46:20.006Z", "createdAt": "2024-03-09T01:46:20.006Z", "updatedAt": "2024-03-09T01:46:20.006Z", "type": "NOTE", "description": "A new note has been added", "author": "afterShip", "metaData": { "0": { "type": "COMMENT", "note": "The package is delivered at the door", "author": "afterShip" } } }, { "id": "35619274-3bca-4749-8a38-53a62776144a", "date": "2024-03-09T01:44:17.437Z", "createdAt": "2024-03-09T01:44:17.437Z", "updatedAt": "2024-03-09T01:44:17.437Z", "type": "NOTE", "description": "A new note has been added", "author": "afterShip", "metaData": { "0": { "type": "COMMENT", "note": "Tracking Number: 10001709948594168", "author": "afterShip" } } }, { "id": "9b60e3fd-5bf9-43c6-99f2-4292a57fa408", "date": "2024-03-09T01:46:19.689Z", "createdAt": "2024-03-09T01:46:19.689Z", "updatedAt": "2024-03-09T01:46:19.689Z", "type": "STATUS", "description": "The package was delivered", "author": "System", "metaData": { "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", "trackingUrl": "https://tools.usps.com/go/TrackConfirmAction?tLabels=9361289676091361892011", "status": "DELIVERED" } }, { "id": "21c9acaa-e14b-41bd-aaa7-a2cebd7384c0", "date": "2024-03-09T01:43:15.887Z", "createdAt": "2024-03-09T01:43:15.887Z", "updatedAt": "2024-03-09T01:43:15.887Z", "type": "STATUS", "description": "Service pending", "author": "System", "metaData": { "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", "trackingUrl": "https://tools.usps.com/go/TrackConfirmAction?tLabels=9361289676091361892011", "status": "PENDING" } }, { "id": "7a1a3a63-f94c-49f1-a912-bc3f095d7845", "date": "2024-03-09T01:45:18.812Z", "createdAt": "2024-03-09T01:45:18.812Z", "updatedAt": "2024-03-09T01:45:18.812Z", "type": "STATUS", "description": "Courier picked the package", "author": "System", "metaData": { "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", "trackingUrl": "https://tools.usps.com/go/TrackConfirmAction?tLabels=9361289676091361892011", "status": "PICKED" } }, { "id": "9ca25940-bdae-4f19-a5b4-92477abfa059", "date": "2024-03-09T01:33:14.978Z", "createdAt": "2024-03-09T01:33:14.978Z", "updatedAt": "2024-03-09T01:33:14.978Z", "type": "LABEL", "description": "Added a label", "author": "System", "metaData": { "name": "Shipping label", "id": "78c83922-d658-48bf-89d5-0658a6a94e27", "type": "PDF", "url": "https://sandbox-download.postmen.com/label/2024-03-09/258a26a4-45ae-49eb-b64d-929d3b81f46d-1709947994279763.pdf" } }, { "id": "24b84b8b-7418-4ed8-bc89-b6a1cbee2331", "date": "2024-03-09T01:43:16.289Z", "createdAt": "2024-03-09T01:43:16.289Z", "updatedAt": "2024-03-09T01:43:16.289Z", "type": "NOTE", "description": "A new note has been added", "author": "afterShip", "metaData": { "0": { "type": "COMMENT", "note": "Tracking Number: 10001709948594168", "author": "afterShip" } } }, { "id": "9dfad688-e99a-4b27-9ccb-959da40c3bf8", "date": "2024-03-09T01:33:08.385Z", "createdAt": "2024-03-09T01:33:08.385Z", "updatedAt": "2024-03-09T01:33:08.385Z", "type": "STATUS", "description": "Service creation by AfterShip", "author": "System", "metaData": { "status": "CREATED" } }, { "id": "781ab0af-e62a-4a21-a837-8d0eea3f57c2", "date": "2024-03-09T01:44:17.077Z", "createdAt": "2024-03-09T01:44:17.077Z", "updatedAt": "2024-03-09T01:44:17.077Z", "type": "STATUS", "description": "Courier on route", "author": "System", "metaData": { "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", "trackingUrl": "https://tools.usps.com/go/TrackConfirmAction?tLabels=9361289676091361892011", "status": "ON_ROUTE" } } ], "notes": [ { "type": "COMMENT", "date": "2024-03-09T01:43:16.280Z", "content": "Tracking Number: 10001709948594168", "author": "afterShip" }, { "type": "COMMENT", "date": "2024-03-09T01:44:17.423Z", "content": "Tracking Number: 10001709948594168", "author": "afterShip" }, { "type": "COMMENT", "date": "2024-03-09T01:46:19.998Z", "content": "The package is delivered at the door", "author": "afterShip" } ], "timezone": { "offset": 300, "value": "America/Bogota", "label": null }, "carrierLogo": "iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAYAAADDPmHLAAAACXBIWXMAACxLAAAsSwGlPZapAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAtTSURBVHgB7Z1PbBvHFca/WZICXCCFkt6aAGEORZ3YjaVD0d5MpUCL5BIZydGprUOKRBYg+ZQUDSqxSIG0F8uB7PZmufYxruVLghRwRN9S9GDZTpwUPZgB6t6aEE3hAKLEybxdrk3bEnd2dnb+LPcHyJLMFUXqffvem5k3bxgKCF+YGMfmZl18OYEAdXD2pPi6DoZ6dAEbF/+M3/9TrAPGO+DoiG/ooy2+/0JctyE+Omzl8xYKCEMB4At769gMGmDsoHhHDWHEOvJhI/zg/ArGxlpseaMNz/FWAHxubwMIpsVbeDFHgyexIbzEFaC35quH8EoAd43OgyMPu3DLMBEyOFqo1Zo+eQbnBdCP59PCvQujC/fuBy0RJs6y0zdX4TjOCqBv+HmwYMG5u10W8go93nRZCM4JoBCGfxCHheCUAPjsM0cRsEWLSV2+OCgEJwTAX5uoo9I9A39ifDY4XxPDyOMuJIsBLCPu+kVh/FsYFeMTjE2j270VvnfbLwWWGLm7fjcoLFRrU7a8gRUPwI/tO4LK1lWMuvEJyne2uuth/mMB4x5AGP+E+LSAkofhfEkkiE0YxJgAwuFdt3sR5V0/nChBnBEhoQMDGBFAGO+r3fXCDu90YzAvyF0ApfEVMSSCXAVQGj8jBkSQmwBK42siZxHkIoDS+JrJUQTaBRBm+1vdq6XxtbOBWigCraMD/RNBm1tnSuPnwoQYRp+AZrQKgM/uXwTj0yjJi6P89ae1TqJpCwF87mkq1boIH/jOI8BPhE4f+370/e1/AtcvA3e+hhcwNsVWPmlBA1oE4FXSN3UYeGEW2PPd+///y9vA+38CPl6D80RJ4aSOfECPAI7tWxWfjsBlfvBj4OU3gMf3Dr+OhHDhj8C1y3AaMWUs1g0OISOZBRCuYjF2Bq7yPeHmD/8+EkAaPr4EfHAK+O9/4CwsOMRWbmRyWZkE4LTrpzjfeCVy91lYPw+0/uKqEDpiaPhUllCQbRRQ6S45aXyK880Psxs/fq554eB+6uTghlZYM1UVKXuAfkXPLbiEbJxXhfKDc28B//oHnCLDqKAKVaJyLjdQjfNpeezxyBu4lh9wTl6gBQWUPIAziZ+uOK/K+6eBv6+5IQRFL6AmgLl9t6zH/t3G86ZxZ/6gxU59OoWUpBYAn9vfEC5nHbbIO86r4kJ+oOAF0gvg2D4yfgOmMRXns2I3P0jtBVIJwErmH8d5cvm23X0abOUHtdqjaeYF0s0D0LjfJE/88N543ifjE/SaacTwhOFQtbWZarUwnQAYDsIkjV/6Z/hBaNhInssknM2nuVxaAHzuR9PGM3+agqXkylfota+fg2HGw0RdEnkPwHvm50L/Ldbpf/uLKJ76xDf/i17zOy9H78E0vCe9MiudBIrs/yvQ3LMtaBTw/DExJ/8inMaNWcKOGA08KnOhlACsj/0HISFQckXx1SVo/E93vSvrBJJzApJrAeT+HWkmQncWhQVanXvhdftCcLaSKAzZraSrJAXAzGb/MtAfnKp2piytBVCcD2sFzrlZS8jZAZnLEm/r/q7er+AypvMDH6qFCIlJoeRRwNbWBEzx7HORMdNChjj/G5F1v5TvsJHi+8mZ6HepGJ/e27M/gzEkbCcRAnoNI/GfXPlLb0Rfq5ZhxcNG3fkBuXsqFFWN8zSd/fxs9B6JC38wMz/At0kArWGXJAuAw4wHGFzdo9mzA1PqyZWu/EBHnN9p2ZqmuI2QnAckC4CxJ4UIzEN37+G3oztZpUz7m6/vLcio5AfXPgL++o56nKdVy1fetjxKYRpCgCkPsBv0B3z1pHriFecHFFJ+9W6yQbKO591atq4nXTA0CeSv7a3DFegObv4tcqcqiWKcH5x/a+dEkdw9PUZJnorxKc5TDkOv0Z2ahfFwFDeE4R6gWq2LGUA4BQmAxJAlP6APGnHES7XkJW5c1hvnXSE6OWVjt4fVq4JtMpgfqJZhXf8o+siCE3E+gaBSh7IAer26SALhLLbKtH0pTyN62xlCAGN+tGunkBCGhZzLsGyXoedAggD4uJhThjdkzQ+G4XKcHwYbfuaC9W7h2onzg999qMdF03P8+j2R4b/pZ3laghf3MwmUIWt+4FOcz0DxPMCDUEh480K6RZjwZ94rhvE5z7Aa2EMbRWDPI9FwTWYCKb7zfa5GHoSzjMvBRWFPP4NPgtYNRojhAggqRlqWG+PAcxLXpN5f6TZB0B768LAHxSRCG0VCZsauKK4/ptfLkgP0iuUBRpGxsfawh4cKgP358zaio9RL/KSTvSaQlQLwmHbSBckC4L0rKPETzr9IukRiGBhsoMRPGG8lXSIRAlgpAF9hlUTbJQugWi0F4CsStksUQJhFMpQi0ImZrWQbMq1iJKeCef6J4O3PMDJ8aaByicnZTFIAQf5bX2nZdlS4bqIVvZzN5AQQxZJ85wPijRxFh95j/rWLHdl+gVICiGJJL/9blP44RRaBufcn7bHll4NZZRUmoD/Q4s/d68idBXovtHPZlLhZIH2zypeEURjodikM5F8pTC6Sdui40gVEFRvtYxlvpzlFRNoDRMNBfhYmocreuEuYT+3iBruEmfZknLXSXJ6uIqiHVdiA/pjkEXwYKdC+/8W+aG20jqltN9NcnkoA7PRNGg20YIN4l6+r+UHcPYSaP9jqGcT5JbYcLuFLk74snLGm+EUN2MK1/MClY2SCYBkpUTswwlbL+J2g3TppOonP7R/++MonkMK9LmFKB0aobQyx7QUGydIFRBWK8x+cdqs9HNlE5cegiFNeIIZq+l99d3iL9iwewLVuoPdQuvsJ9a1hLnmBGMoPaOilOz9w/TjZ2vYMFFHeGBLONTN2Ei4yOH9AsVqVwfG8u2cJr6bN/AfJtjOoWl2Cy1XDsfHi+QOZ3nzX+l1D6GdsjudlELN+acf9Dz0FMiJygQXx6QRKzMP5jJibWUUGdB0f715CWHxWReKnHPtj9GwOrdUOhe6oxAwaXH+MFgFE9QJBZjWWyBLMZEn87nsmaKI/KtCiypIhMN5UPSl8x6eDZkQ+sCo+SR9aVJICxk+ylZsL0Ij+BhG1Gr3AsoxcO/waqneWoJlcesCFPYarwTo4q6MkO5T0VXtTuuL+fU+NnChFoIkcjR8+PXKkFEFGcjZ++CuQM6UIFDFg/PDXwAClCFJiyPiEkTZxYauZ6tgkbNUT+kVLZPuTJoxPGO8Ezef2L4lFjEWUPEwO4/zEXwkL8NlnjopZQ1pB9KMdff50xE1xPOvKngrWesGXecFdWlTRY8rlP4j1wwBGOCR0qKJKzOsvwSJOnAYReYPKRetH1JnD6l0/iFPHgYS5QYDFwoYFGt710LQR63fDyfNgwjIzxucLJITQ3aP6/2W23HaqhtLZA4HCsBAEDc89grOGj/HiRKj+sHFefOlLjtASie1ZjN1Zc9XwMR4dCRYKYUIIgcLDQQe9Qr9/QrCms2Inb7wSwCBi+NgQd9lRq2Jg1IyZX/LN6IN4K4BB7uYLJsJEmMlXmhjrtlwYxmWlEAKICYVQqVxFflPMHTF+nyyC4WMKdWhU/4CL/CqTab6+QMYnCndqGDv16XIum1Zppc6hCRxdFPPYONq0qnOnUligob8i1wUKlQMM0h8yXoUOattPFc31xxT24Mh+R7PjyE7h4v4ghfUAMRl3LmvZgesyxT86VnXnssYduC5TeA9A9GcN19P9EJ/sh5FCMxKHR6feuUw7cEfA+MRIeIAYyXxAueWaj4zO8fHEdthObffl2Sjuj1Sji5ESQDhVzIZ1MineVG8So+UBQPnAjbUdp4rDzhuf5X84lmOMnABCov6G95K88JSNm0sYQUZSAGFTq+3tQ4jygQ5txETJ6EHVx2G94QjzLdIWvdPvEPp9AAAAAElFTkSuQmCC", "trackingUrl": "https://tools.usps.com/go/TrackConfirmAction?tLabels=9361289676091361892011", "comments": "Comments.", "paymentMethod": "ONLINE", "carrierServiceType": "BROKER", "rate": { "shippingPrice": { "value": 0, "currency": "USD" }, "insurancePrice": { "value": 0, "currency": "USD" } }, "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", "shippingFinishedDate": "2024-01-05T11:11:11.000Z", "metaData": { "integrationResponse": {}, "carrier": { "name": "[FedEx] Postmen Testing Account", "image": null, "metaData": {}, "id": "fedex", "type": { "metaData": {}, "terms": "", "rate": { "shippingPrice": { "value": 284.02, "currency": "USD" }, "insurancePrice": { "value": 0, "currency": "USD" } }, "name": "FedEx First Overnight®", "transitTime": 0, "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", "description": "FedEx", "id": "fedex_first_overnight", "international": false } } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/m4031" }, "example": { "message": "Invalid token", "requestId": "09563f82-fe06-4004-b623-85e3aa4c92c9" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/m4031" }, "example": { "message": "Unauthorized", "requestId": "c7c1ce02-b63f-4001-a1ac-798554c85bd6" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/m4041" }, "example": { "type": "exception", "code": "TRP0005E", "data": { "0": "1", "carrierId": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50", "serviceId": "78c83922-d658-48bf-89d5-0658a6a94e27" }, "requestId": "9e3ce442-458c-4861-99aa-23b2cd2da9cf", "date": "2024-03-15T06:00:21.009Z", "message": "Service not found: 'MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50&78c83922-d658-48bf-89d5-0658a6a94e27'" } } } } }, "deprecated": false, "servers": [ { "url": "https://api.pickingnpacking.com/{environment}/v1/tracking/hook", "variables": { "environment": { "default": "DefaultParameterValue" } } } ] }, "patch": { "tags": [ "Shipping updates" ], "summary": "Update service", "description": "Updates a service with the details of the tracking service via webhook.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).", "operationId": "Updateservice", "parameters": [ { "name": "carrierId", "in": "path", "description": "Carrier ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50" } }, { "name": "serviceId", "in": "path", "description": "Service ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "78c83922-d658-48bf-89d5-0658a6a94e27" } }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" }, { "$ref": "#/components/parameters/Authorization" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateserviceRequest" }, "example": { "message": "Service updated successfully", "data": { "status": "PENDING", "agent": { "id": "27327489234", "name": "Pedro", "identification": "020323809", "phone": "+57314855674", "email": "pedro434234@gmailc.om", "vehicle": "SCOOTER" }, "trackingUrl": "https://localhost.com", "totalDistanceTraveled": 2, "rating": 5, "shippingPrice": 150000, "shippingEstimatedDate": "2024-04-27T20:25:45.067Z" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceBody1" }, "example": { "message": "Service updated successfully", "data": { "status": "PENDING", "agent": { "id": "27327489234", "name": "Pedro", "identification": "020323809", "phone": "+57314855674", "email": "pedro434234@gmailc.om", "vehicle": "SCOOTER" }, "trackingUrl": "https://localhost.com", "totalDistanceTraveled": 2, "rating": 5, "shippingPrice": 150000, "shippingEstimatedDate": "2024-04-27T20:25:45.067Z" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/m4031" }, "example": { "message": "Unauthorized", "requestId": "b5077045-e5ee-4eeb-8783-467c5454d03c" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/m4041" }, "example": { "type": "exception", "code": "TRP0005E", "data": { "0": "1", "carrierId": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50", "serviceId": "78c83922-d658-48bf-89d5-0658a6a94e27" }, "requestId": "8ce83c17-d9c4-434f-94cd-f2016bb7be8a", "date": "2024-03-15T05:59:30.114Z", "message": "Service not found: 'MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50&_78c83922-d658-48bf-89d5-0658a6a94e27'" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/m4031" }, "example": { "message": "Authentication token expired", "requestId": "6d5f5fa2-cf31-4878-9be5-7e094022a206" } } } } }, "deprecated": false, "servers": [ { "url": "https://api.pickingnpacking.com/{environment}/v1/tracking/hook", "variables": { "environment": { "default": "DefaultParameterValue" } } } ] } }, "/notes/{carrierId}/{serviceId}": { "post": { "tags": [ "Shipping updates" ], "summary": "Create notes", "description": "Allows carriers to add notes and information on existing services.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).", "operationId": "Createnotes", "parameters": [ { "name": "carrierId", "in": "path", "description": "Carrier ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50" } }, { "name": "serviceId", "in": "path", "description": "Service ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "78c83922-d658-48bf-89d5-0658a6a94e27" } }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" }, { "$ref": "#/components/parameters/Authorization" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreatenotesRequest" } }, "example": [ { "type": "ERROR", "note": "The package takes time to be shipped", "author": "Oscar Rojas" }, { "type": "COMMENT", "note": "The package was picked up", "author": "Oscar Rojas" } ] } }, "required": true }, "responses": { "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/m4031" }, "example": { "message": "Authentication token expired", "requestId": "6fd59420-57c6-4111-bb32-e2aa35eff256" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/m4041" }, "example": { "type": "exception", "code": "TRP0005E", "data": { "0": "1", "carrierId": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50", "serviceId": "servicemock" }, "requestId": "6129725b-fbb1-42dd-9ec2-4fefecce41c1", "date": "2024-03-15T06:14:15.950Z", "message": "Service not found: 'MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50&servicemock'" } } } }, "200": { "description": "OK", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceBody3" }, "example": { "message": "Notes saved successfully", "data": [ { "type": "ERROR", "note": "The package takes time to be shipped", "author": "Oscar Rojas" }, { "type": "COMMENT", "note": "The package was picked up", "author": "Oscar Rojas" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/m4031" }, "example": { "message": "Unauthorized", "requestId": "3c685f11-45ec-4b8a-88ce-b9fff421eafe" } } } } }, "deprecated": false, "servers": [ { "url": "https://api.pickingnpacking.com/{environment}/v1/tracking/hook", "variables": { "environment": { "default": "DefaultParameterValue" } } } ] } }, "/evidences/{carrierId}/{serviceId}": { "post": { "tags": [ "Shipping updates" ], "summary": "Create evidence", "description": "Allows the carrier to add evidence of delivery or pickup to the shipping service, as photos, text.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).", "operationId": "Createevidence", "parameters": [ { "name": "carrierId", "in": "path", "description": "Carrier ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50" } }, { "name": "serviceId", "in": "path", "description": "Service ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "78c83922-d658-48bf-89d5-0658a6a94e27" } }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" }, { "$ref": "#/components/parameters/Authorization" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreateevidenceRequest" }, "example": [ { "type": "IMAGE", "content": "https://parkers-images.bauersecure.com/wp-images/18727/courier-van-insurance-01.jpg", "author": "Felipe Cardenas" }, { "type": "TEXT", "content": "The package was delivered", "author": "Felipe Cardenas" } ] } } }, "required": true }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/m4031" }, "example": { "message": "Unauthorized", "requestId": "c482e112-aa73-4dfb-a31c-1586978dfead" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/m4041" }, "example": { "type": "exception", "code": "TRP0005E", "data": { "0": "1", "carrierId": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50", "serviceId": "78c83922-d658-48bf-89d5-0658a6a94e27" }, "requestId": "b39a0833-629f-429e-8955-f448165502ac", "date": "2024-03-15T06:22:50.518Z", "message": "Service not found: 'MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50&_78c83922-d658-48bf-89d5-0658a6a94e27'" } } } }, "200": { "description": "OK", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceBody4" }, "example": { "message": "Evidences saved successfully", "data": [ { "type": "IMAGE", "content": "https://parkers-images.bauersecure.com/wp-images/18727/courier-van-insurance-01.jpg", "author": "Felipe Cardenas" }, { "type": "TEXT", "content": "The package was delivered", "author": "Felipe Cardenas" } ] } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/m4031" }, "example": { "message": "Authentication token expired", "requestId": "bcd67893-292d-4547-a01f-62feb56f8a74" } } } } }, "deprecated": false, "servers": [ { "url": "https://api.pickingnpacking.com/{environment}/v1/tracking/hook", "variables": { "environment": { "default": "DefaultParameterValue" } } } ] } }, "/labels/{carrierId}/{serviceId}": { "post": { "tags": [ "Shipping updates" ], "summary": "Create label", "description": "Allows the carrier to create and add a shipping label to an order. \n\nIt is important that the tag ID is a unique value, if this value is repeated it will throw an exception. \n\n> ⚠️ If the label is type `BASE64` or `TXT`, the max size that allowed is 180kb. \r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).", "operationId": "Createlabels", "parameters": [ { "name": "carrierId", "in": "path", "description": "Carrier ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50" } }, { "name": "serviceId", "in": "path", "description": "Service ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "78c83922-d658-48bf-89d5-0658a6a94e27" } }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" }, { "$ref": "#/components/parameters/Authorization" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatelabelsRequest" }, "example": { "id": "JADF8ADF89-7AD7AF-78ADFASDF", "url": "http://s3://mybucket-alpha/orc/2013-10-04-custdata/label-pickup.pdf", "name": "Delivery label", "type": "PDF" } } }, "required": true }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/m4031" }, "example": { "message": "Unauthorized", "requestId": "c482e112-aa73-4dfb-a31c-1586978dfead" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/m4041" }, "example": { "type": "exception", "code": "TRP0005E", "data": { "0": "1", "carrierId": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50", "serviceId": "78c83922-d658-48bf-89d5-0658a6a94e27" }, "requestId": "b39a0833-629f-429e-8955-f448165502ac", "date": "2024-03-15T06:22:50.518Z", "message": "Service not found: 'MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50&_78c83922-d658-48bf-89d5-0658a6a94e27'" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/m4031" }, "example": { "message": "Authentication token expired", "requestId": "8c0bbb1b-8486-4d94-8136-8586c0ea2efe" } } } }, "200": { "description": "OK", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceBody5" }, "example": { "message": "Label saved successfully", "data": { "id": "JADF8ADF89-7AD7AF-78ADFASDF", "url": "http://s3://mybucket-alpha/orc/2013-10-04-custdata/label-pickup.pdf", "name": "Delivery label", "type": "PDF" } } } } } }, "deprecated": false, "servers": [ { "url": "https://api.pickingnpacking.com/{environment}/v1/tracking/hook", "variables": { "environment": { "default": "DefaultParameterValue" } } } ] } }, "/cancel/{carrierId}/{serviceId}": { "post": { "tags": [ "Shipping updates" ], "summary": "Cancel ongoing service", "description": "Resquest that will cancel an ongoing shipping service.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).", "operationId": "PostCancelservice", "parameters": [ { "name": "carrierId", "in": "path", "description": "Carrier ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50" } }, { "name": "serviceId", "in": "path", "description": "Service ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "78c83922-d658-48bf-89d5-0658a6a94e27" } }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" }, { "$ref": "#/components/parameters/Authorization" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelOngoingServiceRequest" }, "example": { "comment": "The delivery address was changed", "type": "END_CLIENT_CANCELED" } } }, "required": true }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/m4031" }, "example": { "message": "Unauthorized", "requestId": "c482e112-aa73-4dfb-a31c-1586978dfead" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/m4041" }, "example": { "type": "exception", "code": "TRP0005E", "data": { "0": "1", "carrierId": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50", "serviceId": "78c83922-d658-48bf-89d5-0658a6a94e27" }, "requestId": "b39a0833-629f-429e-8955-f448165502ac", "date": "2024-03-15T06:22:50.518Z", "message": "Service not found: 'MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50&_78c83922-d658-48bf-89d5-0658a6a94e27'" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/m4031" }, "example": { "message": "Authentication token expired", "requestId": "8c0bbb1b-8486-4d94-8136-8586c0ea2efe" } } } }, "200": { "description": "OK", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceBody6" }, "example": { "message": "Service canceled successfully", "data": { "comment": "The delivery address was changed", "type": "END_CLIENT_CANCELED" } } } } } }, "deprecated": false, "servers": [ { "url": "https://api.pickingnpacking.com/{environment}/v1/tracking/hook", "variables": { "environment": { "default": "DefaultParameterValue" } } } ] } }, "/cancel-service": { "post": { "tags": [ "Shipping updates" ], "summary": "Cancel service", "description": "Cancels a specific service.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).", "operationId": "Createservice", "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" }, { "$ref": "#/components/parameters/Authorization" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelServiceRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelServiceResponse" } } } }, "401": { "description": "Required authentication" }, "400": { "description": "Bad request" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal error" } }, "deprecated": false, "servers": [ { "url": "https://{store_endpoint}", "variables": { "store_endpoint": { "default": "storeapi.com", "description": "Server from the store." } } } ] } }, "/pause-service": { "post": { "tags": [ "Shipping updates" ], "summary": "Pause and resume service", "description": "Pauses or resumes a paused service.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).", "operationId": "Createservice", "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" }, { "$ref": "#/components/parameters/Authorization" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PauseResumeServiceRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PauseResumeServiceResponse" } } } }, "401": { "description": "Required authentication" }, "400": { "description": "Bad request" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal error" } }, "deprecated": false, "servers": [ { "url": "https://{store_endpoint}", "variables": { "store_endpoint": { "default": "storeapi.com", "description": "Server from the store." } } } ] } }, "/on-hold/{carrierId}/{serviceId}": { "post": { "tags": [ "Shipping updates" ], "summary": "Create on hold service", "description": "Request that allows a carrier to temporarily pause a shipping service.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).", "operationId": "Onholdservice", "parameters": [ { "name": "carrierId", "in": "path", "description": "Carrier ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50" } }, { "name": "serviceId", "in": "path", "description": "Service ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "78c83922-d658-48bf-89d5-0658a6a94e27" } }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" }, { "$ref": "#/components/parameters/Authorization" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnholdserviceRequest" }, "example": { "comment": "The delivery address was changed", "type": "END_CLIENT_PAUSE" } } }, "required": true }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/m4031" }, "example": { "message": "Unauthorized", "requestId": "c482e112-aa73-4dfb-a31c-1586978dfead" } } } }, "404": { "description": "Not Found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/m4041" }, "example": { "type": "exception", "code": "TRP0005E", "data": { "0": "1", "carrierId": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50", "serviceId": "78c83922-d658-48bf-89d5-0658a6a94e27" }, "requestId": "b39a0833-629f-429e-8955-f448165502ac", "date": "2024-03-15T06:22:50.518Z", "message": "Service not found: 'MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50&_78c83922-d658-48bf-89d5-0658a6a94e27'" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/m4031" }, "example": { "message": "Authentication token expired", "requestId": "8c0bbb1b-8486-4d94-8136-8586c0ea2efe" } } } }, "200": { "description": "OK", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceBody6" }, "example": { "message": "Service on hold successfully", "data": { "comment": "The delivery address was changed", "type": "END_CLIENT_PAUSE" } } } } } }, "deprecated": false, "servers": [ { "url": "https://api.pickingnpacking.com/{environment}/v1/tracking/hook", "variables": { "environment": { "default": "DefaultParameterValue" } } } ] } } }, "components": { "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" } }, "Authorization": { "name": "Authorization", "in": "header", "description": "Authentication JWT. JSON Web Token (JWT) is an open standard (RFC 7519) that defines a compact and self-contained way for securely transmitting information as a JSON object between parties.", "required": true, "style": "simple", "schema": { "type": "string", "example": "{token}" } } }, "schemas": { "CreatetokenRequest": { "required": [ "apiKey" ], "type": "object", "properties": { "apiKey": { "type": "string", "description": "The `API KEY` previously generated by the Pick and Pack team. To contact the team, fill out our [form](https://vtex.com/us-en/contact) and indicate the name of the Pick and Pack product in the `Comments` section." } }, "example": { "apiKey": "{pnpApiKey}" } }, "CreateServiceBody": { "type": "object", "properties": { "orderId": { "type": "string", "description": "Order ID." }, "carrierId": { "type": "string", "description": "Carrier ID." }, "seller": { "type": "string", "description": "Identifier representing the seller associated with the order." }, "sender": { "description": "Sender personal information.", "type": "object", "properties": { "name": { "description": "Sender name.", "type": "string" }, "phone": { "description": "Sender phone number.", "type": "string" }, "email": { "description": "Sender email.", "type": "string" }, "city": { "description": "Sender city of residence.", "type": "string" }, "state": { "description": "Sender state of residence.", "type": "string" }, "country": { "description": "Sender country of residence.", "type": "string" }, "address": { "description": "Sender address.", "type": "string" }, "addressComplement": { "description": "Sender address complement, as apartment number.", "type": "string" }, "number": { "description": "Sender residence number.", "type": "string" }, "reference": { "description": "Reference to the sender's address to facilitate localization.", "type": "string" }, "location": { "description": "Object containing specific latitude and longitude of the sender's address.", "type": "object", "properties": { "latitude": { "description": "Sender address' latitude.", "type": "number" }, "longitude": { "description": "Sender address' longitude.", "type": "number" } } }, "pickupDate": { "description": "Package pickup date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.", "type": "string" } } }, "receiver": { "description": "Receiver personal information.", "type": "object", "properties": { "name": { "description": "Receiver name.", "type": "string" }, "phone": { "description": "Receiver phone number.", "type": "string" }, "email": { "description": "Receiver email.", "type": "string" }, "city": { "description": "Receiver city of residence.", "type": "string" }, "state": { "description": "Receiver state of residence.", "type": "string" }, "country": { "description": "Receiver country of residence.", "type": "string" }, "address": { "description": "Receiver address.", "type": "string" }, "addressComplement": { "description": "Receiver address complement, as apartment number.", "type": "string" }, "number": { "description": "Receiver residence number.", "type": "string" }, "reference": { "description": "Reference to the receiver's address to facilitate localization.", "type": "string" }, "location": { "description": "Object containing specific latitude and longitude of the receiver's address.", "type": "object", "properties": { "latitude": { "description": "Receiver address' latitude.", "type": "number" }, "longitude": { "description": "Receiver address' longitude.", "type": "number" } } }, "identification": { "description": "Receiver identification code.", "type": "string" }, "deliveryDate": { "description": "Delivery estimated date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.", "type": "string" }, "contactName": { "description": "Receiver contact name.", "type": "string" }, "deliveryWindow": { "description": "Object containing information about package delivery window.", "type": "object", "properties": { "name": { "description": "Carrier name.", "type": "string" }, "initialDate": { "description": "Delivery initial date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.", "type": "string" }, "finalDate": { "description": "Delivery final date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.", "type": "string" } } } } }, "packages": { "type": "array", "items": { "$ref": "#/components/schemas/Package" }, "description": "Array containing information about all order's packages." }, "carrierServiceType": { "type": "string", "description": "Carrier service type. The `carrierServiceType` value is not limited to these specific values. It will be defined by the carrier integrating with the Pick and Pack Last Mile Protocol API.", "enum": [ "BROKER", "PICKUP_IN_STORE", "NATIONAL", "INTERNATIONAL", "EXPRESS", "SPECIALIZED", "OTHERS" ] }, "type": { "type": "string", "description": "Fulfillment flow type for the order or shipment. This field defines how the item will be handled and routed within the logistics process.\n\rThe acceptable values are:\n\r- `PICKUP`: The customer picks up the product in person at the store or designated [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).\n\r- `DELIVERY`: The product is picked up from a warehouse or distribution center and delivered directly to the customer's home.\n\r- `PICKUP_DELIVERY`: The product is first picked up at the store and then delivered to the customer's home.\n\r- `TRANSFER`: The product is shipped from one store to another store for availability or further processing.\n\r- `RETURN`: The customer returns the product to the store for review or further handling.", "enum": [ "PICKUP", "DELIVERY", "PICKUP_DELIVERY", "TRANSFER", "RETURN" ] }, "paymentMethod": { "type": "string", "description": "Payment method." }, "comments": { "type": "string", "description": "Comments." }, "orderValue": { "type": "integer", "description": "Total value of the order." }, "settings": { "description": "Array of objects with additional custom fields defined by the carrier.", "type": "array", "items": { "description": "Object containing information about a custom field.", "type": "object", "properties": { "label": { "description": "Custom field description.", "type": "string" }, "value": { "description": "Custom field value.", "type": "string" }, "key": { "description": "Custom field key.", "type": "string" } } } }, "timezone": { "$ref": "#/components/schemas/Timezone" } } }, "ServiceBody": { "required": [ "message", "data" ], "type": "object", "properties": { "message": { "type": "string", "description": "Status message about the request." }, "data": { "$ref": "#/components/schemas/Data", "type": "object", "description": "Service general information." } } }, "Data": { "required": [ "id", "orderId", "carrierId", "serviceId", "carrierName", "seller", "status", "type", "tags", "labels", "evidences", "packages", "timeline", "notes", "timezone", "carrierLogo", "trackingUrl", "comments", "paymentMethod", "carrierServiceType", "rate", "shippingEstimatedDate", "shippingFinishedDate", "metaData" ], "properties": { "id": { "type": "string", "description": "Service ID." }, "orderId": { "type": "string", "description": "Order ID." }, "carrierId": { "type": "string", "description": "Carrier ID." }, "serviceId": { "type": "string", "description": "Service ID." }, "carrierName": { "type": "string", "description": "Carrier name." }, "seller": { "type": "string", "description": "Identifier representing the seller associated with the order." }, "status": { "type": "string", "description": "Order [status](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196)." }, "type": { "type": "string", "description": "Order's type of delivery, `Delivery` or [`Pickup`](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R)." }, "tags": { "type": "array", "items": { "type": "string", "description": "Extra information added in the order." }, "description": "Array of tags." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/Label" }, "description": "Array containing information about all shipping labels printed in the order." }, "evidences": { "type": "array", "items": { "type": "string", "description": "Message explaining the delivery incident." }, "description": "Array with additional notes when an incident occurs in the delivery of the package." }, "packages": { "type": "array", "items": { "$ref": "#/components/schemas/Package" }, "description": "Array containing information about all order's packages." }, "timeline": { "type": "array", "items": { "$ref": "#/components/schemas/Timeline" }, "description": "Array containing information about the timeline of order changes." }, "notes": { "type": "array", "items": { "$ref": "#/components/schemas/Note" }, "description": "Array with services information." }, "timezone": { "$ref": "#/components/schemas/Timezone" }, "carrierLogo": { "type": "string", "description": "Carrier logo." }, "trackingUrl": { "type": "string", "description": "Tracking URL." }, "comments": { "type": "string", "description": "Comments." }, "paymentMethod": { "type": "string", "description": "Payment method." }, "carrierServiceType": { "type": "string", "description": "Carrier service type. The `carrierServiceType` value is not limited to these specific values. It will be defined by the carrier integrating with the Pick and Pack Last Mile Protocol API.", "enum": [ "BROKER", "PICKUP_IN_STORE", "NATIONAL", "INTERNATIONAL", "EXPRESS", "SPECIALIZED", "OTHERS" ] }, "rate": { "$ref": "#/components/schemas/Rate" }, "shippingEstimatedDate": { "type": "string", "description": "Shipping estimated date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." }, "shippingFinishedDate": { "type": "string", "nullable": true, "description": "Shipping finished date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." }, "metaData": { "$ref": "#/components/schemas/MetaData1" } }, "example": { "id": "519400fb-f980-4a6a-809c-9f986fdb98a4", "orderId": "46369545534253-01", "carrierId": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50", "serviceId": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50&78c83922-d658-48bf-89d5-0658a6a94e27", "carrierName": "AfterShip", "seller": "lastmile", "status": "DELIVERED", "type": "PICKUP_DELIVERY", "tags": [], "labels": [ { "id": "78c83922-d658-48bf-89d5-0658a6a94e27", "name": "Shipping label", "url": "https://sandbox-download.postmen.com/label/2024-03-09/258a26a4-45ae-49eb-b64d-929d3b81f46d-1709947994279763.pdf", "type": "PDF" } ], "evidences": [], "packages": [ { "id": "a46e5bc1-8959-459f-a094-b6e699f7214c", "orderId": "46369545534253-01", "envelope": "Foam or Plastic Containers", "dimensions": { "height": "5", "length": "11", "width": "7" }, "weight": "48", "totalValue": 5352, "items": [ { "id": "184", "name": "Chicken", "ean": "EAN354", "quantity": 8, "price": 669, "refId": "314", "image": "https://picsum.photos/seed/YtoZ9/128/480", "type": "other", "weight": "6" } ], "categories": [ "Movies", "Garden", "Books" ], "description": "Unde deserunt libero cupiditate illum." } ], "timeline": [ { "id": "77263f59-0ac5-4b0c-bfe5-f17a1648474d", "date": "2024-03-09T01:33:14.917Z", "createdAt": "2024-03-09T01:33:14.917Z", "updatedAt": "2024-03-09T01:33:14.917Z", "type": "STATUS", "description": "Service pending in DEV", "author": "System", "metaData": { "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", "metaData": null, "serviceId": "78c83922-d658-48bf-89d5-0658a6a94e27", "shippingPrice": 284.02, "status": "PENDING", "labels": [ { "name": "Shipping label", "id": "78c83922-d658-48bf-89d5-0658a6a94e27", "type": "PDF", "url": "https://sandbox-download.postmen.com/label/2024-03-09/258a26a4-45ae-49eb-b64d-929d3b81f46d-1709947994279763.pdf" } ] } }, { "id": "9906da15-15e4-4dbd-8e90-c34ec43ed446", "date": "2024-03-09T01:46:20.006Z", "createdAt": "2024-03-09T01:46:20.006Z", "updatedAt": "2024-03-09T01:46:20.006Z", "type": "NOTE", "description": "A new note has been added", "author": "afterShip", "metaData": { "0": { "type": "COMMENT", "note": "The package is delivered at the door", "author": "afterShip" } } }, { "id": "35619274-3bca-4749-8a38-53a62776144a", "date": "2024-03-09T01:44:17.437Z", "createdAt": "2024-03-09T01:44:17.437Z", "updatedAt": "2024-03-09T01:44:17.437Z", "type": "NOTE", "description": "A new note has been added", "author": "afterShip", "metaData": { "0": { "type": "COMMENT", "note": "Tracking Number: 10001709948594168", "author": "afterShip" } } }, { "id": "9b60e3fd-5bf9-43c6-99f2-4292a57fa408", "date": "2024-03-09T01:46:19.689Z", "createdAt": "2024-03-09T01:46:19.689Z", "updatedAt": "2024-03-09T01:46:19.689Z", "type": "STATUS", "description": "The package was delivered", "author": "System", "metaData": { "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", "trackingUrl": "https://tools.usps.com/go/TrackConfirmAction?tLabels=9361289676091361892011", "status": "DELIVERED" } }, { "id": "21c9acaa-e14b-41bd-aaa7-a2cebd7384c0", "date": "2024-03-09T01:43:15.887Z", "createdAt": "2024-03-09T01:43:15.887Z", "updatedAt": "2024-03-09T01:43:15.887Z", "type": "STATUS", "description": "Service pending", "author": "System", "metaData": { "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", "trackingUrl": "https://tools.usps.com/go/TrackConfirmAction?tLabels=9361289676091361892011", "status": "PENDING" } }, { "id": "7a1a3a63-f94c-49f1-a912-bc3f095d7845", "date": "2024-03-09T01:45:18.812Z", "createdAt": "2024-03-09T01:45:18.812Z", "updatedAt": "2024-03-09T01:45:18.812Z", "type": "STATUS", "description": "Courier picked the package", "author": "System", "metaData": { "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", "trackingUrl": "https://tools.usps.com/go/TrackConfirmAction?tLabels=9361289676091361892011", "status": "PICKED" } }, { "id": "9ca25940-bdae-4f19-a5b4-92477abfa059", "date": "2024-03-09T01:33:14.978Z", "createdAt": "2024-03-09T01:33:14.978Z", "updatedAt": "2024-03-09T01:33:14.978Z", "type": "LABEL", "description": "Added a label", "author": "System", "metaData": { "name": "Shipping label", "id": "78c83922-d658-48bf-89d5-0658a6a94e27", "type": "PDF", "url": "https://sandbox-download.postmen.com/label/2024-03-09/258a26a4-45ae-49eb-b64d-929d3b81f46d-1709947994279763.pdf" } }, { "id": "24b84b8b-7418-4ed8-bc89-b6a1cbee2331", "date": "2024-03-09T01:43:16.289Z", "createdAt": "2024-03-09T01:43:16.289Z", "updatedAt": "2024-03-09T01:43:16.289Z", "type": "NOTE", "description": "A new note has been added", "author": "afterShip", "metaData": { "0": { "type": "COMMENT", "note": "Tracking Number: 10001709948594168", "author": "afterShip" } } }, { "id": "9dfad688-e99a-4b27-9ccb-959da40c3bf8", "date": "2024-03-09T01:33:08.385Z", "createdAt": "2024-03-09T01:33:08.385Z", "updatedAt": "2024-03-09T01:33:08.385Z", "type": "STATUS", "description": "Service creation by AfterShip", "author": "System", "metaData": { "status": "CREATED" } }, { "id": "781ab0af-e62a-4a21-a837-8d0eea3f57c2", "date": "2024-03-09T01:44:17.077Z", "createdAt": "2024-03-09T01:44:17.077Z", "updatedAt": "2024-03-09T01:44:17.077Z", "type": "STATUS", "description": "Courier on route", "author": "System", "metaData": { "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", "trackingUrl": "https://tools.usps.com/go/TrackConfirmAction?tLabels=9361289676091361892011", "status": "ON_ROUTE" } } ], "notes": [ { "type": "COMMENT", "date": "2024-03-09T01:43:16.280Z", "content": "Tracking Number: 10001709948594168", "author": "afterShip" }, { "type": "COMMENT", "date": "2024-03-09T01:44:17.423Z", "content": "Tracking Number: 10001709948594168", "author": "afterShip" }, { "type": "COMMENT", "date": "2024-03-09T01:46:19.998Z", "content": "The package is delivered at the door", "author": "afterShip" } ], "timezone": { "offset": 300, "value": "America/Bogota", "label": null }, "carrierLogo": "iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAYAAADDPmHLAAAACXBIWXMAACxLAAAsSwGlPZapAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAtTSURBVHgB7Z1PbBvHFca/WZICXCCFkt6aAGEORZ3YjaVD0d5MpUCL5BIZydGprUOKRBYg+ZQUDSqxSIG0F8uB7PZmufYxruVLghRwRN9S9GDZTpwUPZgB6t6aEE3hAKLEybxdrk3bEnd2dnb+LPcHyJLMFUXqffvem5k3bxgKCF+YGMfmZl18OYEAdXD2pPi6DoZ6dAEbF/+M3/9TrAPGO+DoiG/ooy2+/0JctyE+Omzl8xYKCEMB4At769gMGmDsoHhHDWHEOvJhI/zg/ArGxlpseaMNz/FWAHxubwMIpsVbeDFHgyexIbzEFaC35quH8EoAd43OgyMPu3DLMBEyOFqo1Zo+eQbnBdCP59PCvQujC/fuBy0RJs6y0zdX4TjOCqBv+HmwYMG5u10W8go93nRZCM4JoBCGfxCHheCUAPjsM0cRsEWLSV2+OCgEJwTAX5uoo9I9A39ifDY4XxPDyOMuJIsBLCPu+kVh/FsYFeMTjE2j270VvnfbLwWWGLm7fjcoLFRrU7a8gRUPwI/tO4LK1lWMuvEJyne2uuth/mMB4x5AGP+E+LSAkofhfEkkiE0YxJgAwuFdt3sR5V0/nChBnBEhoQMDGBFAGO+r3fXCDu90YzAvyF0ApfEVMSSCXAVQGj8jBkSQmwBK42siZxHkIoDS+JrJUQTaBRBm+1vdq6XxtbOBWigCraMD/RNBm1tnSuPnwoQYRp+AZrQKgM/uXwTj0yjJi6P89ae1TqJpCwF87mkq1boIH/jOI8BPhE4f+370/e1/AtcvA3e+hhcwNsVWPmlBA1oE4FXSN3UYeGEW2PPd+///y9vA+38CPl6D80RJ4aSOfECPAI7tWxWfjsBlfvBj4OU3gMf3Dr+OhHDhj8C1y3AaMWUs1g0OISOZBRCuYjF2Bq7yPeHmD/8+EkAaPr4EfHAK+O9/4CwsOMRWbmRyWZkE4LTrpzjfeCVy91lYPw+0/uKqEDpiaPhUllCQbRRQ6S45aXyK880Psxs/fq554eB+6uTghlZYM1UVKXuAfkXPLbiEbJxXhfKDc28B//oHnCLDqKAKVaJyLjdQjfNpeezxyBu4lh9wTl6gBQWUPIAziZ+uOK/K+6eBv6+5IQRFL6AmgLl9t6zH/t3G86ZxZ/6gxU59OoWUpBYAn9vfEC5nHbbIO86r4kJ+oOAF0gvg2D4yfgOmMRXns2I3P0jtBVIJwErmH8d5cvm23X0abOUHtdqjaeYF0s0D0LjfJE/88N543ifjE/SaacTwhOFQtbWZarUwnQAYDsIkjV/6Z/hBaNhInssknM2nuVxaAHzuR9PGM3+agqXkylfota+fg2HGw0RdEnkPwHvm50L/Ldbpf/uLKJ76xDf/i17zOy9H78E0vCe9MiudBIrs/yvQ3LMtaBTw/DExJ/8inMaNWcKOGA08KnOhlACsj/0HISFQckXx1SVo/E93vSvrBJJzApJrAeT+HWkmQncWhQVanXvhdftCcLaSKAzZraSrJAXAzGb/MtAfnKp2piytBVCcD2sFzrlZS8jZAZnLEm/r/q7er+AypvMDH6qFCIlJoeRRwNbWBEzx7HORMdNChjj/G5F1v5TvsJHi+8mZ6HepGJ/e27M/gzEkbCcRAnoNI/GfXPlLb0Rfq5ZhxcNG3fkBuXsqFFWN8zSd/fxs9B6JC38wMz/At0kArWGXJAuAw4wHGFzdo9mzA1PqyZWu/EBHnN9p2ZqmuI2QnAckC4CxJ4UIzEN37+G3oztZpUz7m6/vLcio5AfXPgL++o56nKdVy1fetjxKYRpCgCkPsBv0B3z1pHriFecHFFJ+9W6yQbKO591atq4nXTA0CeSv7a3DFegObv4tcqcqiWKcH5x/a+dEkdw9PUZJnorxKc5TDkOv0Z2ahfFwFDeE4R6gWq2LGUA4BQmAxJAlP6APGnHES7XkJW5c1hvnXSE6OWVjt4fVq4JtMpgfqJZhXf8o+siCE3E+gaBSh7IAer26SALhLLbKtH0pTyN62xlCAGN+tGunkBCGhZzLsGyXoedAggD4uJhThjdkzQ+G4XKcHwYbfuaC9W7h2onzg999qMdF03P8+j2R4b/pZ3laghf3MwmUIWt+4FOcz0DxPMCDUEh480K6RZjwZ94rhvE5z7Aa2EMbRWDPI9FwTWYCKb7zfa5GHoSzjMvBRWFPP4NPgtYNRojhAggqRlqWG+PAcxLXpN5f6TZB0B768LAHxSRCG0VCZsauKK4/ptfLkgP0iuUBRpGxsfawh4cKgP358zaio9RL/KSTvSaQlQLwmHbSBckC4L0rKPETzr9IukRiGBhsoMRPGG8lXSIRAlgpAF9hlUTbJQugWi0F4CsStksUQJhFMpQi0ImZrWQbMq1iJKeCef6J4O3PMDJ8aaByicnZTFIAQf5bX2nZdlS4bqIVvZzN5AQQxZJ85wPijRxFh95j/rWLHdl+gVICiGJJL/9blP44RRaBufcn7bHll4NZZRUmoD/Q4s/d68idBXovtHPZlLhZIH2zypeEURjodikM5F8pTC6Sdui40gVEFRvtYxlvpzlFRNoDRMNBfhYmocreuEuYT+3iBruEmfZknLXSXJ6uIqiHVdiA/pjkEXwYKdC+/8W+aG20jqltN9NcnkoA7PRNGg20YIN4l6+r+UHcPYSaP9jqGcT5JbYcLuFLk74snLGm+EUN2MK1/MClY2SCYBkpUTswwlbL+J2g3TppOonP7R/++MonkMK9LmFKB0aobQyx7QUGydIFRBWK8x+cdqs9HNlE5cegiFNeIIZq+l99d3iL9iwewLVuoPdQuvsJ9a1hLnmBGMoPaOilOz9w/TjZ2vYMFFHeGBLONTN2Ei4yOH9AsVqVwfG8u2cJr6bN/AfJtjOoWl2Cy1XDsfHi+QOZ3nzX+l1D6GdsjudlELN+acf9Dz0FMiJygQXx6QRKzMP5jJibWUUGdB0f715CWHxWReKnHPtj9GwOrdUOhe6oxAwaXH+MFgFE9QJBZjWWyBLMZEn87nsmaKI/KtCiypIhMN5UPSl8x6eDZkQ+sCo+SR9aVJICxk+ylZsL0Ij+BhG1Gr3AsoxcO/waqneWoJlcesCFPYarwTo4q6MkO5T0VXtTuuL+fU+NnChFoIkcjR8+PXKkFEFGcjZ++CuQM6UIFDFg/PDXwAClCFJiyPiEkTZxYauZ6tgkbNUT+kVLZPuTJoxPGO8Ezef2L4lFjEWUPEwO4/zEXwkL8NlnjopZQ1pB9KMdff50xE1xPOvKngrWesGXecFdWlTRY8rlP4j1wwBGOCR0qKJKzOsvwSJOnAYReYPKRetH1JnD6l0/iFPHgYS5QYDFwoYFGt710LQR63fDyfNgwjIzxucLJITQ3aP6/2W23HaqhtLZA4HCsBAEDc89grOGj/HiRKj+sHFefOlLjtASie1ZjN1Zc9XwMR4dCRYKYUIIgcLDQQe9Qr9/QrCms2Inb7wSwCBi+NgQd9lRq2Jg1IyZX/LN6IN4K4BB7uYLJsJEmMlXmhjrtlwYxmWlEAKICYVQqVxFflPMHTF+nyyC4WMKdWhU/4CL/CqTab6+QMYnCndqGDv16XIum1Zppc6hCRxdFPPYONq0qnOnUligob8i1wUKlQMM0h8yXoUOattPFc31xxT24Mh+R7PjyE7h4v4ghfUAMRl3LmvZgesyxT86VnXnssYduC5TeA9A9GcN19P9EJ/sh5FCMxKHR6feuUw7cEfA+MRIeIAYyXxAueWaj4zO8fHEdthObffl2Sjuj1Sji5ESQDhVzIZ1MineVG8So+UBQPnAjbUdp4rDzhuf5X84lmOMnABCov6G95K88JSNm0sYQUZSAGFTq+3tQ4jygQ5txETJ6EHVx2G94QjzLdIWvdPvEPp9AAAAAElFTkSuQmCC", "trackingUrl": "https://tools.usps.com/go/TrackConfirmAction?tLabels=9361289676091361892011", "comments": "Comments.", "paymentMethod": "ONLINE", "carrierServiceType": "BROKER", "rate": { "shippingPrice": { "value": 0, "currency": "USD" }, "insurancePrice": { "value": 0, "currency": "USD" } }, "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", "shippingFinishedDate": "2024-01-05T11:11:11.000Z", "metaData": { "integrationResponse": {}, "carrier": { "name": "[FedEx] Postmen Testing Account", "image": null, "metaData": {}, "id": "fedex", "type": { "metaData": {}, "terms": "", "rate": { "shippingPrice": { "value": 284.02, "currency": "USD" }, "insurancePrice": { "value": 0, "currency": "USD" } }, "name": "FedEx First Overnight®", "transitTime": 0, "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", "description": "FedEx", "id": "fedex_first_overnight", "international": false } } } } }, "Label": { "required": [ "id", "name", "url", "type" ], "type": "object", "properties": { "id": { "type": "string", "description": "Label ID." }, "name": { "type": "string", "description": "Name of the label." }, "url": { "type": "string", "description": "Label URL." }, "type": { "type": "string", "description": "Label's type of file." } }, "example": { "id": "78c83922-d658-48bf-89d5-0658a6a94e27", "name": "Shipping label", "url": "https://sandbox-download.postmen.com/label/2024-03-09/258a26a4-45ae-49eb-b64d-929d3b81f46d-1709947994279763.pdf", "type": "PDF" } }, "Package": { "required": [ "id", "orderId", "envelope", "dimensions", "weight", "totalValue", "items", "categories", "description" ], "type": "object", "description": "Package information.", "properties": { "id": { "type": "string", "description": "Package ID." }, "orderId": { "type": "string", "description": "Order ID." }, "envelope": { "type": "string", "description": "Name of the envelope used." }, "dimensions": { "$ref": "#/components/schemas/Dimensions", "description": "Package dimensions." }, "weight": { "type": "string", "description": "Package weight in grams." }, "totalValue": { "type": "integer", "format": "int32", "description": "Total value of the order." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Item", "description": "Product general information." }, "description": "Array containing information about the order's products." }, "categories": { "type": "array", "items": { "type": "string", "description": "Category name." }, "description": "Array of categories." }, "description": { "type": "string", "description": "Package description." } }, "example": { "id": "a46e5bc1-8959-459f-a094-b6e699f7214c", "orderId": "46369545534253-01", "envelope": "Foam or Plastic Containers", "dimensions": { "height": "5", "length": "11", "width": "7" }, "weight": "48", "totalValue": 5352, "items": [ { "id": "184", "name": "Chicken", "ean": "EAN354", "quantity": 8, "price": 669, "refId": "314", "image": "https://picsum.photos/seed/YtoZ9/128/480", "type": "other", "weight": "6" } ], "categories": [ "Movies", "Garden", "Books" ], "description": "Unde deserunt libero cupiditate illum." } }, "Dimensions": { "required": [ "height", "length", "width" ], "type": "object", "properties": { "height": { "type": "string", "description": "Package height in centimeters." }, "length": { "type": "string", "description": "Package length in centimeters." }, "width": { "type": "string", "description": "Package width in centimeters." } }, "example": { "height": "5", "length": "11", "width": "7" } }, "Item": { "title": "Item", "required": [ "id", "name", "ean", "quantity", "price", "refId", "image", "type", "weight" ], "type": "object", "properties": { "id": { "type": "string", "description": "Product ID." }, "name": { "type": "string", "description": "Product name." }, "ean": { "type": "string", "description": "Unique SKU identification code (barcode). Up to 13 numerical characters." }, "quantity": { "type": "integer", "format": "int32", "description": "Quantity of units of the product." }, "price": { "type": "integer", "format": "int32", "description": "Product price in cents." }, "refId": { "type": "string", "description": "Product reference ID." }, "image": { "type": "string", "description": "SKU image." }, "type": { "type": "string", "description": "Item type." }, "weight": { "type": "string", "description": "Product weight in grams." } }, "example": { "id": "184", "name": "Chicken", "ean": "EAN354", "quantity": 8, "price": 669, "refId": "314", "image": "https://picsum.photos/seed/YtoZ9/128/480", "type": "other", "weight": "6" } }, "Timeline": { "required": [ "id", "date", "createdAt", "updatedAt", "type", "description", "author", "metaData" ], "type": "object", "properties": { "id": { "type": "string", "description": "Timeline ID." }, "date": { "type": "string", "description": "Timeline actual date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." }, "createdAt": { "type": "string", "description": "Order's 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`." }, "updatedAt": { "type": "string", "description": "Date of the order's last update in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." }, "type": { "type": "string", "description": "Order status." }, "description": { "type": "string", "description": "Description of the status." }, "author": { "type": "string", "description": "Status author." }, "metaData": { "$ref": "#/components/schemas/MetaData", "description": "Metadata about the delivery information." } }, "example": { "id": "77263f59-0ac5-4b0c-bfe5-f17a1648474d", "date": "2024-03-09T01:33:14.917Z", "createdAt": "2024-03-09T01:33:14.917Z", "updatedAt": "2024-03-09T01:33:14.917Z", "type": "STATUS", "description": "Service pending in DEV", "author": "System", "metaData": { "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", "metaData": null, "serviceId": "78c83922-d658-48bf-89d5-0658a6a94e27", "shippingPrice": 284.02, "status": "PENDING", "labels": [ { "name": "Shipping label", "id": "78c83922-d658-48bf-89d5-0658a6a94e27", "type": "PDF", "url": "https://sandbox-download.postmen.com/label/2024-03-09/258a26a4-45ae-49eb-b64d-929d3b81f46d-1709947994279763.pdf" } ] } } }, "MetaData": { "title": "MetaData", "type": "object", "properties": { "shippingEstimatedDate": { "type": "string", "nullable": true, "description": "Order's Shipping estimated date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." }, "metaData": { "type": "string", "nullable": true, "description": "Metadata." }, "serviceId": { "type": "string", "description": "Service ID." }, "shippingPrice": { "type": "number", "description": "Order's shipping price in cents." }, "status": { "type": "string", "description": "Shipping status." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/Label" }, "description": "Shipping labels, there may be more than one per order due to breakage in packages." }, "0": { "$ref": "#/components/schemas/generatedObject", "description": "Item ID in the cart." }, "trackingUrl": { "type": "string", "description": "Carrier's tracking URL of the order." }, "name": { "type": "string", "description": "Carrier name." }, "id": { "type": "string", "description": "Tracking ID." }, "type": { "type": "string", "description": "Type of transportation." }, "url": { "type": "string", "description": "Carrier URL." } }, "example": { "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", "metaData": null, "serviceId": "78c83922-d658-48bf-89d5-0658a6a94e27", "shippingPrice": 284.02, "status": "PENDING", "labels": [ { "name": "Shipping label", "id": "78c83922-d658-48bf-89d5-0658a6a94e27", "type": "PDF", "url": "https://sandbox-download.postmen.com/label/2024-03-09/258a26a4-45ae-49eb-b64d-929d3b81f46d-1709947994279763.pdf" } ] } }, "generatedObject": { "required": [ "type", "note", "author" ], "type": "object", "properties": { "type": { "type": "string", "description": "Type of extra information about the item's shipping." }, "note": { "type": "string", "description": "Text with extra information about the item's shipping." }, "author": { "type": "string", "description": "Author." } }, "example": { "type": "COMMENT", "note": "The package is delivered at the door", "author": "afterShip" } }, "Note": { "required": [ "type", "date", "content", "author" ], "type": "object", "description": "Notes with delivery information.", "properties": { "type": { "type": "string", "description": "Type of note." }, "date": { "type": "string", "description": "Date of creation of the note in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." }, "content": { "type": "string", "description": "Content of the note." }, "author": { "type": "string", "description": "Author of the note." } }, "example": { "type": "COMMENT", "date": "2024-03-09T01:43:16.280Z", "content": "Tracking Number: 10001709948594168", "author": "afterShip" } }, "Timezone": { "required": [ "offset", "value", "label" ], "type": "object", "description": "Time zone information.", "properties": { "offset": { "type": "integer", "format": "int32", "description": "Time zone offset." }, "value": { "type": "string", "description": "Time zone." }, "label": { "type": "string", "nullable": true, "description": "Label." } }, "example": { "offset": 300, "value": "America/Bogota", "label": null } }, "Rate": { "required": [ "shippingPrice", "insurancePrice" ], "type": "object", "description": "Rate cost information.", "properties": { "shippingPrice": { "$ref": "#/components/schemas/ShippingPrice" }, "insurancePrice": { "$ref": "#/components/schemas/InsurancePrice" } }, "example": { "shippingPrice": { "value": 0, "currency": "USD" }, "insurancePrice": { "value": 0, "currency": "USD" } } }, "ShippingPrice": { "required": [ "value", "currency" ], "type": "object", "description": "Shipping cost information.", "properties": { "value": { "type": "integer", "format": "int32", "description": "Shipping cost in cents." }, "currency": { "type": "string", "description": "Currency code in [ISO 4217](https://www.iban.com/currency-codes) format." } }, "example": { "value": 0, "currency": "USD" } }, "InsurancePrice": { "required": [ "value", "currency" ], "type": "object", "description": "Insurance cost information.", "properties": { "value": { "type": "integer", "format": "int32", "description": "Insurance cost in cents." }, "currency": { "type": "string", "description": "Currency code in [ISO 4217](https://www.iban.com/currency-codes) format." } }, "example": { "value": 0, "currency": "USD" } }, "MetaData1": { "required": [ "integrationResponse", "carrier" ], "type": "object", "description": "Metadata about the Carrier.", "properties": { "integrationResponse": { "type": "object", "description": "Carrier integration information." }, "carrier": { "$ref": "#/components/schemas/Carrier" } }, "example": { "integrationResponse": {}, "carrier": { "name": "[FedEx] Postmen Testing Account", "image": null, "metaData": {}, "id": "fedex", "type": { "metaData": {}, "terms": "", "rate": { "shippingPrice": { "value": 284.02, "currency": "USD" }, "insurancePrice": { "value": 0, "currency": "USD" } }, "name": "FedEx First Overnight®", "transitTime": 0, "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", "description": "FedEx", "id": "fedex_first_overnight", "international": false } } } }, "Carrier": { "required": [ "name", "image", "metaData", "id", "type" ], "type": "object", "description": "Object containing information about a carrier.", "properties": { "name": { "type": "string", "description": "Carrier name." }, "image": { "type": "string", "nullable": true, "description": "Carrier logo." }, "metaData": { "type": "object", "description": "Carrier metadata." }, "id": { "type": "string", "description": "Carrier ID." }, "type": { "$ref": "#/components/schemas/Type", "description": "Carrier type." } }, "example": { "name": "[FedEx] Postmen Testing Account", "image": null, "metaData": {}, "id": "fedex", "type": { "metaData": {}, "terms": "", "rate": { "shippingPrice": { "value": 284.02, "currency": "USD" }, "insurancePrice": { "value": 0, "currency": "USD" } }, "name": "FedEx First Overnight®", "transitTime": 0, "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", "description": "FedEx", "id": "fedex_first_overnight", "international": false } } }, "Type": { "title": "Type", "required": [ "metaData", "terms", "rate", "name", "transitTime", "shippingEstimatedDate", "description", "id", "international" ], "type": "object", "properties": { "metaData": { "type": "object", "description": "Carrier metadata." }, "terms": { "type": "string", "description": "Carrier terms." }, "rate": { "$ref": "#/components/schemas/Rate1", "description": "Carrier rate." }, "name": { "type": "string", "description": "Carrier name." }, "transitTime": { "type": "integer", "format": "int32", "description": "Carrier transit time." }, "shippingEstimatedDate": { "type": "string", "nullable": true, "description": "Carrier Shipping estimated date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." }, "description": { "type": "string", "description": "Carrier description." }, "id": { "type": "string", "description": "Carrier ID." }, "international": { "type": "boolean", "description": "Defines if the carrier is international (`true`) or not (`false`)." } }, "example": { "metaData": {}, "terms": "", "rate": { "shippingPrice": { "value": 284.02, "currency": "USD" }, "insurancePrice": { "value": 0, "currency": "USD" } }, "name": "FedEx First Overnight®", "transitTime": 0, "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", "description": "", "id": "fedex_first_overnight", "international": false } }, "Rate1": { "required": [ "shippingPrice", "insurancePrice" ], "type": "object", "description": "Rate cost information.", "properties": { "shippingPrice": { "$ref": "#/components/schemas/ShippingPrice1" }, "insurancePrice": { "$ref": "#/components/schemas/InsurancePrice" } }, "example": { "shippingPrice": { "value": 284.02, "currency": "USD" }, "insurancePrice": { "value": 0, "currency": "USD" } } }, "ShippingPrice1": { "required": [ "value", "currency" ], "type": "object", "description": "Shipping cost information.", "properties": { "value": { "type": "integer", "format": "int32", "description": "Shipping cost in cents." }, "currency": { "type": "string", "description": "Cost currency code in [ISO 4217](https://www.iban.com/currency-codes) format.." } }, "example": { "value": 284.02, "currency": "USD" } }, "m4031": { "required": [ "message", "requestId" ], "type": "object", "description": "Request information.", "properties": { "message": { "type": "string", "description": "Request message." }, "requestId": { "type": "string", "description": "Request ID." } }, "example": { "message": "Invalid token", "requestId": "09563f82-fe06-4004-b623-85e3aa4c92c9" } }, "Data1": { "required": [ "0", "carrierId", "serviceId" ], "type": "object", "description": "Request data.", "properties": { "0": { "type": "string", "description": "Request item." }, "carrierId": { "type": "string", "description": "Carrier ID." }, "serviceId": { "type": "string", "description": "Service ID." } }, "example": { "0": "1", "carrierId": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50", "serviceId": "78c83922-d658-48bf-89d5-0658a6a94e27" } }, "m4041": { "required": [ "type", "code", "data", "requestId", "date", "message" ], "type": "object", "description": "Request information.", "properties": { "type": { "type": "string", "description": "Type of request." }, "code": { "type": "string", "description": "Request code." }, "data": { "$ref": "#/components/schemas/Data1" }, "requestId": { "type": "string", "description": "Request ID." }, "date": { "type": "string", "description": "Request date." }, "message": { "type": "string", "description": "Request message." } }, "example": { "type": "exception", "code": "TRP0005E", "data": { "0": "1", "carrierId": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50", "serviceId": "78c83922-d658-48bf-89d5-0658a6a94e27" }, "requestId": "9e3ce442-458c-4861-99aa-23b2cd2da9cf", "date": "2024-03-15T06:00:21.009Z", "message": "Service not found: 'MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50&78c83922-d658-48bf-89d5-0658a6a94e27'" } }, "UpdateserviceRequest": { "required": [ "status", "agent", "trackingUrl", "totalDistanceTraveled", "rating", "shippingPrice", "shippingEstimatedDate" ], "type": "object", "properties": { "status": { "type": "string", "description": "Delivery status." }, "agent": { "type": "string", "nullable": true, "description": "Delivery agent." }, "trackingUrl": { "type": "string", "description": "Delivery tracking URL." }, "totalDistanceTraveled": { "type": "string", "nullable": true, "description": "Delivery total distance traveled in kilometers." }, "rating": { "type": "string", "nullable": true, "description": "Rating." }, "shippingPrice": { "type": "string", "nullable": true, "description": "Delivery shipping price in cents." }, "shippingEstimatedDate": { "type": "string", "nullable": true, "description": "Shipping estimated date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." } }, "example": { "status": "DELIVERED", "agent": null, "trackingUrl": "https://localhost.com", "totalDistanceTraveled": null, "rating": null, "shippingPrice": null, "shippingEstimatedDate": "2024-01-05T11:11:11.000Z" } }, "ServiceBody1": { "required": [ "message", "data" ], "type": "object", "properties": { "message": { "type": "string", "description": "Service message." }, "data": { "$ref": "#/components/schemas/Data3", "description": "Service data." } }, "example": { "message": "Service updated successfully", "data": { "status": "PENDING", "agent": { "id": "27327489234", "name": "Pedro", "identification": "020323809", "phone": "+57314855674", "email": "pedro434234@gmailc.om", "vehicle": "SCOOTER" }, "trackingUrl": "https://localhost.com", "totalDistanceTraveled": 2, "rating": 5, "shippingPrice": 150000, "shippingEstimatedDate": "2024-04-27T20:25:45.067Z" } } }, "Data3": { "required": [ "status", "agent", "trackingUrl", "totalDistanceTraveled", "rating", "shippingPrice", "shippingEstimatedDate" ], "type": "object", "properties": { "status": { "type": "string", "description": "Service status." }, "agent": { "$ref": "#/components/schemas/Agent", "description": "Service agent." }, "trackingUrl": { "type": "string", "description": "Service tracking URL." }, "totalDistanceTraveled": { "type": "integer", "format": "int32", "description": "Delivery total distance traveled in kilometers." }, "rating": { "type": "integer", "format": "int32", "description": "Rating." }, "shippingPrice": { "type": "integer", "format": "int32", "description": "Shipping price." }, "shippingEstimatedDate": { "type": "string", "description": "Shipping estimated date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." } }, "example": { "status": "PENDING", "agent": { "id": "27327489234", "name": "Pedro", "identification": "020323809", "phone": "+57314855674", "email": "pedro434234@gmailc.om", "vehicle": "SCOOTER" }, "trackingUrl": "https://localhost.com", "totalDistanceTraveled": 2, "rating": 5, "shippingPrice": 150000, "shippingEstimatedDate": "2024-04-27T20:25:45.067Z" } }, "Agent": { "required": [ "id", "name", "identification", "phone", "email", "vehicle" ], "type": "object", "properties": { "id": { "type": "string", "description": "Agent ID." }, "name": { "type": "string", "description": "Agent name." }, "identification": { "type": "string", "description": "Agent identification." }, "phone": { "type": "string", "description": "Agent phone number." }, "email": { "type": "string", "description": "Agent email." }, "vehicle": { "type": "string", "description": "Agent vehicle." } }, "example": { "id": "27327489234", "name": "Pedro", "identification": "020323809", "phone": "+57314855674", "email": "pedro434234@gmailc.om", "vehicle": "SCOOTER" } }, "CreatenotesRequest": { "required": [ "type", "note", "author" ], "type": "object", "properties": { "type": { "type": "string", "description": "Note's type." }, "note": { "type": "string", "description": "Note's text." }, "author": { "type": "string", "description": "Note's author." } }, "example": { "type": "ERROR", "note": "The package takes time to be shipped", "author": "Oscar Rojas" } }, "ServiceBody3": { "required": [ "message", "data" ], "type": "object", "properties": { "message": { "type": "string", "description": "Service message." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Data9" }, "description": "Service data." } }, "example": { "message": "Notes saved successfully", "data": [ { "type": "ERROR", "note": "The package takes time to be shipped", "author": "Oscar Rojas" }, { "type": "COMMENT", "note": "The package was picked up", "author": "Oscar Rojas" } ] } }, "Data9": { "required": [ "type", "note", "author" ], "type": "object", "properties": { "type": { "type": "string", "description": "Note's type." }, "note": { "type": "string", "description": "Note's text." }, "author": { "type": "string", "description": "Note's author." } }, "example": { "type": "ERROR", "note": "The package takes time to be shipped", "author": "Oscar Rojas" } }, "CreateevidenceRequest": { "required": [ "type", "content", "author" ], "type": "object", "properties": { "type": { "type": "string", "description": "Note's type." }, "note": { "type": "string", "description": "Note's text." }, "author": { "type": "string", "description": "Note's author." } }, "example": { "type": "IMAGE", "content": "https://parkers-images.bauersecure.com/wp-images/18727/courier-van-insurance-01.jpg", "author": "Felipe Cardenas" } }, "ServiceBody4": { "required": [ "message", "data" ], "type": "object", "properties": { "message": { "type": "string", "description": "Service message." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Data12" }, "description": "Service data." } }, "example": { "message": "Evidences saved successfully", "data": [ { "type": "IMAGE", "content": "https://parkers-images.bauersecure.com/wp-images/18727/courier-van-insurance-01.jpg", "author": "Felipe Cardenas" }, { "type": "TEXT", "content": "The package was delivered", "author": "Felipe Cardenas" } ] } }, "Data12": { "required": [ "type", "content", "author" ], "type": "object", "properties": { "type": { "type": "string", "description": "Note's type." }, "note": { "type": "string", "description": "Note's text." }, "author": { "type": "string", "description": "Note's author." } }, "example": { "type": "IMAGE", "content": "https://parkers-images.bauersecure.com/wp-images/18727/courier-van-insurance-01.jpg", "author": "Felipe Cardenas" } }, "CreatelabelsRequest": { "required": [ "id", "url", "name", "type" ], "type": "object", "properties": { "id": { "type": "string", "description": "Label ID." }, "url": { "type": "string", "description": "Label URL." }, "name": { "type": "string", "description": "Label name." }, "type": { "type": "string", "description": "Label type." } }, "example": { "id": "JADF8ADF89-7AD7AF-78ADFASDF", "url": "http://s3://mybucket-alpha/orc/2013-10-04-custdata/label-pickup.pdf", "name": "Delivery label", "type": "PDF" } }, "ServiceBody5": { "required": [ "message", "data" ], "type": "object", "properties": { "message": { "type": "string", "description": "Service message." }, "data": { "$ref": "#/components/schemas/Data15", "description": "Service data." } }, "example": { "message": "Label saved successfully", "data": { "id": "JADF8ADF89-7AD7AF-78ADFASDF", "url": "http://s3://mybucket-alpha/orc/2013-10-04-custdata/label-pickup.pdf", "name": "Delivery label", "type": "PDF" } } }, "Data15": { "required": [ "id", "url", "name", "type" ], "type": "object", "properties": { "id": { "type": "string", "description": "Label ID." }, "url": { "type": "string", "description": "Label URL." }, "name": { "type": "string", "description": "Label name." }, "type": { "type": "string", "description": "Label type." } }, "example": { "id": "JADF8ADF89-7AD7AF-78ADFASDF", "url": "http://s3://mybucket-alpha/orc/2013-10-04-custdata/label-pickup.pdf", "name": "Delivery label", "type": "PDF" } }, "CancelOngoingServiceRequest": { "required": [ "comment", "type" ], "type": "object", "properties": { "comment": { "type": "string", "description": "Service comment." }, "type": { "type": "string", "description": "Service type." } }, "example": { "comment": "The delivery address was changed", "type": "END_CLIENT_CANCELED" } }, "ServiceBody6": { "required": [ "message", "data" ], "type": "object", "properties": { "message": { "type": "string", "description": "Service message." }, "data": { "$ref": "#/components/schemas/Data18", "description": "Service data." } }, "example": { "message": "Service canceled successfully", "data": { "comment": "The delivery address was changed", "type": "END_CLIENT_CANCELED" } } }, "Data18": { "required": [ "comment", "type" ], "type": "object", "properties": { "comment": { "type": "string", "description": "Service comment." }, "type": { "type": "string", "description": "Service type." } }, "example": { "comment": "The delivery address was changed", "type": "END_CLIENT_CANCELED" } }, "OnholdserviceRequest": { "required": [ "comment", "type" ], "type": "object", "properties": { "comment": { "type": "string", "description": "Service comment." }, "type": { "type": "string", "description": "Service type." } }, "example": { "comment": "The delivery address was changed", "type": "END_CLIENT_PAUSE" } }, "ResponseService": { "type": "object", "required": [ "status", "serviceId", "shippingPrice", "metaData", "shippingEstimatedDate", "labels" ], "properties": { "status": { "type": "string", "example": "PENDING", "description": "Status of the service.", "enum": [ "PENDING", "ASSIGNED", "PICKED", "ON_ROUTE", "INCIDENT", "RETURNED", "DELIVERED", "CANCELED", "ON_HOLD" ] }, "serviceId": { "type": "string", "example": "ASDF23324KDSF2", "description": "Service ID." }, "shippingPrice": { "type": "number", "example": 20000.09, "description": "Service shipping price." }, "metaData": { "type": "object", "properties": { "{keyValue}": { "description": "Carrier additional information.", "type": "string" } }, "example": { "anyKey": "anyValue" } }, "shippingEstimatedDate": { "type": "string", "example": "2024-05-29T22:36:37.589Z", "description": "Shipping estimated date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/Label" }, "description": "Shipping labels, there may be more than one per order due to breakage in packages." } } }, "ListRequest": { "type": "object", "required": [ "settings" ], "properties": { "settings": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "example":"Api key", "description": "Custom label." }, "key": { "type": "string", "example": "aftership-api-key", "description": "Custom key." }, "value": { "type": "string", "example":"8f_XXXXXXXXX_db79", "description": "Custom value." } } } } } }, "CancelServiceRequest":{ "type": "object", "required": [ "serviceId", "carrierId", "settings", "reason", "metaData" ], "properties": { "serviceId": { "type": "string", "example": "apknieot924892jaf-1231", "description": "Service ID." }, "carrierId": { "type": "string", "example": "servientrega9234jaf", "description": "Carrier ID." }, "settings": { "type": "array", "description": "Array of custom fields.", "items": { "type": "object", "required": [ "label", "key", "value" ], "properties": { "label": { "type": "string", "example": "Cliente ID", "description": "Custom label." }, "key": { "type": "string", "example": "clientId", "description": "Custom key." }, "value": { "type": "string", "example": "HUR123", "description": "Custom value." } } } }, "reason": { "type": "string", "example": "La dirección de entrega esta mal registrada", "description": "Reason for the cancelation." }, "metaData": { "type": "object", "description": "Object containing service metadata.", "properties": { "myFieldCustom": { "type": "string", "example": "custom value", "description": "Custom value." } } } } }, "CancelServiceResponse":{ "type": "object", "required": [ "message", "data" ], "properties": { "message": { "type": "string", "example": "Service executed successfully", "description": "Message of successful cancelation." }, "data": { "type": "object", "description": "Object containing service information.", "required": [ "serviceId", "carrierId", "reason" ], "properties": { "serviceId": { "type": "string", "description": "Service ID.", "example": "apknieot924892jaf-1231" }, "carrierId": { "type": "string", "description": "Carrier ID.", "example": "servientrega9234jaf" }, "reason": { "type": "string", "example": "En el lugar de residencia no hay quien reciba el paquete", "description": "Reason for the cancelation." } } } } }, "PauseResumeServiceRequest":{ "type": "object", "required": [ "serviceId", "carrierId", "settings", "reason", "metaData" ], "properties": { "serviceId": { "type": "string", "example": "apknieot924892jaf-1231", "description": "Service ID." }, "carrierId": { "type": "string", "example": "servientrega9234jaf", "description": "Carrier ID." }, "pause":{ "type": "boolean", "description": "Condition that the service is paused (`false`) or not (`true`).", "example": false }, "settings": { "type": "array", "description": "Array of custom fields.", "items": { "type": "object", "required": [ "label", "key", "value" ], "properties": { "label": { "type": "string", "example": "Cliente ID", "description": "Custom label." }, "key": { "type": "string", "example": "clientId", "description": "Custom key." }, "value": { "type": "string", "example": "HUR123", "description": "Custom value." } } } }, "reason": { "type": "string", "example": "La dirección de entrega esta mal registrada", "description": "Reason for the pause or resume." }, "metaData": { "type": "object", "description": "Object containing service metadata.", "properties": { "myFieldCustom": { "type": "string", "example": "custom value", "description": "Custom value." } } } } }, "PauseResumeServiceResponse":{ "type": "object", "required": [ "message", "data" ], "properties": { "message": { "type": "string", "example": "Service executed successfully", "description": "Message of successful cancelation." }, "data": { "type": "object", "description": "Object containing service information.", "required": [ "serviceId", "carrierId", "reason" ], "properties": { "serviceId": { "type": "string", "description": "Service ID.", "example": "apknieot924892jaf-1231" }, "carrierId": { "type": "string", "description": "Carrier ID.", "example": "servientrega9234jaf" }, "cancel": { "type": "boolean", "description": "Condition that the service is paused (`false`) or not (`true`).", "example": false }, "reason": { "type": "string", "example": "En el lugar de residencia no hay quien reciba el paquete", "description": "Reason for the cancelation." } } } } } } }, "tags": [ { "name": "Authentication" }, { "name": "Service integration", "description": "These endpoints must be developed to integrate with the Lastmile Pick and Pack Last Mile Protocol API." }, { "name": "Shipping updates", "description": "This endpoint will allow the carriers to update an ongoing shipping service." }, { "name": "Carriers" } ] }