...
Expand | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
GET /pickuppoint/GetPickUpPoints/{countryCode}/{postCode}/{carrier}This action returns a list of pick-up points close to the postcode that was sent to this action. Must contain country code, postcode and name of carrier.
The url must be constructed using this format, although street and streetNumber are optional fields: URL Pattern
Replace {countryCode} with a valid ISO2 country code, {postCode} with a valid and existing postcode, and {carrier} with the name of a carrier supported in the Proteria systems. Replace {street} with a valid street name in the currently selected {postCode}. For example, is you call this action with country code NO, post code 9991 and carrier Bring: URL Example
Result: JSON response
|
Expand | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
GET /pickuppoint/GetParcelBoxPoints/{carrier}/{countryCode}/{postCode}This action returns a list of parcel boxes close to the postcode that was sent to this action. Must contain name of carrier, country code, and postcode.
The url must be constructed using this format, although street and streetNumber are optional fields: URL Pattern
Replace {countryCode} with a valid ISO2 country code, {postCode} with a valid and existing postcode, and {carrier} with the name of a carrier supported in the Proteria systems. Replace {street} with a valid street name in the currently selected {postCode}. For example, is you call this action with carrier Bring, country code NO, post code 1712: URL Example
Result: JSON response
|
Expand | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
GET /pickuppoint/GetMannedPickupPoints/{carrier}/{countryCode}/{postCode}This action returns a list of manned pickup points close to the postcode that was sent to this action. Must contain name of carrier, country code, and postcode.
The url must be constructed using this format, although street and streetNumber are optional fields: URL Pattern
Replace {countryCode} with a valid ISO2 country code, {postCode} with a valid and existing postcode, and {carrier} with the name of a carrier supported in the Proteria systems. Replace {street} with a valid street name in the currently selected {postCode}. For example, is you call this action with carrier Bring, country code NO, post code 1712: URL Example
Result: JSON response
|
Shipment API
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
POST /shipment/CreateShipmentsWith this action, you can create one or more shipments in our systems. The JSON must be inside the "Body" of the request, and the header "Content-Type" should be set to "application/json".
The values for "PackageType", "CashOnDelivery" and "Services" are optional. The JSON must look like this: JSON request
If successful, you will get this response: JSON response
X will equal the amount of shipments successfully created. |
Expand | |||||
---|---|---|---|---|---|
| |||||
POST /shipment/CreateShipmentsForOrderWith this action, you can create one or more shipments to an order that has previously been created/placed in our systems. In other words, you must have run "POST /CreateNewOrder" before you can run this action. This action uses the orderid of an order that already exists in our systems, and this orderid will be used to connect a shipment to an order. The JSON must be inside the "Body" of the request, and the header "Content-Type" should be set to "application/json".
The values for "PackageType", "PickUpPointId", "CashOnDelivery" and "Services" are optional, however if they are set, the will override the corresponding values in the order. This means that The JSON must look like this: JSON request
|
...
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
GET /print/GetPrintersURL Format
JSON response
|
Expand | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
POST /print/PrintThis action print the label(s) of shipment(s) within the shipmentIds parameter, by sending a print job to the either
The shipmentIds parameter must contain (an) id(s) of a shipment previously created through the CreateShipment-action in the API, The fields inside the Printers field, namely A4PrinterId, LabelPrinterId, RFIDPrinterId and PiPPrinterId parameters must contain the id of a printer that is connected to your Proteria Cloud Print Box, thus making it When PrintReturnLabel is set to true, return shipments created with the CreateShipment action and the GenerateReturn flag set to true, will be printed out if available
JSON request
URL Pattern: URL Format
The fully constructed url: URL Example - Single Shipment
|
...