{ "info": { "_postman_id": "59756653-9d64-4d72-947a-aaca57885b61", "name": "PostNord Norge Collection", "description": "Collection of sample requests for the API's offered by PostNord NO. Visit our developer portal at https://developer.postnord.no/ for general and technical documentation of each API and their endpoints.\r\n\r\nAll API's are authenticated with using the Oauth 2.0 Client Credentials Grant. This means that API requests must pass a bearer token in the Authorization header, which is first retrieved from our authentication API. In our Postman collection, aquiring such a token is handled in the pre-request script and the token is afterwards stored in a global variable. Thus, for quick authentication with all API's in the collection,simply edit the \"Variables\" section of the collection and add your organization's client_id and client_secret in the \"Current value\" column.\r\n\r\nIf you do not yet have a client_id and client_secret, check our getting started guide for getting started with our API's at https://developer.postnord.no/get-started.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "10551975", "_collection_link": "https://pn-cap-api.postman.co/workspace/Work~493d8291-043e-4b6a-977c-27765de0bec4/collection/10551975-59756653-9d64-4d72-947a-aaca57885b61?action=share&source=collection_link&creator=10551975" }, "item": [ { "name": "Authentication", "item": [ { "name": "Authentication", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "client_id", "value": "{{client_id}}", "type": "text" }, { "key": "client_secret", "value": "{{client_secret}}", "type": "text" }, { "key": "grant_type", "value": "client_credentials", "type": "text" } ] }, "url": { "raw": "https://auth.postnord.no/auth/realms/3Scale-prod/protocol/openid-connect/token", "protocol": "https", "host": [ "auth", "postnord", "no" ], "path": [ "auth", "realms", "3Scale-prod", "protocol", "openid-connect", "token" ] }, "description": "Endpoint for retrieving a JWT for authentication with PostNord NO API's.\r\n\r\nThe endpoint use the Oauth 2.0 Client Credentials Grant. Define the Client ID and Client Secret in the collection variables to apply them as parameter values here." }, "response": [] } ], "description": "Authentication is handled automatically by the collection script for all requests in the collection. View the collection description and variables to set up authentication for Postman runs.\r\n\r\nThis folder and associated request is included to explicitly document and test the authentication endpoint without further calling an API.", "auth": { "type": "noauth" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Business to Consumer (B2C)", "item": [ { "name": "Product availability lookup", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } }, { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"settings\": {\r\n \"customerId\": \"1234...\",\r\n \"parcelLetterMaxPrice\": {\r\n \"value\": 10000,\r\n \"currency\": \"NOK\"\r\n },\r\n \"maxSpCount\": 2,\r\n \"maxSpDistance\": 500,\r\n \"products\": [\r\n \"mypackcollect\"\r\n ]\r\n },\r\n \"consignment\": {\r\n \"consignor\": {\r\n \"streetAddress\": \"Pakkevei 24\",\r\n \"postalCode\": \"4876\"\r\n },\r\n \"consignee\": {\r\n \"streetAddress\": \"Postnordveien 13\",\r\n \"postalCode\": \"0010\"\r\n },\r\n \"shippingDate\": \"2020-01-27\",\r\n \"colli\": [\r\n {\r\n \"weight\": 12,\r\n \"height\": 35,\r\n \"length\": 25,\r\n \"width\": 15\r\n }\r\n ],\r\n \"shoppingCartTotalPrice\": {\r\n \"value\": 9000,\r\n \"currency\": \"NOK\"\r\n }\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/api/products", "host": [ "{{baseUrl}}" ], "path": [ "rest", "api", "products" ] }, "description": "See https://developer.postnord.no/browse-api/docs?api=rest-api-b2c-products for documentation and example requests." }, "response": [] } ], "description": "The only integration you need for all PostNord B2C products. With integration in your check out you can provide the consumer with multiple choices of delivery with all information of when and where the parcel will be delivered." }, { "name": "Booking v2", "item": [ { "name": "Booking - Valid Products", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"name\": null,\r\n \"shipmentId\": null,\r\n \"originalShipmentId\": null,\r\n \"isReturnShipment\": false,\r\n \"returnCode\": null,\r\n \"cod\": {\r\n \"bankAccountNo\": null,\r\n \"customerOrderReference\": null,\r\n \"paid\": {\r\n \"currency\": \"NOK\",\r\n \"value\": 0,\r\n \"vat\": 0\r\n },\r\n \"rest\": {\r\n \"currency\": \"NOK\",\r\n \"value\": 0,\r\n \"vat\": 0\r\n },\r\n \"total\": {\r\n \"currency\": \"NOK\",\r\n \"value\": 0,\r\n \"vat\": 0\r\n }\r\n },\r\n \"packages\": [\r\n {\r\n \"heightInCmt\": 50,\r\n \"lengthInCmt\": 40,\r\n \"grossWeightInKgm\": 20,\r\n \"widthInCmt\": 30,\r\n \"volumeInDmq\": 0,\r\n \"loadingMetres\": 0,\r\n \"articleNumbers\": [],\r\n \"id\": null\r\n }\r\n ],\r\n \"parties\": {\r\n \"freightPayer\": {\r\n \"customerId\": \"1234...\",\r\n \"reference\": null,\r\n \"contact\": {\r\n \"id\": null,\r\n \"eMailAddress\": null,\r\n \"contactName\": null,\r\n \"countryCallingCode\": \"0047\",\r\n \"mobileNumber\": null,\r\n \"phoneNo\": null\r\n },\r\n \"type\": \"BUSINESS\",\r\n \"name\": \"Example Business\",\r\n \"physicalAddress\": {\r\n \"street\": \"Examplestreet 99\",\r\n \"street2\": null,\r\n \"postalCode\": \"6300\",\r\n \"city\": \"Åndalsnes\",\r\n \"countryCode\": \"NO\"\r\n },\r\n \"information\": null\r\n },\r\n \"consignee\": {\r\n \"customerId\": null,\r\n \"reference\": null,\r\n \"contact\": {\r\n \"id\": null,\r\n \"eMailAddress\": null,\r\n \"contactName\": null,\r\n \"countryCallingCode\": \"0047\",\r\n \"mobileNumber\": null,\r\n \"phoneNo\": null\r\n },\r\n \"type\": \"BUSINESS\",\r\n \"name\": \"PostNord AS\",\r\n \"physicalAddress\": {\r\n \"street\": \"Postnordveien 13\",\r\n \"street2\": null,\r\n \"postalCode\": \"0010\",\r\n \"city\": \"OSLO\",\r\n \"countryCode\": \"NO\"\r\n },\r\n \"information\": null\r\n },\r\n \"consignor\": {\r\n \"customerId\": \"1234...\",\r\n \"reference\": null,\r\n \"contact\": {\r\n \"id\": null,\r\n \"eMailAddress\": null,\r\n \"contactName\": null,\r\n \"countryCallingCode\": \"0047\",\r\n \"mobileNumber\": null,\r\n \"phoneNo\": null\r\n },\r\n \"type\": \"BUSINESS\",\r\n \"name\": \"Example Name\",\r\n \"physicalAddress\": {\r\n \"street\": \"Pakkevei 24\",\r\n \"street2\": null,\r\n \"postalCode\": \"4876\",\r\n \"city\": \"Grimstad\",\r\n \"countryCode\": \"NO\"\r\n },\r\n \"information\": null\r\n },\r\n \"returnParty\": {\r\n \"customerId\": null,\r\n \"reference\": null,\r\n \"contact\": null,\r\n \"type\": null,\r\n \"name\": null,\r\n \"physicalAddress\": null,\r\n \"information\": null\r\n },\r\n \"originalShipper\": {\r\n \"customerId\": null,\r\n \"reference\": null,\r\n \"contact\": {\r\n \"id\": null,\r\n \"eMailAddress\": null,\r\n \"contactName\": null,\r\n \"countryCallingCode\": null,\r\n \"mobileNumber\": null,\r\n \"phoneNo\": null\r\n },\r\n \"type\": \"BUSINESS\",\r\n \"name\": null,\r\n \"physicalAddress\": null,\r\n \"information\": null\r\n },\r\n \"pickupPoint\": {\r\n \"customerId\": null,\r\n \"reference\": null,\r\n \"contact\": {\r\n \"id\": null,\r\n \"eMailAddress\": null,\r\n \"contactName\": null,\r\n \"countryCallingCode\": null,\r\n \"mobileNumber\": null,\r\n \"phoneNo\": null\r\n },\r\n \"type\": \"BUSINESS\",\r\n \"name\": null,\r\n \"physicalAddress\": null,\r\n \"information\": null\r\n }\r\n },\r\n \"product\": {\r\n \"name\": null,\r\n \"code\": null,\r\n \"variants\": [],\r\n \"options\": [],\r\n \"costComponents\": []\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/transport-booking/v2/booking/products", "host": [ "{{baseUrl}}" ], "path": [ "rest", "transport-booking", "v2", "booking", "products" ] } }, "response": [] }, { "name": "Booking - PickupTypes", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"payment\": {\r\n \"transactionIdentifier\": null,\r\n \"amount\": {\r\n \"currency\": \"NOK\",\r\n \"value\": 0,\r\n \"vat\": 0\r\n },\r\n \"orderReference\": null,\r\n \"paymentProvider\": \"POSTNORD\"\r\n },\r\n \"files\": [\r\n {\r\n \"originalFilename\": null,\r\n \"fileSize\": 0,\r\n \"contentType\": null,\r\n \"description\": null,\r\n \"content\": null,\r\n \"createdAtDateTime\": \"2020-11-24T12:35:42Z\"\r\n }\r\n ],\r\n \"pickup\": {\r\n \"type\": \"D\",\r\n \"pickupToday\": true,\r\n \"printParty\": \"CONSIGNOR\",\r\n \"pickupReference\": null,\r\n \"readyFromDateTime\": \"2020-12-18T10:06:11Z\",\r\n \"information\": null,\r\n \"chosenDeliveryParty\": null,\r\n \"chosenTimeSlot\": null,\r\n \"price\": null\r\n },\r\n \"consignments\": [\r\n {\r\n \"isImport\": false,\r\n \"name\": null,\r\n \"shipmentId\": null,\r\n \"originalShipmentId\": null,\r\n \"isReturnShipment\": false,\r\n \"returnCode\": null,\r\n \"cod\": {\r\n \"bankAccountNo\": null,\r\n \"customerOrderReference\": null,\r\n \"paid\": {\r\n \"currency\": \"NOK\",\r\n \"value\": \"0\",\r\n \"vat\": 0\r\n },\r\n \"rest\": {\r\n \"currency\": \"NOK\",\r\n \"value\": \"0\",\r\n \"vat\": 0\r\n },\r\n \"total\": {\r\n \"currency\": \"NOK\",\r\n \"value\": \"0\",\r\n \"vat\": 0\r\n }\r\n },\r\n \"packages\": [\r\n {\r\n \"heightInCmt\": \"80\",\r\n \"lengthInCmt\": \"120\",\r\n \"grossWeightInKgm\": \"125\",\r\n \"widthInCmt\": \"80\",\r\n \"volumeInDmq\": \"825.6\",\r\n \"loadingMetres\": \"0\",\r\n \"articleNumbers\": [],\r\n \"id\": null\r\n }\r\n ],\r\n \"parties\": {\r\n \"freightPayer\": {\r\n \"customerId\": \"1234...\",\r\n \"reference\": null,\r\n \"contact\": {\r\n \"id\": null,\r\n \"eMailAddress\": null,\r\n \"contactName\": null,\r\n \"countryCallingCode\": \"0047\",\r\n \"mobileNumber\": null,\r\n \"phoneNo\": null\r\n },\r\n \"type\": \"BUSINESS\",\r\n \"name\": \"Example Business\",\r\n \"physicalAddress\": {\r\n \"street\": \"Examplestreet 99\",\r\n \"street2\": null,\r\n \"postalCode\": \"6300\",\r\n \"city\": \"Åndalsnes\",\r\n \"countryCode\": \"NO\"\r\n },\r\n \"information\": null\r\n },\r\n \"consignee\": {\r\n \"customerId\": null,\r\n \"reference\": null,\r\n \"contact\": {\r\n \"id\": null,\r\n \"eMailAddress\": null,\r\n \"contactName\": null,\r\n \"countryCallingCode\": \"0047\",\r\n \"mobileNumber\": null,\r\n \"phoneNo\": null\r\n },\r\n \"type\": \"BUSINESS\",\r\n \"name\": \"Example AS\",\r\n \"physicalAddress\": {\r\n \"street\": \"Postnordveien 13\",\r\n \"street2\": null,\r\n \"postalCode\": \"0010\",\r\n \"city\": \"OSLO\",\r\n \"countryCode\": \"NO\"\r\n },\r\n \"information\": null\r\n },\r\n \"consignor\": {\r\n \"customerId\": \"1234...\",\r\n \"reference\": null,\r\n \"contact\": {\r\n \"id\": null,\r\n \"eMailAddress\": null,\r\n \"contactName\": null,\r\n \"countryCallingCode\": \"0047\",\r\n \"mobileNumber\": null,\r\n \"phoneNo\": null\r\n },\r\n \"type\": \"BUSINESS\",\r\n \"name\": \"Example Business\",\r\n \"physicalAddress\": {\r\n \"street\": \"Examplestreet 99\",\r\n \"street2\": null,\r\n \"postalCode\": \"6300\",\r\n \"city\": \"Åndalsnes\",\r\n \"countryCode\": \"NO\"\r\n },\r\n \"information\": null\r\n },\r\n \"returnParty\": {\r\n \"customerId\": null,\r\n \"reference\": null,\r\n \"contact\": null,\r\n \"type\": null,\r\n \"name\": null,\r\n \"physicalAddress\": null,\r\n \"information\": null\r\n },\r\n \"originalShipper\": {\r\n \"customerId\": null,\r\n \"reference\": null,\r\n \"contact\": {\r\n \"id\": null,\r\n \"eMailAddress\": null,\r\n \"contactName\": null,\r\n \"countryCallingCode\": null,\r\n \"mobileNumber\": null,\r\n \"phoneNo\": null\r\n },\r\n \"type\": \"BUSINESS\",\r\n \"name\": null,\r\n \"physicalAddress\": null,\r\n \"information\": null\r\n },\r\n \"pickupPoint\": {\r\n \"customerId\": null,\r\n \"reference\": null,\r\n \"contact\": {\r\n \"id\": null,\r\n \"eMailAddress\": null,\r\n \"contactName\": null,\r\n \"countryCallingCode\": null,\r\n \"mobileNumber\": null,\r\n \"phoneNo\": null\r\n },\r\n \"type\": \"BUSINESS\",\r\n \"name\": null,\r\n \"physicalAddress\": null,\r\n \"information\": null\r\n }\r\n },\r\n \"product\": {\r\n \"name\": \"PostNord Groupage\",\r\n \"code\": 83,\r\n \"variants\": [],\r\n \"options\": [],\r\n \"costComponents\": []\r\n },\r\n \"price\": null,\r\n \"labelsUrl\": null\r\n }\r\n ],\r\n \"price\": null,\r\n \"costComponents\": [],\r\n \"labelsUrl\": null\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/transport-booking/v2/booking/pickupTypes", "host": [ "{{baseUrl}}" ], "path": [ "rest", "transport-booking", "v2", "booking", "pickupTypes" ] } }, "response": [] }, { "name": "Booking - Validate", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"payment\": {\r\n \"transactionIdentifier\": null,\r\n \"amount\": {\r\n \"currency\": \"NOK\",\r\n \"value\": 0,\r\n \"vat\": 0\r\n },\r\n \"orderReference\": null,\r\n \"paymentProvider\": \"POSTNORD\"\r\n },\r\n \"files\": [\r\n {\r\n \"originalFilename\": null,\r\n \"fileSize\": 0,\r\n \"contentType\": null,\r\n \"description\": null,\r\n \"content\": null,\r\n \"createdAtDateTime\": \"2020-11-24T12:35:42Z\"\r\n }\r\n ],\r\n \"pickup\": {\r\n \"type\": \"S\",\r\n \"pickupToday\": true,\r\n \"postNordPrintsLabel\": false,\r\n \"pickupReference\": null,\r\n \"readyFromDateTime\": \"2020-11-24T22:00:00Z\",\r\n \"information\": null,\r\n \"price\": {\r\n \"discount\": {\r\n \"currency\": \"NOK\",\r\n \"value\": 0,\r\n \"vat\": 0\r\n },\r\n \"tariffAmount\": {\r\n \"currency\": \"NOK\",\r\n \"value\": 0,\r\n \"vat\": 0\r\n },\r\n \"netAmount\": {\r\n \"currency\": \"NOK\",\r\n \"value\": 0,\r\n \"vat\": 0\r\n }\r\n }\r\n },\r\n \"consignments\": [\r\n {\r\n \"isImport\": false,\r\n \"name\": null,\r\n \"shipmentId\": null,\r\n \"originalShipmentId\": null,\r\n \"isReturnShipment\": false,\r\n \"returnCode\": null,\r\n \"cod\": {\r\n \"bankAccountNo\": null,\r\n \"customerOrderReference\": null,\r\n \"paid\": {\r\n \"currency\": \"NOK\",\r\n \"value\": \"0\",\r\n \"vat\": 0\r\n },\r\n \"rest\": {\r\n \"currency\": \"NOK\",\r\n \"value\": \"0\",\r\n \"vat\": 0\r\n },\r\n \"total\": {\r\n \"currency\": \"NOK\",\r\n \"value\": \"0\",\r\n \"vat\": 0\r\n }\r\n },\r\n \"packages\": [\r\n {\r\n \"heightInCmt\": \"80\",\r\n \"lengthInCmt\": \"120\",\r\n \"grossWeightInKgm\": \"450\",\r\n \"widthInCmt\": \"80\",\r\n \"volumeInDmq\": \"825.6\",\r\n \"loadingMetres\": \"0\",\r\n \"articleNumbers\": [],\r\n \"id\": null\r\n }\r\n ],\r\n \"parties\": {\r\n \"freightPayer\": {\r\n \"customerId\": \"1234...\",\r\n \"reference\": null,\r\n \"contact\": {\r\n \"id\": null,\r\n \"eMailAddress\": null,\r\n \"contactName\": null,\r\n \"countryCallingCode\": \"0047\",\r\n \"mobileNumber\": null,\r\n \"phoneNo\": null\r\n },\r\n \"type\": \"BUSINESS\",\r\n \"name\": \"Example Business\",\r\n \"physicalAddress\": {\r\n \"street\": \"Examplestreet 99\",\r\n \"street2\": null,\r\n \"postalCode\": \"6300\",\r\n \"city\": \"Åndalsnes\",\r\n \"countryCode\": \"NO\"\r\n },\r\n \"information\": null\r\n },\r\n \"consignee\": {\r\n \"customerId\": null,\r\n \"reference\": null,\r\n \"contact\": {\r\n \"id\": null,\r\n \"eMailAddress\": null,\r\n \"contactName\": null,\r\n \"countryCallingCode\": \"0047\",\r\n \"mobileNumber\": null,\r\n \"phoneNo\": null\r\n },\r\n \"type\": \"BUSINESS\",\r\n \"name\": \"Example AS\",\r\n \"physicalAddress\": {\r\n \"street\": \"Postnordveien 13\",\r\n \"street2\": null,\r\n \"postalCode\": \"0010\",\r\n \"city\": \"OSLO\",\r\n \"countryCode\": \"NO\"\r\n },\r\n \"information\": null\r\n },\r\n \"consignor\": {\r\n \"customerId\": \"1234...\",\r\n \"reference\": null,\r\n \"contact\": {\r\n \"id\": null,\r\n \"eMailAddress\": null,\r\n \"contactName\": null,\r\n \"countryCallingCode\": \"0047\",\r\n \"mobileNumber\": null,\r\n \"phoneNo\": null\r\n },\r\n \"type\": \"BUSINESS\",\r\n \"name\": \"Example Business\",\r\n \"physicalAddress\": {\r\n \"street\": \"Examplestreet 99\",\r\n \"street2\": null,\r\n \"postalCode\": \"6300\",\r\n \"city\": \"Åndalsnes\",\r\n \"countryCode\": \"NO\"\r\n },\r\n \"information\": null\r\n },\r\n \"returnParty\": {\r\n \"customerId\": null,\r\n \"reference\": null,\r\n \"contact\": null,\r\n \"type\": null,\r\n \"name\": null,\r\n \"physicalAddress\": null,\r\n \"information\": null\r\n },\r\n \"originalShipper\": {\r\n \"customerId\": null,\r\n \"reference\": null,\r\n \"contact\": {\r\n \"id\": null,\r\n \"eMailAddress\": null,\r\n \"contactName\": null,\r\n \"countryCallingCode\": null,\r\n \"mobileNumber\": null,\r\n \"phoneNo\": null\r\n },\r\n \"type\": \"BUSINESS\",\r\n \"name\": null,\r\n \"physicalAddress\": null,\r\n \"information\": null\r\n },\r\n \"pickupPoint\": {\r\n \"customerId\": null,\r\n \"reference\": null,\r\n \"contact\": {\r\n \"id\": null,\r\n \"eMailAddress\": null,\r\n \"contactName\": null,\r\n \"countryCallingCode\": null,\r\n \"mobileNumber\": null,\r\n \"phoneNo\": null\r\n },\r\n \"type\": \"BUSINESS\",\r\n \"name\": null,\r\n \"physicalAddress\": null,\r\n \"information\": null\r\n }\r\n },\r\n \"product\": {\r\n \"name\": \"PostNord Groupage\",\r\n \"code\": 83,\r\n \"variants\": [],\r\n \"options\": [],\r\n \"costComponents\": [\r\n {\r\n \"code\": \"AFF\",\r\n \"description\": \"Additional freight fee\"\r\n },\r\n {\r\n \"code\": \"FRA\",\r\n \"description\": \"Freight\"\r\n },\r\n {\r\n \"code\": \"ABG\",\r\n \"description\": \"Payable by receiver\"\r\n },\r\n {\r\n \"code\": \"BPT\",\r\n \"description\": \"Road toll\"\r\n },\r\n {\r\n \"code\": \"IST\",\r\n \"description\": \"Infrastructure surcharge\"\r\n },\r\n {\r\n \"code\": \"DTL\",\r\n \"description\": \"Energy surcharge\"\r\n }\r\n ]\r\n }\r\n }\r\n ]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/transport-booking/v2/booking/validate", "host": [ "{{baseUrl}}" ], "path": [ "rest", "transport-booking", "v2", "booking", "validate" ] } }, "response": [] }, { "name": "Get booking", "request": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "NB_NO", "type": "text" } ], "url": { "raw": "{{baseUrl}}/rest/transport-booking/v2/booking", "host": [ "{{baseUrl}}" ], "path": [ "rest", "transport-booking", "v2", "booking" ] } }, "response": [] }, { "name": "Booking - Book Shipment", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"payment\": {\r\n \"transactionIdentifier\": null,\r\n \"amount\": {\r\n \"currency\": \"NOK\",\r\n \"value\": 0,\r\n \"vat\": 0\r\n },\r\n \"orderReference\": null,\r\n \"paymentProvider\": \"POSTNORD\"\r\n },\r\n \"files\": [\r\n {\r\n \"originalFilename\": null,\r\n \"fileSize\": 0,\r\n \"contentType\": null,\r\n \"description\": null,\r\n \"content\": null,\r\n \"createdAtDateTime\": \"2020-11-24T12:35:42Z\"\r\n }\r\n ],\r\n \"pickup\": {\r\n \"type\": \"D\",\r\n \"pickupToday\": true,\r\n \"printParty\": \"CONSIGNOR\",\r\n \"pickupReference\": null,\r\n \"readyFromDateTime\": \"2020-12-18T10:06:11Z\",\r\n \"information\": null,\r\n \"chosenDeliveryParty\": null,\r\n \"chosenTimeSlot\": null,\r\n \"price\": null\r\n },\r\n \"consignments\": [\r\n {\r\n \"isImport\": false,\r\n \"name\": null,\r\n \"shipmentId\": null,\r\n \"originalShipmentId\": null,\r\n \"isReturnShipment\": false,\r\n \"returnCode\": null,\r\n \"cod\": {\r\n \"bankAccountNo\": null,\r\n \"customerOrderReference\": null,\r\n \"paid\": {\r\n \"currency\": \"NOK\",\r\n \"value\": \"0\",\r\n \"vat\": 0\r\n },\r\n \"rest\": {\r\n \"currency\": \"NOK\",\r\n \"value\": \"0\",\r\n \"vat\": 0\r\n },\r\n \"total\": {\r\n \"currency\": \"NOK\",\r\n \"value\": \"0\",\r\n \"vat\": 0\r\n }\r\n },\r\n \"packages\": [\r\n {\r\n \"heightInCmt\": \"80\",\r\n \"lengthInCmt\": \"120\",\r\n \"grossWeightInKgm\": \"125\",\r\n \"widthInCmt\": \"80\",\r\n \"volumeInDmq\": \"825.6\",\r\n \"loadingMetres\": \"0\",\r\n \"articleNumbers\": [],\r\n \"id\": null\r\n }\r\n ],\r\n \"parties\": {\r\n \"freightPayer\": {\r\n \"customerId\": \"1234...\",\r\n \"reference\": null,\r\n \"contact\": {\r\n \"id\": null,\r\n \"eMailAddress\": null,\r\n \"contactName\": null,\r\n \"countryCallingCode\": \"0047\",\r\n \"mobileNumber\": null,\r\n \"phoneNo\": null\r\n },\r\n \"type\": \"BUSINESS\",\r\n \"name\": \"Example Business\",\r\n \"physicalAddress\": {\r\n \"street\": \"Examplestreet 99\",\r\n \"street2\": null,\r\n \"postalCode\": \"6300\",\r\n \"city\": \"Åndalsnes\",\r\n \"countryCode\": \"NO\"\r\n },\r\n \"information\": null\r\n },\r\n \"consignee\": {\r\n \"customerId\": null,\r\n \"reference\": null,\r\n \"contact\": {\r\n \"id\": null,\r\n \"eMailAddress\": null,\r\n \"contactName\": null,\r\n \"countryCallingCode\": \"0047\",\r\n \"mobileNumber\": null,\r\n \"phoneNo\": null\r\n },\r\n \"type\": \"BUSINESS\",\r\n \"name\": \"Example AS\",\r\n \"physicalAddress\": {\r\n \"street\": \"Postnordveien 13\",\r\n \"street2\": null,\r\n \"postalCode\": \"0010\",\r\n \"city\": \"OSLO\",\r\n \"countryCode\": \"NO\"\r\n },\r\n \"information\": null\r\n },\r\n \"consignor\": {\r\n \"customerId\": \"1234...\",\r\n \"reference\": null,\r\n \"contact\": {\r\n \"id\": null,\r\n \"eMailAddress\": null,\r\n \"contactName\": null,\r\n \"countryCallingCode\": \"0047\",\r\n \"mobileNumber\": null,\r\n \"phoneNo\": null\r\n },\r\n \"type\": \"BUSINESS\",\r\n \"name\": \"Example Business\",\r\n \"physicalAddress\": {\r\n \"street\": \"Examplestreet 99\",\r\n \"street2\": null,\r\n \"postalCode\": \"6300\",\r\n \"city\": \"Åndalsnes\",\r\n \"countryCode\": \"NO\"\r\n },\r\n \"information\": null\r\n },\r\n \"returnParty\": {\r\n \"customerId\": null,\r\n \"reference\": null,\r\n \"contact\": null,\r\n \"type\": null,\r\n \"name\": null,\r\n \"physicalAddress\": null,\r\n \"information\": null\r\n },\r\n \"originalShipper\": {\r\n \"customerId\": null,\r\n \"reference\": null,\r\n \"contact\": {\r\n \"id\": null,\r\n \"eMailAddress\": null,\r\n \"contactName\": null,\r\n \"countryCallingCode\": null,\r\n \"mobileNumber\": null,\r\n \"phoneNo\": null\r\n },\r\n \"type\": \"BUSINESS\",\r\n \"name\": null,\r\n \"physicalAddress\": null,\r\n \"information\": null\r\n },\r\n \"pickupPoint\": {\r\n \"customerId\": null,\r\n \"reference\": null,\r\n \"contact\": {\r\n \"id\": null,\r\n \"eMailAddress\": null,\r\n \"contactName\": null,\r\n \"countryCallingCode\": null,\r\n \"mobileNumber\": null,\r\n \"phoneNo\": null\r\n },\r\n \"type\": \"BUSINESS\",\r\n \"name\": null,\r\n \"physicalAddress\": null,\r\n \"information\": null\r\n }\r\n },\r\n \"product\": {\r\n \"name\": \"PostNord Groupage\",\r\n \"code\": 83,\r\n \"variants\": [],\r\n \"options\": [],\r\n \"costComponents\": []\r\n },\r\n \"price\": null,\r\n \"labelsUrl\": null\r\n }\r\n ],\r\n \"price\": null,\r\n \"costComponents\": [],\r\n \"labelsUrl\": null\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/transport-booking/v2/booking", "host": [ "{{baseUrl}}" ], "path": [ "rest", "transport-booking", "v2", "booking" ] } }, "response": [] }, { "name": "Booking - Book Return Shipment", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"payment\": {\r\n \"transactionIdentifier\": null,\r\n \"amount\": {\r\n \"currency\": \"NOK\",\r\n \"value\": 0,\r\n \"vat\": 0\r\n },\r\n \"orderReference\": null,\r\n \"paymentProvider\": \"POSTNORD\"\r\n },\r\n \"files\": [\r\n {\r\n \"originalFilename\": null,\r\n \"fileSize\": 0,\r\n \"contentType\": null,\r\n \"description\": null,\r\n \"content\": null,\r\n \"createdAtDateTime\": \"2020-12-18T10:06:11Z\"\r\n }\r\n ],\r\n \"pickup\": {\r\n \"type\": \"O\",\r\n \"pickupToday\": true,\r\n \"postNordPrintsLabel\": true,\r\n \"pickupReference\": null,\r\n \"readyFromDateTime\": \"2020-12-18T10:06:11Z\",\r\n \"information\": null,\r\n \"printParty\": \"DELIVERY_POINT\",\r\n \"chosenDeliveryParty\": {\r\n \"customerId\": \"1234...\",\r\n \"reference\": null,\r\n \"name\": \"EXAMPLE PICKUP\",\r\n \"physicalAddress\": {\r\n \"street\": \"PICKUPVEI 23\",\r\n \"street2\": null,\r\n \"postalCode\": \"3241\",\r\n \"city\": \"SANDEFJORD\",\r\n \"countryCode\": \"NO\"\r\n },\r\n \"meta\": null\r\n },\r\n \"chosenTimeSlot\": null\r\n },\r\n \"consignments\": [\r\n {\r\n \"name\": null,\r\n \"shipmentId\": null,\r\n \"originalShipmentId\": null,\r\n \"isReturnShipment\": true,\r\n \"returnCode\": \"somecode\",\r\n \"cod\": {\r\n \"bankAccountNo\": null,\r\n \"customerOrderReference\": null,\r\n \"paid\": {\r\n \"currency\": \"NOK\",\r\n \"value\": 0,\r\n \"vat\": 0\r\n },\r\n \"rest\": {\r\n \"currency\": \"NOK\",\r\n \"value\": 0,\r\n \"vat\": 0\r\n },\r\n \"total\": {\r\n \"currency\": \"NOK\",\r\n \"value\": 0,\r\n \"vat\": 0\r\n }\r\n },\r\n \"packages\": [\r\n {\r\n \"heightInCmt\": 0,\r\n \"lengthInCmt\": 0,\r\n \"grossWeightInKgm\": 15,\r\n \"widthInCmt\": 0,\r\n \"volumeInDmq\": 0,\r\n \"loadingMetres\": 0,\r\n \"articleNumbers\": [],\r\n \"id\": null\r\n }\r\n ],\r\n \"parties\": {\r\n \"freightPayer\": {\r\n \"customerId\": \"1234...\",\r\n \"reference\": null,\r\n \"contact\": {\r\n \"id\": null,\r\n \"eMailAddress\": null,\r\n \"contactName\": null,\r\n \"countryCallingCode\": null,\r\n \"mobileNumber\": null,\r\n \"phoneNo\": null\r\n },\r\n \"type\": \"BUSINESS\",\r\n \"name\": null,\r\n \"physicalAddress\": {\r\n \"street\": null,\r\n \"street2\": null,\r\n \"postalCode\": null,\r\n \"city\": null,\r\n \"countryCode\": \"NO\"\r\n },\r\n \"information\": null\r\n },\r\n \"consignee\": {\r\n \"customerId\": null,\r\n \"reference\": null,\r\n \"contact\": {\r\n \"id\": null,\r\n \"eMailAddress\": null,\r\n \"contactName\": null,\r\n \"countryCallingCode\": null,\r\n \"mobileNumber\": null,\r\n \"phoneNo\": null\r\n },\r\n \"type\": \"BUSINESS\",\r\n \"name\": null,\r\n \"physicalAddress\": {\r\n \"street\": null,\r\n \"street2\": null,\r\n \"postalCode\": null,\r\n \"city\": null,\r\n \"countryCode\": \"NO\"\r\n },\r\n \"information\": null\r\n },\r\n \"consignor\": {\r\n \"customerId\": \"1234...\",\r\n \"reference\": null,\r\n \"contact\": {\r\n \"id\": null,\r\n \"eMailAddress\": \"email@example.com\",\r\n \"contactName\": \"Example Name\",\r\n \"countryCallingCode\": \"0047\",\r\n \"mobileNumber\": \"99......\",\r\n \"phoneNo\": null\r\n },\r\n \"type\": \"CONSUMER\",\r\n \"name\": \"Example Name\",\r\n \"physicalAddress\": {\r\n \"street\": \"Consumerveien 18\",\r\n \"street2\": null,\r\n \"postalCode\": \"7506\",\r\n \"city\": \"Stjørdal\",\r\n \"countryCode\": \"NO\"\r\n },\r\n \"information\": null\r\n },\r\n \"returnParty\": null,\r\n \"originalShipper\": {\r\n \"customerId\": null,\r\n \"reference\": null,\r\n \"contact\": {\r\n \"id\": null,\r\n \"eMailAddress\": null,\r\n \"contactName\": null,\r\n \"countryCallingCode\": null,\r\n \"mobileNumber\": null,\r\n \"phoneNo\": null\r\n },\r\n \"type\": \"BUSINESS\",\r\n \"name\": null,\r\n \"physicalAddress\": {\r\n \"street\": null,\r\n \"street2\": null,\r\n \"postalCode\": null,\r\n \"city\": null,\r\n \"countryCode\": \"NO\"\r\n },\r\n \"information\": null\r\n },\r\n \"pickupPoint\": {\r\n \"customerId\": null,\r\n \"reference\": null,\r\n \"contact\": {\r\n \"id\": null,\r\n \"eMailAddress\": null,\r\n \"contactName\": null,\r\n \"countryCallingCode\": null,\r\n \"mobileNumber\": null,\r\n \"phoneNo\": null\r\n },\r\n \"type\": \"BUSINESS\",\r\n \"name\": null,\r\n \"physicalAddress\": {\r\n \"street\": null,\r\n \"street2\": null,\r\n \"postalCode\": null,\r\n \"city\": null,\r\n \"countryCode\": \"NO\"\r\n },\r\n \"information\": null\r\n }\r\n },\r\n \"product\": {\r\n \"name\": null,\r\n \"code\": null,\r\n \"variants\": [],\r\n \"options\": [],\r\n \"costComponents\": []\r\n }\r\n }\r\n ]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/transport-booking/v2/booking", "host": [ "{{baseUrl}}" ], "path": [ "rest", "transport-booking", "v2", "booking" ] } }, "response": [] } ], "description": "The Booking API is used to perform complete bookings in the PostNord system from scratch, where one registers all necessary information for each shipment and parcel.\n\nConceptually, this API is very similar to EDI. The main difference between this API and the EDI is that EDI files are sent asynchronously (e.g. via FTP) without any response back, while this API is designed to be called from interactive user interfaces." }, { "name": "Tracking", "item": [ { "name": "Track Shipment", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/shipments/track/1234567890", "host": [ "{{baseUrl}}" ], "path": [ "rest", "shipments", "track", "1234567890" ] } }, "response": [] } ] }, { "name": "Pickuptasks", "item": [ { "name": "{id}", "item": [ { "name": "Get one pickuptask by id.", "request": { "method": "GET", "header": [ { "description": "(Required) This is the language used in the response. Supported languages: Norwegian (\"nb_no\" or \"no\") and english: (\"en_gb\", or \"en\")", "key": "Accept-Language", "value": "ipsum ad ut" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/pickups/:id", "host": [ "{{baseUrl}}" ], "path": [ "rest", "pickups", ":id" ], "variable": [ { "key": "id", "value": "ipsum ad ut", "description": "(Required) The id of the pickuptask." } ] } }, "response": [ { "name": "The pickuptask with given id.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" }, { "description": "(Required) This is the language used in the response. Supported languages: Norwegian (\"nb_no\" or \"no\") and english: (\"en_gb\", or \"en\")", "key": "Accept-Language", "value": "ipsum ad ut" } ], "url": { "raw": "{{baseUrl}}/pickups/:id", "host": [ "{{baseUrl}}" ], "path": [ "pickups", ":id" ], "variable": [ { "key": "id", "value": "ipsum ad ut", "description": "(Required) The id of the pickuptask." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"summary\": \"Get one pickup task response\",\n \"externalValue\": \"https://developer.postnord.no/oas-examples/pickups/get-one-response.json\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" }, { "description": "(Required) This is the language used in the response. Supported languages: Norwegian (\"nb_no\" or \"no\") and english: (\"en_gb\", or \"en\")", "key": "Accept-Language", "value": "ipsum ad ut" } ], "url": { "raw": "{{baseUrl}}/pickups/:id", "host": [ "{{baseUrl}}" ], "path": [ "pickups", ":id" ], "variable": [ { "key": "id", "value": "ipsum ad ut", "description": "(Required) The id of the pickuptask." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"summary\": \"Unauthorized response\",\n \"externalValue\": \"https://developer.postnord.no/oas-examples/pickups/unauthorized-response.json\"\n}" }, { "name": "Resource not found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" }, { "description": "(Required) This is the language used in the response. Supported languages: Norwegian (\"nb_no\" or \"no\") and english: (\"en_gb\", or \"en\")", "key": "Accept-Language", "value": "ipsum ad ut" } ], "url": { "raw": "{{baseUrl}}/pickups/:id", "host": [ "{{baseUrl}}" ], "path": [ "pickups", ":id" ], "variable": [ { "key": "id", "value": "ipsum ad ut", "description": "(Required) The id of the pickuptask." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Validation or other input error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" }, { "description": "(Required) This is the language used in the response. Supported languages: Norwegian (\"nb_no\" or \"no\") and english: (\"en_gb\", or \"en\")", "key": "Accept-Language", "value": "ipsum ad ut" } ], "url": { "raw": "{{baseUrl}}/pickups/:id", "host": [ "{{baseUrl}}" ], "path": [ "pickups", ":id" ], "variable": [ { "key": "id", "value": "ipsum ad ut", "description": "(Required) The id of the pickuptask." } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Updates a pickuptask", "request": { "method": "PUT", "header": [ { "description": "(Required) This is the language used in the response. Supported languages: Norwegian (\"nb_no\" or \"no\") and english: (\"en_gb\", or \"en\")", "key": "Accept-Language", "value": "ipsum ad ut" }, { "description": "(Required) The name of the user who has created or edited the pickuptask.", "key": "Changed-By", "value": "ipsum ad ut" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"summary\": \"Create a new pickup task\",\n \"externalValue\": \"https://developer.postnord.no/oas-examples/pickups/create-request.json\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/pickups/:id", "host": [ "{{baseUrl}}" ], "path": [ "rest", "pickups", ":id" ], "variable": [ { "key": "id", "value": "ipsum ad ut", "description": "(Required) The id of the pickuptask to be updated." } ] }, "description": "Updates a pickuptask. Only add/remove shipments are supported right now." }, "response": [ { "name": "The updated pickuptask.", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" }, { "description": "(Required) This is the language used in the response. Supported languages: Norwegian (\"nb_no\" or \"no\") and english: (\"en_gb\", or \"en\")", "key": "Accept-Language", "value": "ipsum ad ut" }, { "description": "(Required) The name of the user who has created or edited the pickuptask.", "key": "Changed-By", "value": "ipsum ad ut" } ], "body": { "mode": "raw", "raw": "{\n \"summary\": \"Create a new pickup task\",\n \"externalValue\": \"https://developer.postnord.no/oas-examples/pickups/create-request.json\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/pickups/:id", "host": [ "{{baseUrl}}" ], "path": [ "pickups", ":id" ], "variable": [ { "key": "id", "value": "ipsum ad ut", "description": "(Required) The id of the pickuptask to be updated." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"summary\": \"Update pickup task response\",\n \"externalValue\": \"https://developer.postnord.no/oas-examples/pickups/update-response.json\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" }, { "description": "(Required) This is the language used in the response. Supported languages: Norwegian (\"nb_no\" or \"no\") and english: (\"en_gb\", or \"en\")", "key": "Accept-Language", "value": "ipsum ad ut" }, { "description": "(Required) The name of the user who has created or edited the pickuptask.", "key": "Changed-By", "value": "ipsum ad ut" } ], "body": { "mode": "raw", "raw": "{\n \"summary\": \"Create a new pickup task\",\n \"externalValue\": \"https://developer.postnord.no/oas-examples/pickups/create-request.json\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/pickups/:id", "host": [ "{{baseUrl}}" ], "path": [ "pickups", ":id" ], "variable": [ { "key": "id", "value": "ipsum ad ut", "description": "(Required) The id of the pickuptask to be updated." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"summary\": \"Unauthorized response\",\n \"externalValue\": \"https://developer.postnord.no/oas-examples/pickups/unauthorized-response.json\"\n}" }, { "name": "Resource not found", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" }, { "description": "(Required) This is the language used in the response. Supported languages: Norwegian (\"nb_no\" or \"no\") and english: (\"en_gb\", or \"en\")", "key": "Accept-Language", "value": "ipsum ad ut" }, { "description": "(Required) The name of the user who has created or edited the pickuptask.", "key": "Changed-By", "value": "ipsum ad ut" } ], "body": { "mode": "raw", "raw": "{\n \"summary\": \"Create a new pickup task\",\n \"externalValue\": \"https://developer.postnord.no/oas-examples/pickups/create-request.json\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/pickups/:id", "host": [ "{{baseUrl}}" ], "path": [ "pickups", ":id" ], "variable": [ { "key": "id", "value": "ipsum ad ut", "description": "(Required) The id of the pickuptask to be updated." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Validation or other input error", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" }, { "description": "(Required) This is the language used in the response. Supported languages: Norwegian (\"nb_no\" or \"no\") and english: (\"en_gb\", or \"en\")", "key": "Accept-Language", "value": "ipsum ad ut" }, { "description": "(Required) The name of the user who has created or edited the pickuptask.", "key": "Changed-By", "value": "ipsum ad ut" } ], "body": { "mode": "raw", "raw": "{\n \"summary\": \"Create a new pickup task\",\n \"externalValue\": \"https://developer.postnord.no/oas-examples/pickups/create-request.json\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/pickups/:id", "host": [ "{{baseUrl}}" ], "path": [ "pickups", ":id" ], "variable": [ { "key": "id", "value": "ipsum ad ut", "description": "(Required) The id of the pickuptask to be updated." } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"summary\": \"Example of validation error for create\",\n \"externalValue\": \"https://developer.postnord.no/oas-examples/pickups/update-validation-error-response.json\"\n}" } ] }, { "name": "Cancels a pickuptask", "request": { "method": "DELETE", "header": [ { "description": "(Required) This is the language used in the response. Supported languages: Norwegian (\"nb_no\" or \"no\") and english: (\"en_gb\", or \"en\")", "key": "Accept-Language", "value": "ipsum ad ut" }, { "description": "(Required) The name of the user who has created the pickuptask, or edited the status of the pickuptask.", "key": "Changed-By", "value": "ipsum ad ut" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/pickups/:id", "host": [ "{{baseUrl}}" ], "path": [ "rest", "pickups", ":id" ], "variable": [ { "key": "id", "value": "ipsum ad ut", "description": "(Required) " } ] }, "description": "Cancelling a pickuptask, by setting the status to K (cancelled by supervisor), or R (cancelled by customer). This will not delete the pickuptask from our databases, and it will still show up in the search results." }, "response": [ { "name": "The pickuptask with status of cancelled.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" }, { "description": "(Required) This is the language used in the response. Supported languages: Norwegian (\"nb_no\" or \"no\") and english: (\"en_gb\", or \"en\")", "key": "Accept-Language", "value": "ipsum ad ut" }, { "description": "(Required) The name of the user who has created the pickuptask, or edited the status of the pickuptask.", "key": "Changed-By", "value": "ipsum ad ut" } ], "url": { "raw": "{{baseUrl}}/pickups/:id", "host": [ "{{baseUrl}}" ], "path": [ "pickups", ":id" ], "variable": [ { "key": "id", "value": "ipsum ad ut", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"summary\": \"Cancel pickup task response\",\n \"externalValue\": \"https://developer.postnord.no/oas-examples/pickups/cancel-response.json\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" }, { "description": "(Required) This is the language used in the response. Supported languages: Norwegian (\"nb_no\" or \"no\") and english: (\"en_gb\", or \"en\")", "key": "Accept-Language", "value": "ipsum ad ut" }, { "description": "(Required) The name of the user who has created the pickuptask, or edited the status of the pickuptask.", "key": "Changed-By", "value": "ipsum ad ut" } ], "url": { "raw": "{{baseUrl}}/pickups/:id", "host": [ "{{baseUrl}}" ], "path": [ "pickups", ":id" ], "variable": [ { "key": "id", "value": "ipsum ad ut", "description": "(Required) " } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"summary\": \"Unauthorized response\",\n \"externalValue\": \"https://developer.postnord.no/oas-examples/pickups/unauthorized-response.json\"\n}" }, { "name": "Resource not found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" }, { "description": "(Required) This is the language used in the response. Supported languages: Norwegian (\"nb_no\" or \"no\") and english: (\"en_gb\", or \"en\")", "key": "Accept-Language", "value": "ipsum ad ut" }, { "description": "(Required) The name of the user who has created the pickuptask, or edited the status of the pickuptask.", "key": "Changed-By", "value": "ipsum ad ut" } ], "url": { "raw": "{{baseUrl}}/pickups/:id", "host": [ "{{baseUrl}}" ], "path": [ "pickups", ":id" ], "variable": [ { "key": "id", "value": "ipsum ad ut", "description": "(Required) " } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Validation or other input error", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" }, { "description": "(Required) This is the language used in the response. Supported languages: Norwegian (\"nb_no\" or \"no\") and english: (\"en_gb\", or \"en\")", "key": "Accept-Language", "value": "ipsum ad ut" }, { "description": "(Required) The name of the user who has created the pickuptask, or edited the status of the pickuptask.", "key": "Changed-By", "value": "ipsum ad ut" } ], "url": { "raw": "{{baseUrl}}/pickups/:id", "host": [ "{{baseUrl}}" ], "path": [ "pickups", ":id" ], "variable": [ { "key": "id", "value": "ipsum ad ut", "description": "(Required) " } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "Search for pickuptasks", "request": { "method": "GET", "header": [ { "description": "(Required) This is the language used in the response. Supported languages: Norwegian (\"nb_no\" or \"no\") and english: (\"en_gb\", or \"en\")", "key": "Accept-Language", "value": "ipsum ad ut" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/pickups?dateField=ipsum ad ut&fromDate=ipsum ad ut&toDate=ipsum ad ut&customerId=ipsum ad ut&departmentId=ipsum ad ut&shipmentId=ipsum ad ut&status=ipsum ad ut&type=ipsum ad ut&pickupReference=ipsum ad ut", "host": [ "{{baseUrl}}" ], "path": [ "rest", "pickups" ], "query": [ { "key": "dateField", "value": "ipsum ad ut", "description": "There are two valid types of datefield-types: \"created\" (when the pickuptask was created) and \"pickupTime\" (when the pickuptask is scheduled for pickup). This is only required when searching by customer id or department id." }, { "key": "fromDate", "value": "ipsum ad ut", "description": "Display search results from this date. If used, toDate-parameter must also be present, which has to be later than fromDate. This is only required when searching by customer id or department id" }, { "key": "toDate", "value": "ipsum ad ut", "description": "Display search results to this date. If used, fromDate-parameter must also be present, which has to be earlier than toDate. This is only required when searching by customer id or department id." }, { "key": "customerId", "value": "ipsum ad ut", "description": "(Required) The customer id of the freightpayer." }, { "key": "departmentId", "value": "ipsum ad ut", "description": "Display search results only for this department-id (terminal). None of the other search-parameters can have values, other than the customerId-parameter which is required for authorization purposes." }, { "key": "shipmentId", "value": "ipsum ad ut", "description": "Finds the pickuptasks the shipment is attached to. None of the other search-parameters can have values, other than the customerId-parameter is required for authorization purposes." }, { "key": "status", "value": "ipsum ad ut", "description": "Finds the pickuptasks with the given status. Must be in combination with customer id or department id." }, { "key": "type", "value": "ipsum ad ut", "description": "Finds the pickuptask with the given type. Must be in combination with customer id or department id." }, { "key": "pickupReference", "value": "ipsum ad ut", "description": "Finds the pickuptasks which is part of given pickupreference. None of the other search-parameters can have values, other than the customerId-parameter which is required for authorization purposes." } ] }, "description": "This will search for any pickuptask by the main search parameters departmentId, pickupReference shipmentId or customerId. When doing the search by departmentId or customerId, it is required to include the fromDate parameter, toDate-parameter and the dateField-parameter, which decides whether to search by the date when the shipments will be picked up, or the date when the pickuptask was created. NB: the customerId query parameter is required for all the search possibilities, not just the search by customer id. It is used for authorization purposes." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" }, { "description": "(Required) This is the language used in the response. Supported languages: Norwegian (\"nb_no\" or \"no\") and english: (\"en_gb\", or \"en\")", "key": "Accept-Language", "value": "ipsum ad ut" } ], "url": { "raw": "{{baseUrl}}/pickups?dateField=ipsum ad ut&fromDate=ipsum ad ut&toDate=ipsum ad ut&customerId=ipsum ad ut&departmentId=ipsum ad ut&shipmentId=ipsum ad ut&status=ipsum ad ut&type=ipsum ad ut&pickupReference=ipsum ad ut", "host": [ "{{baseUrl}}" ], "path": [ "pickups" ], "query": [ { "key": "dateField", "value": "ipsum ad ut" }, { "key": "fromDate", "value": "ipsum ad ut" }, { "key": "toDate", "value": "ipsum ad ut" }, { "key": "customerId", "value": "ipsum ad ut" }, { "key": "departmentId", "value": "ipsum ad ut" }, { "key": "shipmentId", "value": "ipsum ad ut" }, { "key": "status", "value": "ipsum ad ut" }, { "key": "type", "value": "ipsum ad ut" }, { "key": "pickupReference", "value": "ipsum ad ut" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"summary\": \"Get pickup task by customer ID response\",\n \"externalValue\": \"https://developer.postnord.no/oas-examples/pickups/search-response.json\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" }, { "description": "(Required) This is the language used in the response. Supported languages: Norwegian (\"nb_no\" or \"no\") and english: (\"en_gb\", or \"en\")", "key": "Accept-Language", "value": "ipsum ad ut" } ], "url": { "raw": "{{baseUrl}}/pickups?dateField=ipsum ad ut&fromDate=ipsum ad ut&toDate=ipsum ad ut&customerId=ipsum ad ut&departmentId=ipsum ad ut&shipmentId=ipsum ad ut&status=ipsum ad ut&type=ipsum ad ut&pickupReference=ipsum ad ut", "host": [ "{{baseUrl}}" ], "path": [ "pickups" ], "query": [ { "key": "dateField", "value": "ipsum ad ut" }, { "key": "fromDate", "value": "ipsum ad ut" }, { "key": "toDate", "value": "ipsum ad ut" }, { "key": "customerId", "value": "ipsum ad ut" }, { "key": "departmentId", "value": "ipsum ad ut" }, { "key": "shipmentId", "value": "ipsum ad ut" }, { "key": "status", "value": "ipsum ad ut" }, { "key": "type", "value": "ipsum ad ut" }, { "key": "pickupReference", "value": "ipsum ad ut" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"summary\": \"Unauthorized response\",\n \"externalValue\": \"https://developer.postnord.no/oas-examples/pickups/unauthorized-response.json\"\n}" }, { "name": "Resource not found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" }, { "description": "(Required) This is the language used in the response. Supported languages: Norwegian (\"nb_no\" or \"no\") and english: (\"en_gb\", or \"en\")", "key": "Accept-Language", "value": "ipsum ad ut" } ], "url": { "raw": "{{baseUrl}}/pickups?dateField=ipsum ad ut&fromDate=ipsum ad ut&toDate=ipsum ad ut&customerId=ipsum ad ut&departmentId=ipsum ad ut&shipmentId=ipsum ad ut&status=ipsum ad ut&type=ipsum ad ut&pickupReference=ipsum ad ut", "host": [ "{{baseUrl}}" ], "path": [ "pickups" ], "query": [ { "key": "dateField", "value": "ipsum ad ut" }, { "key": "fromDate", "value": "ipsum ad ut" }, { "key": "toDate", "value": "ipsum ad ut" }, { "key": "customerId", "value": "ipsum ad ut" }, { "key": "departmentId", "value": "ipsum ad ut" }, { "key": "shipmentId", "value": "ipsum ad ut" }, { "key": "status", "value": "ipsum ad ut" }, { "key": "type", "value": "ipsum ad ut" }, { "key": "pickupReference", "value": "ipsum ad ut" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Validation or other input error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" }, { "description": "(Required) This is the language used in the response. Supported languages: Norwegian (\"nb_no\" or \"no\") and english: (\"en_gb\", or \"en\")", "key": "Accept-Language", "value": "ipsum ad ut" } ], "url": { "raw": "{{baseUrl}}/pickups?dateField=ipsum ad ut&fromDate=ipsum ad ut&toDate=ipsum ad ut&customerId=ipsum ad ut&departmentId=ipsum ad ut&shipmentId=ipsum ad ut&status=ipsum ad ut&type=ipsum ad ut&pickupReference=ipsum ad ut", "host": [ "{{baseUrl}}" ], "path": [ "pickups" ], "query": [ { "key": "dateField", "value": "ipsum ad ut" }, { "key": "fromDate", "value": "ipsum ad ut" }, { "key": "toDate", "value": "ipsum ad ut" }, { "key": "customerId", "value": "ipsum ad ut" }, { "key": "departmentId", "value": "ipsum ad ut" }, { "key": "shipmentId", "value": "ipsum ad ut" }, { "key": "status", "value": "ipsum ad ut" }, { "key": "type", "value": "ipsum ad ut" }, { "key": "pickupReference", "value": "ipsum ad ut" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"summary\": \"\",\n \"externalValue\": \"https://developer.postnord.no/oas-examples/pickups/search-validation-error-response.json\"\n}" } ] }, { "name": "Creates a new pickuptask", "request": { "method": "POST", "header": [ { "description": "(Required) This is the language used in the response. Supported languages: Norwegian (\"nb_no\" or \"no\") and english: (\"en_gb\", or \"en\")", "key": "Accept-Language", "value": "ipsum ad ut" }, { "description": "(Required) The name of the user who has created the pickuptask, or edited the status of the pickuptask.", "key": "Changed-By", "value": "ipsum ad ut" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"summary\": \"Create a new pickup task\",\n \"externalValue\": \"https://developer.postnord.no/oas-examples/pickups/create-request.json\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/pickups", "host": [ "{{baseUrl}}" ], "path": [ "rest", "pickups" ] }, "description": "Creates a new pickuptask. Optionally with shipments (with valid PostNord shipment ids) or goods (specifying the measurements)." }, "response": [ { "name": "The created pickuptask.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" }, { "description": "(Required) This is the language used in the response. Supported languages: Norwegian (\"nb_no\" or \"no\") and english: (\"en_gb\", or \"en\")", "key": "Accept-Language", "value": "ipsum ad ut" }, { "description": "(Required) The name of the user who has created the pickuptask, or edited the status of the pickuptask.", "key": "Changed-By", "value": "ipsum ad ut" } ], "body": { "mode": "raw", "raw": "{\n \"summary\": \"Create a new pickup task\",\n \"externalValue\": \"https://developer.postnord.no/oas-examples/pickups/create-request.json\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/pickups", "host": [ "{{baseUrl}}" ], "path": [ "pickups" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"pickupTasks\": [\n {\n \"id\": \"1234567\",\n \"pickupReference\": \"W2425384\",\n \"createdAt\": \"2020-06-04T11:33:00.000Z\",\n \"timeSlot\": {\n \"date\": \"2020-10-30\",\n \"from\": \"08:00:00\",\n \"to\": \"16:00:00\"\n },\n \"parties\": {\n \"freightPayer\": {\n \"customerId\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"physicalAddress\": {\n \"value\": \"\"\n },\n \"contact\": {\n \"value\": \"\"\n }\n },\n \"consignor\": {\n \"customerId\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"physicalAddress\": {\n \"value\": \"\"\n },\n \"contact\": {\n \"value\": \"\"\n }\n }\n },\n \"type\": {\n \"code\": \"T\",\n \"descr\": \"Adhoc pickup.\"\n },\n \"status\": {\n \"changedBy\": \"Ola Nordmann\",\n \"code\": \"B\",\n \"descr\": \"Pickup in pickup list without driver link\"\n },\n \"postnordPrintsLabel\": true,\n \"pickupInstructions\": \"Shipment is located at the back of the building.\",\n \"prices\": {\n \"tariff\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n },\n \"vat\": {\n \"value\": \"\"\n }\n },\n \"gross\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n },\n \"vat\": {\n \"value\": \"\"\n }\n },\n \"net\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n },\n \"vat\": {\n \"value\": \"\"\n }\n },\n \"discount\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n },\n \"vat\": {\n \"value\": \"\"\n }\n }\n },\n \"editable\": true,\n \"goods\": {\n \"weight\": 9,\n \"volume\": 1,\n \"items\": 2,\n \"pallets\": 2,\n \"loadMeters\": 4\n },\n \"shipments\": [\n {\n \"shipmentId\": \"70581500175003897\",\n \"itemCount\": 1\n },\n {\n \"shipmentId\": \"70581500175003897\",\n \"itemCount\": 1\n }\n ]\n },\n {\n \"id\": \"1234567\",\n \"pickupReference\": \"W2425384\",\n \"createdAt\": \"2020-06-04T11:33:00.000Z\",\n \"timeSlot\": {\n \"date\": \"2020-10-30\",\n \"from\": \"08:00:00\",\n \"to\": \"16:00:00\"\n },\n \"parties\": {\n \"freightPayer\": {\n \"customerId\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"physicalAddress\": {\n \"value\": \"\"\n },\n \"contact\": {\n \"value\": \"\"\n }\n },\n \"consignor\": {\n \"customerId\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"physicalAddress\": {\n \"value\": \"\"\n },\n \"contact\": {\n \"value\": \"\"\n }\n }\n },\n \"type\": {\n \"code\": \"T\",\n \"descr\": \"Adhoc pickup.\"\n },\n \"status\": {\n \"changedBy\": \"Ola Nordmann\",\n \"code\": \"B\",\n \"descr\": \"Pickup in pickup list without driver link\"\n },\n \"postnordPrintsLabel\": true,\n \"pickupInstructions\": \"Shipment is located at the back of the building.\",\n \"prices\": {\n \"tariff\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n },\n \"vat\": {\n \"value\": \"\"\n }\n },\n \"gross\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n },\n \"vat\": {\n \"value\": \"\"\n }\n },\n \"net\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n },\n \"vat\": {\n \"value\": \"\"\n }\n },\n \"discount\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n },\n \"vat\": {\n \"value\": \"\"\n }\n }\n },\n \"editable\": true,\n \"goods\": {\n \"weight\": 9,\n \"volume\": 1,\n \"items\": 2,\n \"pallets\": 2,\n \"loadMeters\": 4\n },\n \"shipments\": [\n {\n \"shipmentId\": \"70581500175003897\",\n \"itemCount\": 1\n },\n {\n \"shipmentId\": \"70581500175003897\",\n \"itemCount\": 1\n }\n ]\n }\n ]\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" }, { "description": "(Required) This is the language used in the response. Supported languages: Norwegian (\"nb_no\" or \"no\") and english: (\"en_gb\", or \"en\")", "key": "Accept-Language", "value": "ipsum ad ut" }, { "description": "(Required) The name of the user who has created the pickuptask, or edited the status of the pickuptask.", "key": "Changed-By", "value": "ipsum ad ut" } ], "body": { "mode": "raw", "raw": "{\n \"summary\": \"Create a new pickup task\",\n \"externalValue\": \"https://developer.postnord.no/oas-examples/pickups/create-request.json\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/pickups", "host": [ "{{baseUrl}}" ], "path": [ "pickups" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"summary\": \"Unauthorized response\",\n \"externalValue\": \"https://developer.postnord.no/oas-examples/pickups/unauthorized-response.json\"\n}" }, { "name": "Resource not found", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" }, { "description": "(Required) This is the language used in the response. Supported languages: Norwegian (\"nb_no\" or \"no\") and english: (\"en_gb\", or \"en\")", "key": "Accept-Language", "value": "ipsum ad ut" }, { "description": "(Required) The name of the user who has created the pickuptask, or edited the status of the pickuptask.", "key": "Changed-By", "value": "ipsum ad ut" } ], "body": { "mode": "raw", "raw": "{\n \"summary\": \"Create a new pickup task\",\n \"externalValue\": \"https://developer.postnord.no/oas-examples/pickups/create-request.json\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/pickups", "host": [ "{{baseUrl}}" ], "path": [ "pickups" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Validation or other input error", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" }, { "description": "(Required) This is the language used in the response. Supported languages: Norwegian (\"nb_no\" or \"no\") and english: (\"en_gb\", or \"en\")", "key": "Accept-Language", "value": "ipsum ad ut" }, { "description": "(Required) The name of the user who has created the pickuptask, or edited the status of the pickuptask.", "key": "Changed-By", "value": "ipsum ad ut" } ], "body": { "mode": "raw", "raw": "{\n \"summary\": \"Create a new pickup task\",\n \"externalValue\": \"https://developer.postnord.no/oas-examples/pickups/create-request.json\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/pickups", "host": [ "{{baseUrl}}" ], "path": [ "pickups" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"summary\": \"Example of validation error for create\",\n \"externalValue\": \"https://developer.postnord.no/oas-examples/pickups/create-validation-error-response.json\"\n}" } ] }, { "name": "Get a list of valid timeslots", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/pickups/valid-timeslots?postalCode=ipsum ad ut&numOfOptions=ipsum ad ut", "host": [ "{{baseUrl}}" ], "path": [ "rest", "pickups", "valid-timeslots" ], "query": [ { "key": "postalCode", "value": "ipsum ad ut", "description": "(Required) The postal code of the pickup point." }, { "key": "numOfOptions", "value": "ipsum ad ut", "description": "The number of options to show ahead (from the fromDate), the customer or consumer wish to show in the the list. Default is 7. Maximum is 31" } ] }, "description": "Get a list of valid timeslots/pickup-dates for the given postal code. You can specify the number of timeslots between 1 and 31. PostNord will only accept pickups within a month from todays date." }, "response": [ { "name": "List of confirmed pickup dates", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/pickups/valid-timeslots?postalCode=ipsum ad ut&numOfOptions=ipsum ad ut", "host": [ "{{baseUrl}}" ], "path": [ "pickups", "valid-timeslots" ], "query": [ { "key": "postalCode", "value": "ipsum ad ut" }, { "key": "numOfOptions", "value": "ipsum ad ut" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"summary\": \"Get valid timeslots for pickup task response\",\n \"externalValue\": \"https://developer.postnord.no/oas-examples/pickups/get-valid-timeslots-response.json\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/pickups/valid-timeslots?postalCode=ipsum ad ut&numOfOptions=ipsum ad ut", "host": [ "{{baseUrl}}" ], "path": [ "pickups", "valid-timeslots" ], "query": [ { "key": "postalCode", "value": "ipsum ad ut" }, { "key": "numOfOptions", "value": "ipsum ad ut" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"summary\": \"Unauthorized response\",\n \"externalValue\": \"https://developer.postnord.no/oas-examples/pickups/unauthorized-response.json\"\n}" }, { "name": "Resource not found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/pickups/valid-timeslots?postalCode=ipsum ad ut&numOfOptions=ipsum ad ut", "host": [ "{{baseUrl}}" ], "path": [ "pickups", "valid-timeslots" ], "query": [ { "key": "postalCode", "value": "ipsum ad ut" }, { "key": "numOfOptions", "value": "ipsum ad ut" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Validation or other input error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/pickups/valid-timeslots?postalCode=ipsum ad ut&numOfOptions=ipsum ad ut", "host": [ "{{baseUrl}}" ], "path": [ "pickups", "valid-timeslots" ], "query": [ { "key": "postalCode", "value": "ipsum ad ut" }, { "key": "numOfOptions", "value": "ipsum ad ut" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"summary\": \"Get valid timeslots for pickup task response\",\n \"externalValue\": \"https://developer.postnord.no/oas-examples/pickups/get-valid-timeslots-validation-error-response.json\"\n}" } ] }, { "name": "Simple endpoint to probe for a response", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/pickups/health/simple-check", "host": [ "{{baseUrl}}" ], "path": [ "rest", "pickups", "health", "simple-check" ] }, "description": "A simple check to see that it works to call the database for pickuptasks" }, "response": [ { "name": "Successful operation", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/pickups/health/simple-check", "host": [ "{{baseUrl}}" ], "path": [ "pickups", "health", "simple-check" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/pickups/health/simple-check", "host": [ "{{baseUrl}}" ], "path": [ "pickups", "health", "simple-check" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"summary\": \"Unauthorized response\",\n \"externalValue\": \"https://developer.postnord.no/oas-examples/pickups/unauthorized-response.json\"\n}" }, { "name": "Service temporarily unavailable", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/pickups/health/simple-check", "host": [ "{{baseUrl}}" ], "path": [ "pickups", "health", "simple-check" ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "Home Unattended Coverage", "item": [ { "name": "GET coverage by postal code", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/homeUnattendedCoverage/2860", "host": [ "{{baseUrl}}" ], "path": [ "rest", "homeUnattendedCoverage", "2860" ] } }, "response": [] }, { "name": "GET No Coverage List", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/homeUnattendedCoverage/NoCoverageList", "host": [ "{{baseUrl}}" ], "path": [ "rest", "homeUnattendedCoverage", "NoCoverageList" ] } }, "response": [] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{activeAuthToken}}", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "var grantType = \"client_credentials\";", "var clientID = pm.variables.get('client_id');", "var clientSecret = pm.variables.get('client_secret');", "const oidcRequest = {", " url: 'https://auth.postnord.no/auth/realms/3Scale-prod/protocol/openid-connect/token',", " method: 'POST',", " header: 'Content-Type:application/x-www-form-urlencoded',", " body: `grant_type=${grantType}&client_id=${clientID}&client_secret=${clientSecret}`", "};", "", "// Skip pre-request authentication when testing authentication by itself", "if (pm.info.requestName !== \"Authentication\") {", " if (clientID === \"placeholder\" || clientSecret === \"placeholder\") {", " console.error('You need to set variables for client_id and client_secret for the' + ", " 'authentication script to work.');", " return;", " }", "", " if (pm.environment.get('activeAuthToken') &&", " pm.environment.get('authTokenExpiry') && ", " pm.environment.get('authTokenExpiry') >= new Date().getTime()) {", " console.log('JWT is valid, reusing existing token');", " return;", " }", "", " console.log('JWT is invalid or has expired, retrieving a new one');", " pm.sendRequest(oidcRequest, function (err, res) {", " if (err) {", " console.error(\"Request to get authentication token failed\", err);", " return;", " }", "", " if (res.code != 200) {", " console.error('Request to get authetnication token failed. Are you sure ' +", " 'your client_id and client_secret is correct?');", " return;", " }", "", " var responsePayload = res.json();", " pm.environment.set('activeAuthToken', responsePayload.access_token)", " var expiryDate = new Date();", " expiryDate.setSeconds(expiryDate.getSeconds() + responsePayload.expires_in);", " pm.environment.set('authTokenExpiry', expiryDate.getTime());", " });", "}" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ], "variable": [ { "key": "client_id", "value": "placeholder", "disabled": true }, { "key": "client_secret", "value": "placeholder", "disabled": true }, { "key": "client_id", "value": "sandbox placeholder", "type": "string" }, { "key": "client_secret", "value": "sandbox placeholder", "type": "string" }, { "key": "baseUrl", "value": "https://api2.postnord.no/", "type": "string", "disabled": true }, { "key": "baseUrl", "value": "https://atapi2.postnord.no/", "type": "string" } ] }