{
	"info": {
		"_postman_id": "084d295d-d473-416b-9b72-89afa4a13ebc",
		"name": "ShipmentDataApi For Customers",
		"description": "The Shipment Data API will be used by customers to search and load shipments. It is a REST API and uses tokens for authentication. The authorization and authentication is compliant with OAuth2 and all the methods of the API will have authorization token (access_token) in their HTTP header.",
		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
	},
	"item": [
		{
			"name": "Operational",
			"item": [
				{
					"name": "ShipmentIdentifiers",
					"item": [
						{
							"name": "Lookup Shipments By Barcode",
							"request": {
								"method": "POST",
								"header": [],
								"body": {
									"mode": "raw",
									"raw": "{\r\n    \"query\": \"40170726206788020047\",\r\n    \"startDate\": \"2021-06-01T00:00:12.0000000\",\r\n    \"endDate\": \"2021-06-30T23:00:12.0000000\",\r\n    \"pageSize\": 20,\r\n    \"pageIndex\": 0,\r\n    \"installationTags\": [],\r\n    \"actorTags\": [],\r\n    \"carrierTags\": []\r\n}",
									"options": {
										"raw": {
											"language": "json"
										}
									}
								},
								"url": {
									"raw": "https://customer-api.consignorportal.com/ApiGateway/shipmentdata/operational/shipmentidentifiers/bybarcode",
									"protocol": "https",
									"host": [
										"customer-api",
										"consignorportal",
										"com"
									],
									"path": [
										"ApiGateway",
										"shipmentdata",
										"operational",
										"shipmentidentifiers",
										"bybarcode"
									]
								},
								"description": "Search shipments based on the barcode."
							},
							"response": []
						},
						{
							"name": "Lookup Shipments By Order Number",
							"request": {
								"method": "POST",
								"header": [],
								"body": {
									"mode": "raw",
									"raw": "{\r\n    \"query\": \"tyghijk\",\r\n    \"startDate\": \"2021-06-01T00:00:12.0000000\",\r\n    \"endDate\": \"2021-06-30T23:00:12.0000000\",\r\n    \"pageSize\": 20,\r\n    \"pageIndex\": 0,\r\n    \"installationTags\": [],\r\n    \"actorTags\": [],\r\n    \"carrierTags\": []\r\n}",
									"options": {
										"raw": {
											"language": "json"
										}
									}
								},
								"url": {
									"raw": "https://customer-api.consignorportal.com/ApiGateway/shipmentdata/operational/shipmentidentifiers/byordernumber",
									"protocol": "https",
									"host": [
										"customer-api",
										"consignorportal",
										"com"
									],
									"path": [
										"ApiGateway",
										"shipmentdata",
										"operational",
										"shipmentidentifiers",
										"byordernumber"
									]
								},
								"description": "Search shipments based on the order number."
							},
							"response": []
						},
						{
							"name": "Lookup Shipments By Pickup Code",
							"request": {
								"method": "POST",
								"header": [],
								"body": {
									"mode": "raw",
									"raw": "{\r\n    \"query\": \"PickupCode\",\r\n    \"startDate\": \"2020-08-01T00:00:12.0000000\",\r\n    \"endDate\": \"2020-08-30T23:00:12.0000000\",\r\n    \"pageSize\": 100,\r\n    \"pageIndex\": 0,\r\n    \"installationTags\": [],\r\n    \"actorTags\": [],\r\n    \"carrierTags\": []\r\n}",
									"options": {
										"raw": {
											"language": "json"
										}
									}
								},
								"url": {
									"raw": "https://customer-api.consignorportal.com/ApiGateway/shipmentdata/operational/shipmentidentifiers/bypickupcode",
									"protocol": "https",
									"host": [
										"customer-api",
										"consignorportal",
										"com"
									],
									"path": [
										"ApiGateway",
										"shipmentdata",
										"operational",
										"shipmentidentifiers",
										"bypickupcode"
									]
								},
								"description": "Search shipments based on the pickup code."
							},
							"response": []
						},
						{
							"name": "Lookup Shipments By Date Range",
							"request": {
								"method": "POST",
								"header": [],
								"body": {
									"mode": "raw",
									"raw": "{\r\n    \"query\": \"PickupCode\",\r\n    \"startDate\": \"2020-08-01T00:00:12.0000000\",\r\n    \"endDate\": \"2020-08-30T23:00:12.0000000\",\r\n    \"pageSize\": 100,\r\n    \"pageIndex\": 0,\r\n    \"dateRangeSource\": 1,\r\n    \"installationTags\": [],\r\n    \"actorTags\": [],\r\n    \"carrierTags\": []\r\n}",
									"options": {
										"raw": {
											"language": "json"
										}
									}
								},
								"url": {
									"raw": "https://customer-api.consignorportal.com/ApiGateway/shipmentdata/operational/shipmentidentifiers/bydaterange",
									"protocol": "https",
									"host": [
										"customer-api",
										"consignorportal",
										"com"
									],
									"path": [
										"ApiGateway",
										"shipmentdata",
										"operational",
										"shipmentidentifiers",
										"bydaterange"
									]
								},
								"description": "Search shipments based on the pickup code."
							},
							"response": []
						}
					],
					"description": "The methods here are used for searching for shipments, by barcode, order number or pickup code.",
					"auth": {
						"type": "bearer",
						"bearer": [
							{
								"key": "token",
								"value": "{{authToken}}",
								"type": "string"
							}
						]
					},
					"event": [
						{
							"listen": "prerequest",
							"script": {
								"type": "text/javascript",
								"exec": [
									""
								]
							}
						},
						{
							"listen": "test",
							"script": {
								"type": "text/javascript",
								"exec": [
									""
								]
							}
						}
					]
				},
				{
					"name": "Shipment",
					"item": [
						{
							"name": "Get Shipment",
							"request": {
								"method": "GET",
								"header": [],
								"url": {
									"raw": "https://customer-api.consignorportal.com/ApiGateway/shipmentdata/operational/shipments/:shipmentUuid",
									"protocol": "https",
									"host": [
										"customer-api",
										"consignorportal",
										"com"
									],
									"path": [
										"ApiGateway",
										"shipmentdata",
										"operational",
										"shipments",
										":shipmentUuid"
									],
									"query": [
										{
											"key": "",
											"value": "",
											"disabled": true
										}
									],
									"variable": [
										{
											"key": "shipmentUuid",
											"value": "b476727a-5d95-4724-b59b-5136546e1f78"
										}
									]
								},
								"description": "Will return the main shipment information. Shipment unique identifier (tag) will be provided in the URI ({shipmentUuid}). \nThe shipment information returned is filtered according to the shipment viewer profile assigned to the user making the request."
							},
							"response": []
						},
						{
							"name": "Get Shipment Summary Document",
							"request": {
								"method": "GET",
								"header": [],
								"url": {
									"raw": "https://customer-api.consignorportal.com/ApiGateway/shipmentdata/operational/shipments/:shipmentUuid/summary-document",
									"protocol": "https",
									"host": [
										"customer-api",
										"consignorportal",
										"com"
									],
									"path": [
										"ApiGateway",
										"shipmentdata",
										"operational",
										"shipments",
										":shipmentUuid",
										"summary-document"
									],
									"variable": [
										{
											"key": "shipmentUuid",
											"value": "b476727a-5d95-4724-b59b-5136546e1f78"
										}
									]
								},
								"description": "Will return the proof of delivery for the shipment, as a PDF file."
							},
							"response": []
						},
						{
							"name": "Get Package Summary Document",
							"protocolProfileBehavior": {
								"disableBodyPruning": true
							},
							"request": {
								"method": "GET",
								"header": [],
								"body": {
									"mode": "formdata",
									"formdata": []
								},
								"url": {
									"raw": "https://customer-api.consignorportal.com/ApiGateway/shipmentdata/operational/shipments/:shipmentUuid/summary-document/:packageUuid",
									"protocol": "https",
									"host": [
										"customer-api",
										"consignorportal",
										"com"
									],
									"path": [
										"ApiGateway",
										"shipmentdata",
										"operational",
										"shipments",
										":shipmentUuid",
										"summary-document",
										":packageUuid"
									],
									"variable": [
										{
											"key": "shipmentUuid",
											"value": "b476727a-5d95-4724-b59b-5136546e1f78"
										},
										{
											"key": "packageUuid",
											"value": "9057b69d-629f-4056-8701-c26025d53ba1"
										}
									]
								},
								"description": "Will return the proof of delivery for the package, as a PDF file."
							},
							"response": []
						},
						{
							"name": "Get Shipment Additional Information",
							"protocolProfileBehavior": {
								"disableBodyPruning": true
							},
							"request": {
								"method": "GET",
								"header": [],
								"body": {
									"mode": "formdata",
									"formdata": []
								},
								"url": {
									"raw": "https://customer-api.consignorportal.com/ApiGateway/shipmentdata/operational/shipments/:shipmentUuid/additional-information",
									"protocol": "https",
									"host": [
										"customer-api",
										"consignorportal",
										"com"
									],
									"path": [
										"ApiGateway",
										"shipmentdata",
										"operational",
										"shipments",
										":shipmentUuid",
										"additional-information"
									],
									"variable": [
										{
											"key": "shipmentUuid",
											"value": "b476727a-5d95-4724-b59b-5136546e1f78"
										}
									]
								},
								"description": "Will return the additional shipment information, such as tracking URLs, latest status and ETA. Shipment unique identifier (tag) will be provided in the URI ({shipmentUuid})."
							},
							"response": []
						},
						{
							"name": "Get Shipment Container Information",
							"protocolProfileBehavior": {
								"disableBodyPruning": true
							},
							"request": {
								"method": "GET",
								"header": [],
								"body": {
									"mode": "raw",
									"raw": "",
									"options": {
										"raw": {
											"language": "json"
										}
									}
								},
								"url": {
									"raw": "https://customer-api.consignorportal.com/ApiGateway/shipmentdata/operational/shipments/:shipmentUuid/container-information",
									"protocol": "https",
									"host": [
										"customer-api",
										"consignorportal",
										"com"
									],
									"path": [
										"ApiGateway",
										"shipmentdata",
										"operational",
										"shipments",
										":shipmentUuid",
										"container-information"
									],
									"variable": [
										{
											"key": "shipmentUuid",
											"value": "b476727a-5d95-4724-b59b-5136546e1f78"
										}
									]
								},
								"description": "Will return the container information for a shipment. Shipment unique identifier (tag) will be provided in the URI ({shipmentUuid})."
							},
							"response": []
						},
						{
							"name": "Get Shipment Valid Events",
							"request": {
								"method": "GET",
								"header": [],
								"url": {
									"raw": "https://customer-api.consignorportal.com/ApiGateway/shipmentdata/operational/shipments/:shipmentUuid/events/valid",
									"protocol": "https",
									"host": [
										"customer-api",
										"consignorportal",
										"com"
									],
									"path": [
										"ApiGateway",
										"shipmentdata",
										"operational",
										"shipments",
										":shipmentUuid",
										"events",
										"valid"
									],
									"variable": [
										{
											"key": "shipmentUuid",
											"value": "b476727a-5d95-4724-b59b-5136546e1f78"
										}
									]
								},
								"description": "Will return the list of valid events that can be used to send as new shipment status. Shipment unique identifier (tag) will be provided in the URI ({shipmentUuid})."
							},
							"response": []
						},
						{
							"name": "Get Shipment Document",
							"protocolProfileBehavior": {
								"disableBodyPruning": true
							},
							"request": {
								"method": "GET",
								"header": [],
								"body": {
									"mode": "formdata",
									"formdata": []
								},
								"url": {
									"raw": "https://customer-api.consignorportal.com/ApiGateway/shipmentdata/operational/shipments/:shipmentUuid/binaries/:binaryUuid",
									"protocol": "https",
									"host": [
										"customer-api",
										"consignorportal",
										"com"
									],
									"path": [
										"ApiGateway",
										"shipmentdata",
										"operational",
										"shipments",
										":shipmentUuid",
										"binaries",
										":binaryUuid"
									],
									"variable": [
										{
											"key": "shipmentUuid",
											"value": "b476727a-5d95-4724-b59b-5136546e1f78"
										},
										{
											"key": "binaryUuid",
											"value": "55469626-f7a5-4823-8c56-7875f0639e12"
										}
									]
								},
								"description": "Will return a document attached to the shipment. Shipment, and document unique identifiers, will be provided in the URI ({shipmentUuid}, {binaryUuid})."
							},
							"response": []
						},
						{
							"name": "Send Shipment Status",
							"request": {
								"method": "PUT",
								"header": [],
								"body": {
									"mode": "raw",
									"raw": "{\r\n    \"EventType\": \"6_5249\",\r\n    \"Comments\": \"Some comment from the user\",\r\n    \"Date\": \"2021-07-20T17:38:22+02:00\"\r\n}",
									"options": {
										"raw": {
											"language": "json"
										}
									}
								},
								"url": {
									"raw": "https://customer-api.consignorportal.com/ApiGateway/shipmentdata/operational/shipments/:shipmentUuid/status",
									"protocol": "https",
									"host": [
										"customer-api",
										"consignorportal",
										"com"
									],
									"path": [
										"ApiGateway",
										"shipmentdata",
										"operational",
										"shipments",
										":shipmentUuid",
										"status"
									],
									"variable": [
										{
											"key": "shipmentUuid",
											"value": "b476727a-5d95-4724-b59b-5136546e1f78"
										}
									]
								},
								"description": "Will send new status for a shipment. Shipment unique identifier (tag) will be provided in the URI ({shipmentUuid}). The date formats accepted are either UTC (2020-11-18T07:47:38.000Z) or ISO (2020-11-18T07:47:38+01:00)."
							},
							"response": []
						},
						{
							"name": "Send Package Status",
							"request": {
								"method": "PUT",
								"header": [],
								"body": {
									"mode": "raw",
									"raw": "{\r\n    \"EventType\": \"6_5249\",\r\n    \"Comments\": \"Some comment from the user\",\r\n    \"Date\": \"2021-07-20T17:38:22+02:00\"\r\n}",
									"options": {
										"raw": {
											"language": "json"
										}
									}
								},
								"url": {
									"raw": "https://customer-api.consignorportal.com/ApiGateway/shipmentdata/operational/shipments/:shipmentUuid/packages/:packageUuid/status",
									"protocol": "https",
									"host": [
										"customer-api",
										"consignorportal",
										"com"
									],
									"path": [
										"ApiGateway",
										"shipmentdata",
										"operational",
										"shipments",
										":shipmentUuid",
										"packages",
										":packageUuid",
										"status"
									],
									"variable": [
										{
											"key": "shipmentUuid",
											"value": "b476727a-5d95-4724-b59b-5136546e1f78"
										},
										{
											"key": "packageUuid",
											"value": "9057b69d-629f-4056-8701-c26025d53ba1"
										}
									]
								},
								"description": "Will send new status for a shipment. Shipment unique identifier (tag) will be provided in the URI ({shipmentUuid}). The date formats accepted are either UTC (2020-11-18T07:47:38.000Z) or ISO (2020-11-18T07:47:38+01:00)."
							},
							"response": []
						}
					],
					"auth": {
						"type": "bearer",
						"bearer": [
							{
								"key": "token",
								"value": "{{authToken}}",
								"type": "string"
							}
						]
					},
					"event": [
						{
							"listen": "prerequest",
							"script": {
								"type": "text/javascript",
								"exec": [
									""
								]
							}
						},
						{
							"listen": "test",
							"script": {
								"type": "text/javascript",
								"exec": [
									""
								]
							}
						}
					]
				}
			]
		},
		{
			"name": "Generate auth token",
			"event": [
				{
					"listen": "test",
					"script": {
						"exec": [
							"pm.environment.set(\"authToken\",pm.response.json().access_token)"
						],
						"type": "text/javascript"
					}
				}
			],
			"request": {
				"method": "POST",
				"header": [
					{
						"key": "Content-Type",
						"value": "application/x-www-form-urlencoded",
						"type": "text"
					}
				],
				"body": {
					"mode": "urlencoded",
					"urlencoded": [
						{
							"key": "client_id",
							"value": "insert_here_your_client_id",
							"type": "text"
						},
						{
							"key": "client_secret",
							"value": "insert_here_your_client_secret",
							"type": "text"
						},
						{
							"key": "grant_type",
							"value": "client_credentials",
							"type": "text"
						}
					]
				},
				"url": {
					"raw": "https://www.consignorportal.com/idsrv/connect/token",
					"protocol": "https",
					"host": [
						"www",
						"consignorportal",
						"com"
					],
					"path": [
						"idsrv",
						"connect",
						"token"
					]
				}
			},
			"response": []
		}
	],
	"event": [
		{
			"listen": "prerequest",
			"script": {
				"type": "text/javascript",
				"exec": [
					""
				]
			}
		},
		{
			"listen": "test",
			"script": {
				"type": "text/javascript",
				"exec": [
					""
				]
			}
		}
	],
	"variable": [
		{
			"key": "authToken",
			"value": ""
		}
	]
}