{"info":{"_postman_id":"0d1a8315-c275-4fa7-832e-e600984139b6","name":"Gori API Documentation","description":"

Authentication

\n

Send your access token as a Bearer Token using Authorization header

\n

Error Response Format

\n
{\n    \"name\": \"USER:UNAUTHORIZED\",\n    \"message\": \"Your request was made with invalid credentials.\",\n    \"code\": 0,\n    \"status\": 401\n}\n
","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"15216803","collectionId":"0d1a8315-c275-4fa7-832e-e600984139b6","publishedId":"TzRUCSqg","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-09-14T16:15:59.000Z"},"item":[{"name":"v1","item":[{"name":"Account","item":[{"name":"Check Meter Balance","id":"d4a68cc4-ccc2-423d-aca7-b34c4fed146b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{api_url}}/v1/meter","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","name":"v1","type":"folder"}},"urlObject":{"path":["v1","meter"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"2c1c0b22-7ba5-487d-9f47-b03a583469c5","name":"Example Response","originalRequest":{"method":"GET","header":[],"url":"{{api_url}}/v1/meter"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"name\": \"Test Meter\",\r\n \"balance\": \"895.50\",\r\n \"is-enabled\": true\r\n}"},{"id":"cb498d0d-0397-4e92-a5b6-5334ffcf2642","name":"Example Error","originalRequest":{"method":"GET","header":[],"url":"{{api_url}}/v1/meter"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"name\": \"USER:UNAUTHORIZED\",\r\n \"message\": \"Your request was made with invalid credentials.\",\r\n \"code\": 0,\r\n \"status\": 401\r\n}"}],"_postman_id":"d4a68cc4-ccc2-423d-aca7-b34c4fed146b"}],"id":"be3570b2-c5d8-4c79-b07d-585f6379e86a","_postman_id":"be3570b2-c5d8-4c79-b07d-585f6379e86a","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","name":"v1","type":"folder"}}},{"name":"Shipments","item":[{"name":"Verify Address","id":"c2c24218-5354-4654-bf16-eb41b1cfb83b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"address\": {\r\n \"street1\": \"7372 Walnut Ave\",\r\n \"street2\": \"Ste N\",\r\n \"city\": \"Buena Park\",\r\n \"state\": \"CA\",\r\n \"zip\": \"11111\",\r\n \"country\": \"US\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/v1/addresses","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","name":"v1","type":"folder"}},"urlObject":{"path":["v1","addresses"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"cff2734a-4b5a-4248-b7f3-011aafd52b4f","name":"Example Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"address\": {\r\n \"street1\": \"7372 Walnut Ave\",\r\n \"street2\": \"Ste N\",\r\n \"city\": \"Buena Park\",\r\n \"state\": \"CA\",\r\n \"zip\": \"11111\",\r\n \"country\": \"US\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/v1/addresses"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"street1\": \"7372 WALNUT AVE STE N\",\n \"street2\": \"\",\n \"city\": \"BUENA PARK\",\n \"state\": \"CA\",\n \"zip\": \"90620-1749\",\n \"country\": \"US\",\n \"verifications\": {\n \"zip4\": {\n \"success\": true,\n \"errors\": [],\n \"details\": null\n },\n \"delivery\": {\n \"success\": true,\n \"errors\": [],\n \"details\": {\n \"latitude\": 33.85726,\n \"longitude\": -118.00451,\n \"time_zone\": \"America/Los_Angeles\"\n }\n }\n }\n}"}],"_postman_id":"c2c24218-5354-4654-bf16-eb41b1cfb83b"},{"name":"Create Shipment","event":[{"listen":"test","script":{"id":"211c61f4-4968-4148-b34a-54798517ed71","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript"}}],"id":"462e5067-f867-4bec-bd85-972774572895","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"shipment\": {\r\n \"service\": \"usps_priority\",\r\n \"to_address\": {\r\n \"company\": \"A company\",\r\n \"first_name\": \"John\",\r\n \"last_name\": \"Doe\",\r\n \"street1\": \"2225 San Anseline Ave\",\r\n \"street2\": \"\",\r\n \"city\": \"Long Beach\",\r\n \"state\": \"CA\",\r\n \"zip\": \"90815\",\r\n \"country\": \"US\",\r\n \"phone\": null,\r\n \"email\": null,\r\n \"is_residential\": true\r\n },\r\n \"from_address\": {\r\n \"company\": \"Gori Company\",\r\n \"first_name\": \"Jane\",\r\n \"last_name\": \"Doe\",\r\n \"street1\": \"10450 Pioneer Ave\",\r\n \"street2\": \"Ste 4\",\r\n \"city\": \"Santa Fe Springs\",\r\n \"state\": \"CA\",\r\n \"zip\": \"90670\",\r\n \"phone\": \"1231231234\",\r\n \"country\": \"US\"\r\n },\r\n \"parcel\": {\r\n \"length\": 6,\r\n \"width\": 4,\r\n \"height\": 1,\r\n \"weight\": 10,\r\n \"package_type\": null\r\n },\r\n \"reference1\": \"12345\",\r\n \"service_options\": {\r\n \"verify_address\": false,\r\n \"confirmation\": false,\r\n \"label_type\": \"pdf\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/v1/shipments","description":"

Unit for weight is ounces and length is inches

\n

The return_address is optional and we will use the from_address by default.

\n

Possible values for service. Please check your contract as some services might be available.

\n\n

Optional Fields

\n\n

USPS priority service accepts different package types which you can chose from below. By default, it is custom_package

\n\n

Possible values forservice_options.confirmation are signature, signature_restricted, adult_signature, or adult_signature_restricted

\n

pdf is the default label type for service_options.label_typeavailable options are pdf, zpl, and png

\n

Return Address

\n
\"return_address\": {\n    \"first_name\": \"Return Warehouse\",\n    \"street1\": \"7101 S Central Ave\",\n    \"city\": \"Los Angeles\",\n    \"state\": \"CA\",\n    \"zip\": \"90001\",\n    \"country\": \"US\"\n},\n\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","name":"v1","type":"folder"}},"urlObject":{"path":["v1","shipments"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"fcf5d9b4-29fe-4b37-b33f-e5bb59b07e44","name":"Example Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"shipment\": {\r\n \"to_address\": {\r\n \"first_name\": \"Jane\",\r\n \"last_name\": \"Doe\",\r\n \"company\": null,\r\n \"street1\": \"179 N Harbor Dr\",\r\n \"street2\": null,\r\n \"city\": \"Redondo Beach\",\r\n \"state\": \"CA\",\r\n \"zip\": \"90277\",\r\n \"country\": \"US\",\r\n \"phone\": \"4153334444\",\r\n \"email\": \"dr_steve_brule@gmail.com\"\r\n },\r\n \"from_address\": {\r\n \"first_name\": \"John\",\r\n \"last_name\": \"Doe\",\r\n \"company\": null,\r\n \"street1\": \"7372 Walnut Ave\",\r\n \"street2\": \"Ste N\",\r\n \"city\": \"Buena Park\",\r\n \"state\": \"CA\",\r\n \"zip\": \"90620\",\r\n \"country\": \"US\",\r\n \"phone\": \"4153334444\",\r\n \"email\": \"support@easypost.com\"\r\n },\r\n \"parcel\": {\r\n \"length\": 20.2,\r\n \"width\": 10.9,\r\n \"height\": 5.0,\r\n \"weight\": 13\r\n },\r\n \"service\": \"usps_first\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/v1/shipments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"mode\": \"test\",\n \"tracking_code\": \"420902779200190280422500000237\",\n \"zone\": \"1\",\n \"service\": \"first\",\n \"carrier\": \"usps\",\n \"label\": {\n \"image_url\": \"https://dev.goricompany.com/label/420902779200190280422500000237.pdf\"\n },\n \"to_address\": {\n \"name\": \"JANE DOE\",\n \"company\": \"\",\n \"street1\": \"179 N HARBOR DR\",\n \"street2\": \"\",\n \"city\": \"REDONDO BEACH\",\n \"state\": \"CA\",\n \"zip\": \"90277-2506\"\n },\n \"fees\": [\n {\n \"amount\": 5.19,\n \"type\": \"postage\"\n },\n {\n \"amount\": 0.22,\n \"type\": \"customs\"\n }\n ],\n \"refund\": null,\n \"reference_1\": \"12345\",\n \"reference_2\": null\n}"}],"_postman_id":"462e5067-f867-4bec-bd85-972774572895"},{"name":"Create Shipment with Customs (ex: APO/FPO Addresses)","event":[{"listen":"test","script":{"id":"be1378c4-f904-41c6-a2d2-72939d4ae40e","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript"}}],"id":"a2de462a-a7f5-43cc-8260-237260d15d87","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"shipment\": {\r\n \"service\": \"usps_priority\",\r\n \"to_address\": {\r\n \"company\": \"A company\",\r\n \"first_name\": \"John\",\r\n \"last_name\": \"Doe\",\r\n \"street1\": \"UNIT 2050 BOX 4190\",\r\n \"street2\": \"\",\r\n \"city\": \"APO\",\r\n \"state\": \"AP\",\r\n \"zip\": \"96278\",\r\n \"country\": \"US\",\r\n \"phone\": \"123-123-1234\",\r\n \"email\": null,\r\n \"is_residential\": false\r\n },\r\n \"from_address\": {\r\n \"company\": \"Gori Company\",\r\n \"street1\": \"10450 Pioneer Ave\",\r\n \"street2\": \"Ste 4\",\r\n \"city\": \"Santa Fe Springs\",\r\n \"state\": \"CA\",\r\n \"zip\": \"90670\",\r\n \"phone\": \"1231231234\",\r\n \"country\": \"US\"\r\n },\r\n \"parcel\": {\r\n \"length\": 6,\r\n \"width\": 4,\r\n \"height\": 1,\r\n \"weight\": 10\r\n },\r\n \"customs\": {\r\n \"content_type\": \"merchandise\",\r\n \"items\": [\r\n {\r\n \"description\": \"office supply\",\r\n \"quantity\": \"2\",\r\n \"value\": 15,\r\n \"weight\": 10\r\n }\r\n ]\r\n },\r\n \"service_options\": {\r\n \"verify_address\": false\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/v1/shipments","description":"

Military Mail and some U.S. Possessions, Territories, and Freely Associated States (PTFAS) shipments also require customs documentation. See link for details

\n

https://pe.usps.com/text/dmm300/608.htm#ep1274629

\n

Available values for content_type

\n

* merchandise
* gift
* documents
* sample
* return
* humanitarian
* dangerousgoods
* other

\n

Notes

\n

* Unit for weight is ounces
* phone is required for all addresses
* content_description is required if content_type is other

\n
\"customs\": {\n    \"content_type\": \"other\",\n    \"content_description\": \"supplies\",\n    \"items\": [\n        {\n            \"description\": \"office supply\",\n            \"quantity\": \"2\",\n            \"value\": 15,\n            \"weight\": 20\n        }\n    ]\n},\n\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","name":"v1","type":"folder"}},"urlObject":{"path":["v1","shipments"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a2de462a-a7f5-43cc-8260-237260d15d87"},{"name":"Create International Shipments","event":[{"listen":"test","script":{"id":"be1378c4-f904-41c6-a2d2-72939d4ae40e","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript"}}],"id":"d9311f4c-7b15-454b-bb4c-86fe5ff6e94b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"shipment\": {\r\n \"service\": \"usps_priority_international\",\r\n \"to_address\": {\r\n \"first_name\": \"Canada\",\r\n \"last_name\": \"Post\",\r\n \"street1\": \"2701 RIVERSIDE DRIVE\",\r\n \"street2\": \"\",\r\n \"city\": \"OTTAWA\",\r\n \"state\": \"ON\",\r\n \"zip\": \"K1V 1J8\",\r\n \"country\": \"CA\"\r\n },\r\n \"from_address\": {\r\n \"company\": \"Gori Company\",\r\n \"street1\": \"10450 Pioneer Ave\",\r\n \"street2\": \"Ste 4\",\r\n \"city\": \"Santa Fe Springs\",\r\n \"state\": \"CA\",\r\n \"zip\": \"90670\",\r\n \"phone\": \"1231231234\",\r\n \"country\": \"US\"\r\n },\r\n \"parcel\": {\r\n \"length\": 12,\r\n \"width\": 12,\r\n \"height\": 8,\r\n \"weight\": 16\r\n },\r\n \"customs\": {\r\n \"content_type\": \"gift\",\r\n \"customs_signer\": \"John Doe\",\r\n \"items\": [\r\n {\r\n \"description\": \"Front Mirror Cap\",\r\n \"hsTariffNumber\": null,\r\n \"countryOfOrigin\": \"US\",\r\n \"code\": \"CF-1234\",\r\n \"quantity\": 1,\r\n \"value\": 20,\r\n \"weight\": 16\r\n }\r\n ]\r\n },\r\n \"service_options\": {\r\n \"verify_address\": false\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/v1/shipments","description":"

Available Service Types

\n

* usps_first_package_international
* usps_first_international
* usps_priority_international
* usps_express_international

\n

Available values for content_type

\n

* merchandise
* gift
* documents
* sample
* return
* humanitarian
* dangerousgoods
* other

\n

Notes

\n

* Unit for weight is ounces
* phone is required for all addresses
* content_description is required if content_type is other

\n
\"customs\": {\n    \"content_type\": \"gift\",\n    \"content_description\": \"supplies\",\n    \"customs_signer\": \"John Doe\",\n    \"items\": [\n        {\n            \"description\": \"Front Mirror Cap\",\n            \"hsTariffNumber\": null,\n            \"countryOfOrigin\": \"US\",\n            \"code\": \"CF-1234\",\n            \"quantity\": 1,\n            \"value\": 20,\n            \"weight\": 16\n        }\n    ]\n}\n\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","name":"v1","type":"folder"}},"urlObject":{"path":["v1","shipments"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d9311f4c-7b15-454b-bb4c-86fe5ff6e94b"},{"name":"Create International Shipments - DHL","event":[{"listen":"test","script":{"id":"be1378c4-f904-41c6-a2d2-72939d4ae40e","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript"}}],"id":"fda8e266-8370-4d9e-9439-36e61e52713f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"shipment\": {\r\n \"service\": \"dhl_express\",\r\n \"to_address\": {\r\n \"company\": \"Hailong Hotel\",\r\n \"first_name\": \"John\",\r\n \"last_name\": \"Doe\",\r\n \"street1\": \"No. 599 Xuyou West Road\",\r\n \"street2\": \"\",\r\n \"city\": \"Xuchang City\",\r\n \"state\": \"Henan Province\",\r\n \"zip\": \"461000\",\r\n \"phone\": \"+8612341234123\",\r\n \"country\": \"CN\"\r\n },\r\n \"from_address\": {\r\n \"company\": \"Gori Company\",\r\n \"first_name\": \"Jane\",\r\n \"last_name\": \"Doe\",\r\n \"street1\": \"10450 Pioneer Ave\",\r\n \"street2\": \"Ste 4\",\r\n \"city\": \"Santa Fe Springs\",\r\n \"state\": \"CA\",\r\n \"zip\": \"90670\",\r\n \"phone\": \"1231231234\",\r\n \"country\": \"US\"\r\n },\r\n \"parcel\": [\r\n {\r\n \"length\": 12.5,\r\n \"width\": 12.5,\r\n \"height\": 8.1,\r\n \"weight\": 16.6\r\n }\r\n ],\r\n \"customs\": {\r\n \"content_type\": \"gift\",\r\n \"customs_signer\": \"John Doe\",\r\n \"items\": [\r\n {\r\n \"description\": \"Front Mirror Cap\",\r\n \"hsTariffNumber\": null,\r\n \"countryOfOrigin\": \"US\",\r\n \"code\": \"CF-1234\",\r\n \"quantity\": 1,\r\n \"value\": 20,\r\n \"weight\": 16\r\n }\r\n ]\r\n },\r\n \"service_options\": {\r\n \"verify_address\": false\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/v1/shipments","description":"

Notes

\n\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","name":"v1","type":"folder"}},"urlObject":{"path":["v1","shipments"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"4a129e83-aca7-4340-8a84-12f51eaec165","name":"Create International Shipments - DHL","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"shipment\": {\r\n \"service\": \"dhl_express\",\r\n \"to_address\": {\r\n \"company\": \"Hailong Hotel\",\r\n \"first_name\": \"John\",\r\n \"last_name\": \"Doe\",\r\n \"street1\": \"No. 599 Xuyou West Road\",\r\n \"street2\": \"\",\r\n \"city\": \"Xuchang City\",\r\n \"state\": \"Henan Province\",\r\n \"zip\": \"461000\",\r\n \"phone\": \"+8612341234123\",\r\n \"country\": \"CN\"\r\n },\r\n \"from_address\": {\r\n \"company\": \"Gori Company\",\r\n \"first_name\": \"Jane\",\r\n \"last_name\": \"Doe\",\r\n \"street1\": \"10450 Pioneer Ave\",\r\n \"street2\": \"Ste 4\",\r\n \"city\": \"Santa Fe Springs\",\r\n \"state\": \"CA\",\r\n \"zip\": \"90670\",\r\n \"phone\": \"1231231234\",\r\n \"country\": \"US\"\r\n },\r\n \"parcel\": [\r\n {\r\n \"length\": 12.5,\r\n \"width\": 12.5,\r\n \"height\": 8.1,\r\n \"weight\": 16.6\r\n }\r\n ],\r\n \"customs\": {\r\n \"content_type\": \"gift\",\r\n \"customs_signer\": \"John Doe\",\r\n \"items\": [\r\n {\r\n \"description\": \"Front Mirror Cap\",\r\n \"hsTariffNumber\": null,\r\n \"countryOfOrigin\": \"US\",\r\n \"code\": \"CF-1234\",\r\n \"quantity\": 1,\r\n \"value\": 20,\r\n \"weight\": 16\r\n }\r\n ]\r\n },\r\n \"service_options\": {\r\n \"verify_address\": false\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/v1/shipments"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Fri, 07 Oct 2022 15:39:45 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"376"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"172a9970-d65d-4c6e-9627-23a86f4a4c2c"},{"key":"X-Debug-Duration","value":"1,644"},{"key":"Content-Encoding","value":"gzip"},{"key":"X-Debug-Link","value":"/debug-ItSFkOxDLSKKxbzx/default/view?tag=6340483f63591"},{"key":"X-Debug-Tag","value":"6340483f63591"},{"key":"x-amzn-Remapped-Connection","value":"Keep-Alive"},{"key":"Set-Cookie","value":"_csrf=d259d8ee0139aca0fb062cdbd5b8dc2f1daa6a1e9c9259ded1545cc110522e75a%3A2%3A%7Bi%3A0%3Bs%3A5%3A%22_csrf%22%3Bi%3A1%3Bs%3A32%3A%22dDn2RGABQteleMg4TUrr-qVWI_jLFOfo%22%3B%7D; path=/; HttpOnly"},{"key":"x-amz-apigw-id","value":"ZpA55FXzPHcFVtQ="},{"key":"x-amzn-Remapped-Server","value":"Apache/2.2.34 (Unix)"},{"key":"X-Powered-By","value":"PHP/7.3.25"},{"key":"Access-Control-Expose-Headers","value":"x-pagination-current-page, x-pagination-page-count, x-pagination-per-page, x-pagination-total-count, x-rate-limit-limit, x-rate-limit-remaining, x-rate-limit-reset"},{"key":"X-Log-Id","value":"59322454"},{"key":"x-amzn-Remapped-Date","value":"Fri, 07 Oct 2022 15:39:43 GMT"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\"id\":\"505614479\",\"mode\":\"production\",\"tracking_code\":\"4935542452\",\"zone\":\"S\",\"service\":\"express\",\"carrier\":\"dhl\",\"label\":{\"image_url\":\"https://api-aws.goricompany.com/label/20221007/4935542452-33d0a3c03ef21aa8.pdf\"},\"documents\":[{\"document_url\":\"https://api-aws.goricompany.com/invoice/20221007/inv-4935542452-33d0a3c03ef21aa8.pdf\",\"type\":\"commercial_invoice\"}],\"to_address\":{\"name\":\"John Doe\",\"company\":\"Hailong Hotel\",\"street1\":\"No. 599 Xuyou West Road\",\"street2\":\"\",\"city\":\"Xuchang City\",\"state\":\"Henan Province\",\"zip\":\"461000\"},\"fees\":[{\"amount\":45.18,\"type\":\"postage\"}],\"refund\":null,\"reference_1\":null,\"reference_2\":null}"}],"_postman_id":"fda8e266-8370-4d9e-9439-36e61e52713f"},{"name":"Get Shipment","event":[{"listen":"prerequest","script":{"id":"02a21df6-9b7f-4180-bdd0-f408351a0d2c","exec":["pm.variables.set(\"id\", \"533198885\")"],"type":"text/javascript"}}],"id":"49e0e70d-ece1-4a1f-b636-8219d31a7810","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{api_url}}/v1/shipments/{{id}}","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","name":"v1","type":"folder"}},"urlObject":{"path":["v1","shipments","{{id}}"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"68e2fe61-ed6c-4a2f-8882-8ab83d20869e","name":"Example Response","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/v1/shipments/{{id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"1234\",\n \"mode\": \"test\",\n \"tracking_code\": \"1234123495234076115934\",\n \"zone\": \"1\",\n \"service\": \"priority\",\n \"carrier\": \"usps\",\n \"label\": {\n \"image_url\": \"https://api.goricompany.com/label/sample.pdf\"\n },\n \"to_address\": {\n \"name\": \"John Doe\",\n \"company\": null,\n \"street1\": \"2225 San Anseline Ave\",\n \"street2\": \"\",\n \"city\": \"Long Beach\",\n \"state\": \"CA\",\n \"zip\": \"90815\"\n },\n \"fees\": [\n {\n \"amount\": 6.74,\n \"type\": \"postage\"\n }\n ],\n \"refund\": null,\n \"reference_1\": \"12345\",\n \"reference_2\": null\n}"}],"_postman_id":"49e0e70d-ece1-4a1f-b636-8219d31a7810"},{"name":"Track Shipment","event":[{"listen":"prerequest","script":{"id":"2a9295bb-f4e1-4ed9-941b-115139341434","exec":["pm.variables.set(\"id\", \"503016216\")"],"type":"text/javascript"}}],"id":"137a9af5-722e-45fe-a86a-dabdbae1a29a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{api_url}}/v1/shipments/{{id}}/track","description":"\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","name":"v1","type":"folder"}},"urlObject":{"path":["v1","shipments","{{id}}","track"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"36e8832a-1b3d-400f-97e6-9b99f02cdb7b","name":"Example Response","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/v1/shipments/{{id}}/track"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 07 Sep 2021 22:40:22 GMT"},{"key":"Server","value":"Apache/2.2.34 (Unix)"},{"key":"X-Powered-By","value":"PHP/7.3.25"},{"key":"X-Debug-Tag","value":"6137ea56c034f"},{"key":"X-Debug-Duration","value":"16"},{"key":"X-Debug-Link","value":"/debug-ItSFkOxDLSKKxbzx/default/view?tag=6137ea56c034f"},{"key":"Set-Cookie","value":"_csrf=a34f77ca2c09d31058eaa08fff6ab1272e605ebfe0e654508caf246a9ac5c0f6a%3A2%3A%7Bi%3A0%3Bs%3A5%3A%22_csrf%22%3Bi%3A1%3Bs%3A32%3A%22BtE5GZ30VoetX9nM473kQ4vLFSylkE3J%22%3B%7D; path=/; HttpOnly"},{"key":"Keep-Alive","value":"timeout=15, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"tracking_code\": \"420012341234190287132300126176\",\n \"status\": \"delivered\",\n \"carrier_status_code\": \"01\",\n \"status_description\": \"Your item was delivered in or at the mailbox at 1:16 pm on August 16, 2021 in COROZAL, PR 00783.\",\n \"estimated_delivery_at\": null,\n \"delivered_at\": \"2021-08-16 13:16:00\",\n \"events\": [\n {\n \"event_at\": \"2021-08-16 13:16:00\",\n \"event\": \"delivered\",\n \"event_description\": \"Delivered, In/At Mailbox\",\n \"carrier_event_code\": \"01\",\n \"city\": \"01\",\n \"state\": \"PR\",\n \"zip\": \"00783\",\n \"country\": \"US\"\n },\n {\n \"event_at\": \"2021-08-16 07:41:00\",\n \"event\": \"in_transit\",\n \"event_description\": \"Out for Delivery\",\n \"carrier_event_code\": \"OF\",\n \"city\": \"OF\",\n \"state\": \"PR\",\n \"zip\": \"00783\",\n \"country\": \"US\"\n },\n {\n \"event_at\": \"2021-08-16 07:30:00\",\n \"event\": \"in_transit\",\n \"event_description\": \"Arrived at Post Office\",\n \"carrier_event_code\": \"07\",\n \"city\": \"07\",\n \"state\": \"PR\",\n \"zip\": \"00783\",\n \"country\": \"US\"\n },\n {\n \"event_at\": \"2021-08-16 05:39:00\",\n \"event\": \"in_transit\",\n \"event_description\": \"Arrived at USPS Regional Facility\",\n \"carrier_event_code\": \"A1\",\n \"city\": \"A1\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"US\"\n },\n {\n \"event_at\": \"2021-08-16 05:21:00\",\n \"event\": \"in_transit\",\n \"event_description\": \"Departed USPS Regional Facility\",\n \"carrier_event_code\": \"T1\",\n \"city\": \"T1\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"US\"\n },\n {\n \"event_at\": \"2021-08-15 02:02:00\",\n \"event\": \"in_transit\",\n \"event_description\": \"Arrived at USPS Regional Destination Facility\",\n \"carrier_event_code\": \"10\",\n \"city\": \"10\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"US\"\n },\n {\n \"event_at\": \"2021-08-14 00:00:00\",\n \"event\": \"in_transit\",\n \"event_description\": \"In Transit to Next Facility\",\n \"carrier_event_code\": \"NT\",\n \"city\": \"NT\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"US\"\n },\n {\n \"event_at\": \"2021-08-13 10:19:00\",\n \"event\": \"in_transit\",\n \"event_description\": \"Departed USPS Regional Origin Facility\",\n \"carrier_event_code\": \"10\",\n \"city\": \"10\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"US\"\n },\n {\n \"event_at\": \"2021-08-12 20:41:00\",\n \"event\": \"in_transit\",\n \"event_description\": \"Arrived at USPS Regional Origin Facility\",\n \"carrier_event_code\": \"10\",\n \"city\": \"10\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"US\"\n },\n {\n \"event_at\": \"2021-08-12 19:26:00\",\n \"event\": \"in_transit\",\n \"event_description\": \"Accepted at USPS Origin Facility\",\n \"carrier_event_code\": \"OA\",\n \"city\": \"OA\",\n \"state\": \"CA\",\n \"zip\": \"91733\",\n \"country\": \"US\"\n },\n {\n \"event_at\": \"2021-08-09 08:02:00\",\n \"event\": \"in_transit\",\n \"event_description\": \"Departed Shipping Partner Facility, USPS Awaiting Item\",\n \"carrier_event_code\": \"82\",\n \"city\": \"82\",\n \"state\": \"CA\",\n \"zip\": \"91733\",\n \"country\": \"US\"\n },\n {\n \"event_at\": \"2021-08-09 05:08:00\",\n \"event\": \"in_transit\",\n \"event_description\": \"Arrived Shipping Partner Facility, USPS Awaiting Item\",\n \"carrier_event_code\": \"81\",\n \"city\": \"81\",\n \"state\": \"CA\",\n \"zip\": \"91733\",\n \"country\": \"US\"\n },\n {\n \"event_at\": \"2021-08-09 02:14:00\",\n \"event\": \"in_transit\",\n \"event_description\": \"Picked Up by Shipping Partner, USPS Awaiting Item\",\n \"carrier_event_code\": \"80\",\n \"city\": \"80\",\n \"state\": \"CA\",\n \"zip\": \"91733\",\n \"country\": \"US\"\n }\n ]\n}"}],"_postman_id":"137a9af5-722e-45fe-a86a-dabdbae1a29a"},{"name":"List Shipments","id":"1b706b64-bab4-4416-8c1b-69a49ff66300","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{api_url}}/v1/shipments?page_size=100&page=1&id_after=502543983&reference_1=12345","description":"

Query Parameters

\n\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","name":"v1","type":"folder"}},"urlObject":{"path":["v1","shipments"],"host":["{{api_url}}"],"query":[{"disabled":true,"key":"created_at_after","value":"2021-07-27 09:59:40"},{"disabled":true,"key":"created_at_before","value":"2021-07-27 09:59:41"},{"key":"page_size","value":"100"},{"key":"page","value":"1"},{"key":"id_after","value":"502543983"},{"key":"reference_1","value":"12345"}],"variable":[]}},"response":[],"_postman_id":"1b706b64-bab4-4416-8c1b-69a49ff66300"},{"name":"Get Rates","event":[{"listen":"test","script":{"id":"211c61f4-4968-4148-b34a-54798517ed71","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript"}}],"id":"419db28d-330c-4c88-b856-284cc206d33c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"shipment\": {\r\n \"service\": \"usps_priority\",\r\n \"to_address\": {\r\n \"company\": \"A company\",\r\n \"first_name\": \"John\",\r\n \"last_name\": \"Doe\",\r\n \"street1\": \"2225 San Anseline Ave\",\r\n \"street2\": \"\",\r\n \"city\": \"Long Beach\",\r\n \"state\": \"CA\",\r\n \"zip\": \"90815\",\r\n \"country\": \"US\",\r\n \"phone\": 1231231234,\r\n \"email\": null,\r\n \"is_residential\": true\r\n },\r\n \"from_address\": {\r\n \"company\": \"Gori Company\",\r\n \"first_name\": \"Jane\",\r\n \"last_name\": \"Doe\",\r\n \"street1\": \"10450 Pioneer Ave\",\r\n \"street2\": \"Ste 4\",\r\n \"city\": \"Santa Fe Springs\",\r\n \"state\": \"CA\",\r\n \"zip\": \"90670\",\r\n \"phone\": \"1231231234\",\r\n \"country\": \"US\"\r\n },\r\n \"parcel\": {\r\n \"length\": 6,\r\n \"width\": 4,\r\n \"height\": 1,\r\n \"weight\": 10,\r\n \"package_type\": null\r\n },\r\n \"reference1\": \"12345\",\r\n \"service_options\": {\r\n \"verify_address\": false,\r\n \"confirmation\": false,\r\n \"label_type\": \"pdf\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/v1/shipments/rates","description":"

See Create Shipment request

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","name":"v1","type":"folder"}},"urlObject":{"path":["v1","shipments","rates"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"019f27a9-e88f-4355-8040-1e2699a57352","name":"Example Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"shipment\": {\r\n \"service\": \"usps_priority\",\r\n \"to_address\": {\r\n \"company\": \"A company\",\r\n \"first_name\": \"John\",\r\n \"last_name\": \"Doe\",\r\n \"street1\": \"2225 San Anseline Ave\",\r\n \"street2\": \"\",\r\n \"city\": \"Long Beach\",\r\n \"state\": \"CA\",\r\n \"zip\": \"90815\",\r\n \"country\": \"US\",\r\n \"phone\": 1231231234,\r\n \"email\": null,\r\n \"is_residential\": true\r\n },\r\n \"from_address\": {\r\n \"company\": \"Gori Company\",\r\n \"first_name\": \"Jane\",\r\n \"last_name\": \"Doe\",\r\n \"street1\": \"10450 Pioneer Ave\",\r\n \"street2\": \"Ste 4\",\r\n \"city\": \"Santa Fe Springs\",\r\n \"state\": \"CA\",\r\n \"zip\": \"90670\",\r\n \"phone\": \"1231231234\",\r\n \"country\": \"US\"\r\n },\r\n \"parcel\": {\r\n \"length\": 6,\r\n \"width\": 4,\r\n \"height\": 1,\r\n \"weight\": 10,\r\n \"package_type\": null\r\n },\r\n \"reference1\": \"12345\",\r\n \"service_options\": {\r\n \"verify_address\": false,\r\n \"confirmation\": false,\r\n \"label_type\": \"pdf\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/v1/shipments/rates"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Thu, 05 Jan 2023 22:13:17 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"152"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"05c6a9bc-ecfe-4345-b2f6-02c12334536f"},{"key":"X-Debug-Duration","value":"3,269"},{"key":"Content-Encoding","value":"gzip"},{"key":"X-Debug-Link","value":"/debug-ItSFkOxDLSKKxbzx/default/view?tag=63b74b7a14a52"},{"key":"X-Debug-Tag","value":"63b74b7a14a52"},{"key":"x-amzn-Remapped-Connection","value":"Keep-Alive"},{"key":"Set-Cookie","value":"_csrf=30b3e88fd0c985d43dde85b9a199c6e7829270501eefd14f27d4fd82fb8edbb2a%3A2%3A%7Bi%3A0%3Bs%3A5%3A%22_csrf%22%3Bi%3A1%3Bs%3A32%3A%2251hGGex6WJZ1PFUJg9UlGJuGQrRxrs9g%22%3B%7D; path=/; HttpOnly"},{"key":"x-amz-apigw-id","value":"eSi7EH8OPHcFw4Q="},{"key":"x-amzn-Remapped-Server","value":"Apache/2.2.34 (Unix)"},{"key":"X-Powered-By","value":"PHP/7.3.25"},{"key":"Access-Control-Expose-Headers","value":"x-pagination-current-page, x-pagination-page-count, x-pagination-per-page, x-pagination-total-count, x-rate-limit-limit, x-rate-limit-remaining, x-rate-limit-reset"},{"key":"X-Log-Id","value":"63974690"},{"key":"x-amzn-Remapped-Date","value":"Thu, 05 Jan 2023 22:13:14 GMT"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"[{\"service\":\"ups_ground\",\"carrier\":\"ups\",\"fees\":{\"amount\":11.2,\"type\":\"postage\"}},{\"service\":\"usps_priority\",\"carrier\":\"usps\",\"zone\":\"1\",\"fees\":{\"amount\":\"7.62\",\"type\":\"postage\"}},{\"service\":\"usps_parcel_select\",\"carrier\":\"usps\",\"zone\":\"1\",\"fees\":{\"amount\":\"7.47\",\"type\":\"postage\"}},{\"service\":\"usps_first\",\"carrier\":\"usps\",\"zone\":\"1\",\"fees\":{\"amount\":\"4.59\",\"type\":\"postage\"}}]"}],"_postman_id":"419db28d-330c-4c88-b856-284cc206d33c"},{"name":"Refund Request","event":[{"listen":"prerequest","script":{"id":"e935575e-7142-4cfe-bc70-6046cbb738d7","exec":["pm.variables.set(\"id\", \"502642025\")"],"type":"text/javascript"}}],"id":"b91a2e48-be6d-4d6a-83a4-008d84b5bb53","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{api_url}}/v1/shipments/{{id}}/refund","description":"

USPS shipping labels can be refunded if requested within 30 days of generation. The processing time is at least 15 days, after which the funds will return to your meter balance.

\n

The shipment must not have been scanned by the carrier.

\n

Possible refund status values are: \"submitted\", \"refunded\", \"rejected\".

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","name":"v1","type":"folder"}},"urlObject":{"path":["v1","shipments","{{id}}","refund"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"a6f422fa-03c9-48ab-a3cc-70b5a69368a1","name":"Example Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"shipment\": {\r\n \"to_address\": {\r\n \"first_name\": \"Jane\",\r\n \"last_name\": \"Doe\",\r\n \"company\": null,\r\n \"street1\": \"179 N Harbor Dr\",\r\n \"street2\": null,\r\n \"city\": \"Redondo Beach\",\r\n \"state\": \"CA\",\r\n \"zip\": \"90277\",\r\n \"country\": \"US\",\r\n \"phone\": \"4153334444\",\r\n \"email\": \"dr_steve_brule@gmail.com\"\r\n },\r\n \"from_address\": {\r\n \"first_name\": \"John\",\r\n \"last_name\": \"Doe\",\r\n \"company\": null,\r\n \"street1\": \"7372 Walnut Ave\",\r\n \"street2\": \"Ste N\",\r\n \"city\": \"Buena Park\",\r\n \"state\": \"CA\",\r\n \"zip\": \"90620\",\r\n \"country\": \"US\",\r\n \"phone\": \"4153334444\",\r\n \"email\": \"support@easypost.com\"\r\n },\r\n \"parcel\": {\r\n \"length\": 20.2,\r\n \"width\": 10.9,\r\n \"height\": 5.0,\r\n \"weight\": 13\r\n },\r\n \"service\": \"first\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/v1/shipments/{{id}}/refund"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"mode\": \"test\",\n \"tracking_code\": \"420902779200190280422500000237\",\n \"zone\": \"1\",\n \"service\": \"first\",\n \"carrier\": \"usps\",\n \"label\": {\n \"image_url\": \"https://dev.goricompany.com/label/420902779200190280422500000237.pdf\"\n },\n \"to_address\": {\n \"name\": \"JANE DOE\",\n \"company\": \"\",\n \"street1\": \"179 N HARBOR DR\",\n \"street2\": \"\",\n \"city\": \"REDONDO BEACH\",\n \"state\": \"CA\",\n \"zip\": \"90277-2506\"\n },\n \"fees\": [\n {\n \"amount\": 5.19,\n \"type\": \"postage\"\n },\n {\n \"amount\": 0.22,\n \"type\": \"customs\"\n }\n ],\n \"refund\": {\n \"created_at\": \"2021-06-11 02:09:46\",\n \"updated_at\": \"2021-06-11 02:09:46\",\n \"note\": null,\n \"amount\": 6.2,\n \"status\": \"submitted\"\n }\n}"}],"_postman_id":"b91a2e48-be6d-4d6a-83a4-008d84b5bb53"},{"name":"Partner Event","event":[{"listen":"prerequest","script":{"id":"9c0213af-b2cb-44f8-a62a-4b27da716aaf","exec":["pm.variables.set(\"id\", \"502534179\")"],"type":"text/javascript"}}],"id":"5a527cd0-c328-4538-b1b9-43d325c0d38e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"event","value":"CREATED","type":"text"},{"key":"event_time","value":"2021-07-19 08:30:58","type":"text"},{"key":"event_zip","value":"90620","type":"text"}]},"url":"{{api_url}}/v1/shipments/{{id}}/partner_event","description":"

Only USPS First class supports Partner Event for now.

\n

Postfields

\n\n

Event types

\n\n

event_zip : Zipcode of the Shipping Partner Facility
event_time : Date/Time of event in yyyy-mm-dd hh:ii:ss format (24 hour). use PST

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","name":"v1","type":"folder"}},"urlObject":{"path":["v1","shipments","{{id}}","partner_event"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5a527cd0-c328-4538-b1b9-43d325c0d38e"}],"id":"4a8fb481-74ec-416b-81e6-dff1591c9707","_postman_id":"4a8fb481-74ec-416b-81e6-dff1591c9707","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","name":"v1","type":"folder"}}},{"name":"Returns","item":[{"name":"Create Return Label","event":[{"listen":"test","script":{"id":"211c61f4-4968-4148-b34a-54798517ed71","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript"}}],"id":"06245023-a129-4a1a-a7a5-f62a10f94441","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"shipment\": {\r\n \"service\": \"usps_priority\",\r\n \"to_address\": {\r\n \"company\": \"Gori Company\",\r\n \"first_name\": \"Jane\",\r\n \"last_name\": \"Doe\",\r\n \"street1\": \"10450 Pioneer Ave\",\r\n \"street2\": \"Ste 4\",\r\n \"city\": \"Santa Fe Springs\",\r\n \"state\": \"CA\",\r\n \"zip\": \"90670\",\r\n \"country\": \"US\",\r\n \"phone\": null,\r\n \"email\": null,\r\n \"is_residential\": true\r\n },\r\n \"from_address\": {\r\n \"company\": \"A company\",\r\n \"first_name\": \"John\",\r\n \"last_name\": \"Doe\",\r\n \"street1\": \"2225 San Anseline Ave\",\r\n \"street2\": \"\",\r\n \"city\": \"Long Beach\",\r\n \"state\": \"CA\",\r\n \"zip\": \"90815\",\r\n \"phone\": \"1231231234\",\r\n \"country\": \"US\"\r\n },\r\n \"parcel\": {\r\n \"length\": 6,\r\n \"width\": 4,\r\n \"height\": 1,\r\n \"weight\": 10,\r\n \"package_type\": null\r\n },\r\n \"reference1\": \"12345\",\r\n \"service_options\": {\r\n \"label_type\": \"pdf\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/v1/return_shipments","description":"

Unit for weight is ounces and length is inches

\n

Possible values for service. Please check your contract as some services might be available.

\n\n

USPS priority service accepts different package types which you can chose from below. By default, it is custom_package

\n\n

pdf is the default label type for service_options.label_typeavailable options are pdf and zpl

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","name":"v1","type":"folder"}},"urlObject":{"path":["v1","return_shipments"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"9b709d9f-552d-4dbd-a64f-1408c91e4b3b","name":"Example Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"shipment\": {\r\n \"service\": \"usps_priority\",\r\n \"to_address\": {\r\n \"company\": \"A company\",\r\n \"first_name\": \"John\",\r\n \"last_name\": \"Doe\",\r\n \"street1\": \"2225 San Anseline Ave\",\r\n \"street2\": \"\",\r\n \"city\": \"Long Beach\",\r\n \"state\": \"CA\",\r\n \"zip\": \"90815\",\r\n \"country\": \"US\",\r\n \"phone\": null,\r\n \"email\": null,\r\n \"is_residential\": true\r\n },\r\n \"from_address\": {\r\n \"company\": \"Gori Company\",\r\n \"first_name\": \"Jane\",\r\n \"last_name\": \"Doe\",\r\n \"street1\": \"10450 Pioneer Ave\",\r\n \"street2\": \"Ste 4\",\r\n \"city\": \"Santa Fe Springs\",\r\n \"state\": \"CA\",\r\n \"zip\": \"90670\",\r\n \"phone\": \"1231231234\",\r\n \"country\": \"US\"\r\n },\r\n \"parcel\": {\r\n \"length\": 6,\r\n \"width\": 4,\r\n \"height\": 1,\r\n \"weight\": 10,\r\n \"package_type\": null\r\n },\r\n \"reference1\": \"12345\",\r\n \"service_options\": {\r\n \"label_type\": \"pdf\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/v1/return_shipments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 25 Jan 2023 22:55:01 GMT"},{"key":"Server","value":"Apache/2.2.34 (Unix)"},{"key":"X-Powered-By","value":"PHP/7.3.25"},{"key":"X-Log-Id","value":"64943344"},{"key":"X-Debug-Tag","value":"63d1b345a8f78"},{"key":"X-Debug-Duration","value":"1,938"},{"key":"X-Debug-Link","value":"/debug-bzxItSLSKKxFkOxD/default/view?tag=63d1b345a8f78"},{"key":"Set-Cookie","value":"_csrf=10de55113ebda9b36d1e8aba3237aa4d57b350300e9a46b72c6e6215e0acdc5aa%3A2%3A%7Bi%3A0%3Bs%3A5%3A%22_csrf%22%3Bi%3A1%3Bs%3A32%3A%22t8HIu99E53qTNU0lnXMv4WUTMGI7Lar5%22%3B%7D; path=/; HttpOnly"},{"key":"Keep-Alive","value":"timeout=15, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"2\",\n \"mode\": \"test\",\n \"tracking_code\": \"9401937903348386000036\",\n \"zone\": \"1\",\n \"service\": \"priority\",\n \"carrier\": \"usps\",\n \"label\": {\n \"image_url\": \"https://dev.goricompany.com/label/20230125/9401937903348386000036-df57ebc1a0a64e58.pdf\"\n },\n \"documents\": null,\n \"to_address\": {\n \"name\": \"JOHN DOE\",\n \"company\": \"A COMPANY\",\n \"street1\": \"2225 SAN ANSELINE AVE\",\n \"street2\": null,\n \"city\": \"LONG BEACH\",\n \"state\": \"CA\",\n \"zip\": \"90815-2140\"\n },\n \"fees\": null,\n \"refund\": null,\n \"reference_1\": \"12345\",\n \"reference_2\": null\n}"}],"_postman_id":"06245023-a129-4a1a-a7a5-f62a10f94441"},{"name":"Get Return Label","event":[{"listen":"prerequest","script":{"id":"02a21df6-9b7f-4180-bdd0-f408351a0d2c","exec":[""],"type":"text/javascript"}}],"id":"819e142e-bf81-4efb-80b2-cd30272c97f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{api_url}}/v1/return_shipments/{{id}}","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","name":"v1","type":"folder"}},"urlObject":{"path":["v1","return_shipments","{{id}}"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"819e142e-bf81-4efb-80b2-cd30272c97f4"},{"name":"Track Return Label","event":[{"listen":"prerequest","script":{"id":"2a9295bb-f4e1-4ed9-941b-115139341434","exec":["pm.variables.set(\"id\", \"503016216\")"],"type":"text/javascript"}}],"id":"53ed6387-cd1d-4f91-9d0f-72c2379f675e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{api_url}}/v1/return_shipments/{{id}}/track","description":"\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","name":"v1","type":"folder"}},"urlObject":{"path":["v1","return_shipments","{{id}}","track"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"7ddd5091-b4db-47a8-af50-3b24618158cd","name":"Example Response","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/v1/return_shipments/{{id}}/track"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 07 Sep 2021 22:40:22 GMT"},{"key":"Server","value":"Apache/2.2.34 (Unix)"},{"key":"X-Powered-By","value":"PHP/7.3.25"},{"key":"X-Debug-Tag","value":"6137ea56c034f"},{"key":"X-Debug-Duration","value":"16"},{"key":"X-Debug-Link","value":"/debug-ItSFkOxDLSKKxbzx/default/view?tag=6137ea56c034f"},{"key":"Set-Cookie","value":"_csrf=a34f77ca2c09d31058eaa08fff6ab1272e605ebfe0e654508caf246a9ac5c0f6a%3A2%3A%7Bi%3A0%3Bs%3A5%3A%22_csrf%22%3Bi%3A1%3Bs%3A32%3A%22BtE5GZ30VoetX9nM473kQ4vLFSylkE3J%22%3B%7D; path=/; HttpOnly"},{"key":"Keep-Alive","value":"timeout=15, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"tracking_code\": \"420012341234190287132300126176\",\n \"status\": \"delivered\",\n \"carrier_status_code\": \"01\",\n \"status_description\": \"Your item was delivered in or at the mailbox at 1:16 pm on August 16, 2021 in COROZAL, PR 00783.\",\n \"estimated_delivery_at\": null,\n \"delivered_at\": \"2021-08-16 13:16:00\",\n \"events\": [\n {\n \"event_at\": \"2021-08-16 13:16:00\",\n \"event\": \"delivered\",\n \"event_description\": \"Delivered, In/At Mailbox\",\n \"carrier_event_code\": \"01\",\n \"city\": \"01\",\n \"state\": \"PR\",\n \"zip\": \"00783\",\n \"country\": \"US\"\n },\n {\n \"event_at\": \"2021-08-16 07:41:00\",\n \"event\": \"in_transit\",\n \"event_description\": \"Out for Delivery\",\n \"carrier_event_code\": \"OF\",\n \"city\": \"OF\",\n \"state\": \"PR\",\n \"zip\": \"00783\",\n \"country\": \"US\"\n },\n {\n \"event_at\": \"2021-08-16 07:30:00\",\n \"event\": \"in_transit\",\n \"event_description\": \"Arrived at Post Office\",\n \"carrier_event_code\": \"07\",\n \"city\": \"07\",\n \"state\": \"PR\",\n \"zip\": \"00783\",\n \"country\": \"US\"\n },\n {\n \"event_at\": \"2021-08-16 05:39:00\",\n \"event\": \"in_transit\",\n \"event_description\": \"Arrived at USPS Regional Facility\",\n \"carrier_event_code\": \"A1\",\n \"city\": \"A1\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"US\"\n },\n {\n \"event_at\": \"2021-08-16 05:21:00\",\n \"event\": \"in_transit\",\n \"event_description\": \"Departed USPS Regional Facility\",\n \"carrier_event_code\": \"T1\",\n \"city\": \"T1\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"US\"\n },\n {\n \"event_at\": \"2021-08-15 02:02:00\",\n \"event\": \"in_transit\",\n \"event_description\": \"Arrived at USPS Regional Destination Facility\",\n \"carrier_event_code\": \"10\",\n \"city\": \"10\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"US\"\n },\n {\n \"event_at\": \"2021-08-14 00:00:00\",\n \"event\": \"in_transit\",\n \"event_description\": \"In Transit to Next Facility\",\n \"carrier_event_code\": \"NT\",\n \"city\": \"NT\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"US\"\n },\n {\n \"event_at\": \"2021-08-13 10:19:00\",\n \"event\": \"in_transit\",\n \"event_description\": \"Departed USPS Regional Origin Facility\",\n \"carrier_event_code\": \"10\",\n \"city\": \"10\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"US\"\n },\n {\n \"event_at\": \"2021-08-12 20:41:00\",\n \"event\": \"in_transit\",\n \"event_description\": \"Arrived at USPS Regional Origin Facility\",\n \"carrier_event_code\": \"10\",\n \"city\": \"10\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"US\"\n },\n {\n \"event_at\": \"2021-08-12 19:26:00\",\n \"event\": \"in_transit\",\n \"event_description\": \"Accepted at USPS Origin Facility\",\n \"carrier_event_code\": \"OA\",\n \"city\": \"OA\",\n \"state\": \"CA\",\n \"zip\": \"91733\",\n \"country\": \"US\"\n },\n {\n \"event_at\": \"2021-08-09 08:02:00\",\n \"event\": \"in_transit\",\n \"event_description\": \"Departed Shipping Partner Facility, USPS Awaiting Item\",\n \"carrier_event_code\": \"82\",\n \"city\": \"82\",\n \"state\": \"CA\",\n \"zip\": \"91733\",\n \"country\": \"US\"\n },\n {\n \"event_at\": \"2021-08-09 05:08:00\",\n \"event\": \"in_transit\",\n \"event_description\": \"Arrived Shipping Partner Facility, USPS Awaiting Item\",\n \"carrier_event_code\": \"81\",\n \"city\": \"81\",\n \"state\": \"CA\",\n \"zip\": \"91733\",\n \"country\": \"US\"\n },\n {\n \"event_at\": \"2021-08-09 02:14:00\",\n \"event\": \"in_transit\",\n \"event_description\": \"Picked Up by Shipping Partner, USPS Awaiting Item\",\n \"carrier_event_code\": \"80\",\n \"city\": \"80\",\n \"state\": \"CA\",\n \"zip\": \"91733\",\n \"country\": \"US\"\n }\n ]\n}"}],"_postman_id":"53ed6387-cd1d-4f91-9d0f-72c2379f675e"},{"name":"List Return Labels","id":"4e00eee9-b28c-4a82-a7f6-3f3f0e11382f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{api_url}}/v1/return_shipments","description":"

Query Parameters

\n\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","name":"v1","type":"folder"}},"urlObject":{"path":["v1","return_shipments"],"host":["{{api_url}}"],"query":[{"disabled":true,"key":"created_at_after","value":"2021-07-27 09:59:40"},{"disabled":true,"key":"created_at_before","value":"2021-07-27 09:59:41"},{"disabled":true,"key":"page_size","value":"100"},{"disabled":true,"key":"page","value":"1"},{"disabled":true,"key":"id_after","value":"5"},{"disabled":true,"key":"reference_1","value":"12345"}],"variable":[]}},"response":[],"_postman_id":"4e00eee9-b28c-4a82-a7f6-3f3f0e11382f"},{"name":"List Unused Return Labels","id":"cbed082e-3586-492a-b2b9-fc4ed225f1e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{api_url}}/v1/return_shipments/unused","description":"

Query Parameters

\n\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","name":"v1","type":"folder"}},"urlObject":{"path":["v1","return_shipments","unused"],"host":["{{api_url}}"],"query":[{"disabled":true,"key":"created_at_after","value":"2021-07-27 09:59:40"},{"disabled":true,"key":"created_at_before","value":"2021-07-27 09:59:41"},{"disabled":true,"key":"page_size","value":"100"},{"disabled":true,"key":"page","value":"1"},{"disabled":true,"key":"id_after","value":"5"},{"disabled":true,"key":"reference_1","value":"12345"}],"variable":[]}},"response":[],"_postman_id":"cbed082e-3586-492a-b2b9-fc4ed225f1e4"}],"id":"f6506d01-8881-4431-9bec-5cc2137e3f9b","_postman_id":"f6506d01-8881-4431-9bec-5cc2137e3f9b","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","name":"v1","type":"folder"}}},{"name":"Manifest","event":[{"listen":"test","script":{"id":"c1551a2e-aed4-4cc3-b457-da0d8f561111","exec":[""],"type":"text/javascript","packages":{}}}],"id":"e70e6fb5-92ff-4121-92d1-9a5310a9df8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"tracking_numbers\": [\n \"4209283192055903092680604051265605\",\n \"4209283192055903092680333802176067\",\n \"4209283192055903092680804115702965\",\n \"4209283192055903092680720434149314\",\n \"4209283192055903092680170008693222\",\n \"123\",\n \"4209283192055903092680011961825278\"\n ],\n \"scan_form\": false,\n \"ship_date\": \"2024-07-02\",\n \"induction_location\": \"92626\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/shipments/manifest","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","name":"v1","type":"folder"}},"urlObject":{"path":["shipments","manifest"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e70e6fb5-92ff-4121-92d1-9a5310a9df8d"}],"id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"6a0db9a0-85d7-4c8e-b41c-f635b0b56117","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"dbbfc088-2810-4236-b6ea-02949322ae4a","type":"text/javascript","exec":[""]}}],"_postman_id":"50299ad9-c170-42d6-9f28-1dfb2fb53f4f","description":""}],"event":[{"listen":"prerequest","script":{"id":"6b4f31de-f446-434f-8e92-e862a063f892","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"285e4b23-90cd-452b-a200-ea701d11ac85","type":"text/javascript","exec":[""]}}]}