First make sure you have your login credentials. These credentials can be requested at Pargo. Please visit https://pargo.co.za for more information.
\nFor the majority of requests a requestReference property is send back in the response. You can find this value in the meta property.
When you encounter any problems, please give us this reference and we’ll be able to lookup this specific request en see what went wrong.
In this documentation we will use curly brackets {{ and }} to indicate that these values are variables and should be replaces by your real values (without the curly brackets). Eg. when the example looks like this
{\n \"property\": \"{{abcdef}}\"\n}\n\nYour real request should be like this
\n{\n \"property\": \"yourvalue\"\n}\n\nAs of right now we don’t have a need for the grant_type, client_id and client_secret part of the protocol.
Therefore the only thing you need to send us for the retrieving of a token is the username and password.
When requesting a token through an Authentication or Refresh token request you receive an access_token, refresh_token and expires_in.
To authenticate your API requests you need to add an Authentication header to all requests as follows:
Key: 'Authorization\"
\nValue: 'Bearer YOUR_ACCESS_TOKEN'
\n(notice the space between Bearer and the token)
\nThe access_token expires after some time. This is indicated in the expires_in. expires_in is the amount of seconds the token is valid after creating it (now it is set to 4200 seconds or 70 minutes). When a access_token is expired you can request a new one using the Authenticatio request, but you can also use the Refresh token request. If you choose for the second option you need to send us the refresh_token you've received when requesting the access_token. If the refresh_token is still valid, you'll receive a new access_token and refresh_token. Right now the refresh_token expires in 10 days.
Efficiency and Performance:
\nMinimizing Latency: Authenticating every request introduces significant overhead since each authentication call would involve extra round-trip communication with the authentication server. This would increase the latency for every API call and negatively impact the application's responsiveness.
\nIncreased Load on Authentication Server: Every request made with authentication would result in additional load on the authentication server. If many clients authenticate frequently, this could lead to server overload, slower responses, or potential downtime.
\nRate Limiting and Throttling:
\nAuthenticating on every request increases the number of API calls to Pargo, potentially causing the client to hit rate limits, which would result in failed requests.
\nRepeated authentication can trigger rate-limiting measures or even temporary suspension of access for breaching usage limits.
\nSecurity and Stability:
\nReduced Exposure: OAuth2 tokens are typically short-lived and secure. Once authenticated, the access token is used until it expires, reducing the need to repeatedly transmit sensitive credentials over the network. Authenticating on every request increases the risk of exposing credentials, especially if there's a man-in-the-middle attack.
\nToken Reuse: After the initial authentication, OAuth2 tokens can be reused within their lifespan (typically several minutes to hours). This reuse reduces the risk of sensitive information (like the user's password) being exposed repeatedly.
\nToken Expiration and Refresh:
\nAccess Token Expiration: OAuth2 tokens have expiration times. Instead of constantly re-authenticating, clients should handle the expiration by refreshing the token using a refresh token (which is done in the background). This allows for a more seamless user experience without additional interaction.
\nAvoid Credential Reuse: Constantly sending credentials increases the risk of interception or leaking credentials through logs or debugging information. OAuth2 tokens, once issued, can be revoked or expire automatically, thus offering more secure session management.
\nSimplified Code and Maintenance:
\nReduced Complexity: If authentication happens only once, the code can be simpler and cleaner. There’s no need to handle authentication for every single request, which makes the client easier to maintain and scale.
\nStandard OAuth2 Flow: OAuth2 is designed to use tokens in this manner—authenticate once, then use tokens until they expire. Going against this standard by authenticating every request breaks the natural flow of the OAuth2 protocol and may introduce unnecessary complexity and confusion.
\nPerformance Degradation: Each authentication step introduces unnecessary delay in processing the actual request. Instead of simply sending an access token, the client has to wait for the OAuth provider to verify credentials and return a new token, slowing down the API responses.
\nHigher Risk of Repeated Failures: Authenticating on every request opens up more points of failure, such as network outages or temporary issues with the OAuth provider. If the provider’s authentication service is temporarily unavailable, repeated authentication will likely fail, making the API client unusable.
\nWasted Resources: Each authentication request consumes additional CPU, bandwidth, and other resources, which can be a waste if an existing access token could have been reused.
\nSummary:
In OAuth2, the recommended approach is to authenticate once, retrieve an access token, and use that token until it expires. Once it expires, the client can refresh the token using the refresh token or re-authenticate if necessary. Constant re-authentication introduces unnecessary performance issues, security risks, and complexity, making it far from ideal.
This api uses a rate limiter. This means you'll be able to send us a maximum of 60 requests per minute. Every response will include the X-RateLimit-Limit (the total amount of requests per minute) header and the X-RateLimit-Remaining (how many requests are remaining for this minute) header. If you surpass this limit you'll receive a response with the 429 Too Many Requests status code. The body of that request is:
{\n \"meta\": [],\n \"errors\": [\n {\n \"title\": \"Too Many Attempts.\",\n \"detail\": \"\",\n \"code\": 0,\n \"meta\": []\n }\n ],\n \"success\": false,\n \"statusCode\": 429\n}\nYour page can implement the Pargo Points page via an IFrame or by opening a new window (see code examples in page source) at: https://map.pargo.co.za/demo.html
\nThe Pargo Points page URL is the following:
https://map.pargo.co.za/?token=uvwNZGSiUypW1GHiTGFZiqWWu2W4s78SwUIEWp10GKogqJKt
An additional GET or POST argument called 'address' can be passed through, containing an address string.
Example: https://map.pargo.co.za/?token=uvwNZGSiUypW1GHiTGFZiqWWu2W4s78SwUIEWp10GKogqJKt&address=2 Rembrand Street, Sandton, Johannesburg
If an address request parameter is received, the Pargo page's map will open up centered on this address (if the address string can be reverse geolocated).
If no address request parameter is received, the map will attempt to retrieve the user's current location, and will center the map there.
if (window.addEventListener) { window.addEventListener(\"message\", selectPargoPoint, false); } else { window.attachEvent(\"onmessage\", selectPargoPoint); }
Your page must also contain a javascript method called 'selectPargoPoint(item)' which is called by the Pargo Points page when a user selects a particular point.
The 'item' parameter contains an object called 'data', which is a JSON array, containing details of the selected point.
The JSON array elements of the item.data parameter are:
\n{
\"address1\": \"6th Floor\",
\"address2\": \"62 Roeland Street\",
\"addressSms\": \"6th Floor 62 Roeland Street\",
\"businessHours\": \"Mon-Fri: 8am-5pm\",
\"city\": \"Cape Town\",
\"distance\": 0.06510704065710372,
\"isPublic\": false,
\"latitude\": -33.930081910279,
\"longitude\": 18.422441015418,
\"pargoPointCode\": \"pup2\",
\"phoneNumber\": \"+27214473636\",
\"photo\": \"https://example.org/a48fe6fa-87b4-4cf1-bfc1-41e1450631f8/pup_photo/large.jpg\",
\"photo_small\": null,
\"postalcode\": \"8001\",
\"province\": \"Western Cape\",
\"retailChainName\": \"Pargo\",
\"storeName\": \"Pargo Head Office\",
\"storeOwner\": \"Pargo\",
\"suburb\": \"Gardens\"
}
7. function selectPargoPoint(item){ alert(\"Selected Pargo Point: \" + item.data[\"pargoPointCode\"]); }
8. You can filter both the map and list views to display only Pargo pickup points within a specified radius. To enable or adjust this setting, please contact Pargo.
\n9. The list of Pargo pickup points can also be ordered based on custom criteria instead of the default proximity-based sorting. To enable or adjust this setting, please contact Pargo.
\nFor the following example to work, make sure there is an iframe with a src=\"https://map.pargo.co.za/?token=uvwNZGSiUypW1GHiTGFZiqWWu2W4s78SwUIEWp10GKogqJKt\" and id=\"iframe\". You also need a div with id=\"selected-pup\"
![https://example.org/a48fe6fa-87b4-4cf1-bfc1-41e1450631f8/pup_photo/large.jpg\"](\"https://example.org/a48fe6fa-87b4-4cf1-bfc1-41e1450631f8/pup_photo/large.jpg\"){kind=link}
if (window.addEventListener) {\n window.addEventListener(\"message\", selectPargoPoint, false);\n} else {\n window.attachEvent(\"onmessage\", selectPargoPoint);\n}\nfunction selectPargoPoint(item){\n var html = \"Selected Pargo Point Code: \" + item.data[\"pargoPointCode\"] + \"\";\n html += \"Address: \" + item.data[\"addressSms\"] + \"\";\n let selected = document.getElementById(\"selected-pup\");\n selected.innerHTML = html;\n return false;\n}\n\nUse this endpoint to get the available pickup points, connected to your account
\nThere a some optional parameters you can send us to change the response
\nYou'll get a paginated response. In the meta attribute of the response you'll see the total amount, current count of data in this request, the used limit, the used offset and the current page. These values can be changed using the parameters above.
Use this endpoint to get the available pickup points with the distance based on a geocoded address. The distance is shown in meters.
You can use the same parameters as the \"default\" Get Pickup Points, but for the geocoding you have to use these 2
\nIn addition of the pagination meta you'll also see the geocoderAccuracy and geocoderAddress. These are based on the results of the geocoding. The highest geocoderAccuracy is 5, if this number is lower that could mean we found a region instead of a specific address.
If the geocoderAccuracy is to low, you'll receive a error with title = Low accuracy and statusCode = 422. If the geocoder couldn't find your address at all, you'll receive a error with title = No geocoding results and statusCode = 422.
Use this endpoint to get the available pickup points with the distance based on the provided lat/lng. The response is the same as the Get Pickup Points With Geocoding endpoint, but without the geocode values in the response meta.
You can use the same parameters as the \"default\" Get Pickup Points, but for the geocoding you have to use these 2
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"password","value":"password"},{"key":"username","value":"email@example.com"},{"key":"tokenName","value":"You can integrate your address forms autocomplete functionality using Pargo's Route Guide.
\n(Please note: we'll be adding some different way of authentication in the near future for these routes)
\nprovincesuburbpostalCodecitysearch field you put what you are searching for (eg. city, postalCode) and in the value field you put the actual input.context object alongside your search/value fields. When sending us the context, the system will filter out results that do not match you exact context values. This greatly improves the quality of the results.context object can contain the same values that you can search for.with_matches url parameter. When you add this to your request, the system will also return the 5 closest total matches alongside the autocomplete values. This can be used for even quicker filling in of the address fields by the user.All users are connected to one entity (eg. one supplier or one courier).
However, it is possible to send a request as a different entity (for example, when you're a supplier but you also want to send updates as your own courier).
In consultation with Pargo, 1 or more entities can be added and set up as a sendAs.
You’ll receive the references for these entities.
In the request you can add a meta property at the root level where you can add the sendAs property.
The contents of this field should be the reference of the entity.
Example (sending W2P order as a different supplier):
\n{\n \"meta\": {\n \"sendAs\": \"sup12345\"\n },\n \"data\": {\n \"type\": \"W2P\",\n \"attributes\": {\n \"warehouseAddressCode\": \"Primary\",\n \"returnAddressCode\": \"Primary\",\n \"trackingCode\": \"PAR0000000000\",\n \"externalReference\": null,\n \"pickupPointCode\": \"pup1\",\n \"consignee\": {\n \"firstName\": \"Pargo\",\n \"lastName\": \"CPT\",\n \"email\": \"support@pargo.co.za\",\n \"phoneNumbers\": [\"+27214473636\", \"+27214473637\"]\n }\n }\n }\n}\n\nExample (sending courier updates as a courier):
\n{\n \"meta\": {\n \"sendAs\": \"cou12345\"\n },\n \"data\": {\n \"type\": \"courierTrackingInfo\",\n \"attributes\": {\n \"code\": 10,\n \"timestamp\": \"2019-01-01T09:27:36+02:00\",\n \"orderReference\": \"TRACKINGCODE\",\n \"externalTrackingReference\": \"YOURREFERENCE\",\n \"description\": \"The package is registered in our system\"\n }\n }\n}\n\nThe quotation service, available upon request from Pargo, currently supports only W2D (Warehouse to Door) or W2P (Warehouse to Pickup Point) processes.
\nTo obtain a quotation, submit the same information as you would when creating a new order, with a few additional required values. Specifically, you must include the attributes.totalParcels attribute and provide at least one weight measurement (either cubicWeight or deadWeight) for each parcel—even if you’re sending only one parcel.
IMPORTANT: For the most accurate quote, Pargo recommends sending both cubicWeight AND deadWeight, as the higher of the two will be used to calculate the rate. If only ONE value is provided, the system will use that value exclusively, which may result in an inaccurate quote.
When using the W2P process, the parcels array is ignored and not required, but a pickupPointCode is mandatory. Based on the customer’s address and the warehouse location, a deliveryType (main/regional/local) and the price will be provided in the response.
The values for a single W2P order
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"password","value":"password"},{"key":"username","value":"email@example.com"},{"key":"tokenName","value":"The values for a single W2P order
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"password","value":"password"},{"key":"username","value":"email@example.com"},{"key":"tokenName","value":"A W2P order is an order that starts at a warehouse location, is being delivered at a pickup point and there collected by the customer.
\nNote:
\nWhen you want to send an order for one of your child suppliers, you can fill in the owner property. Please contact Pargo if you have child suppliers so they can set everything up. They'll also tell you what the contents of this property should be.
The trackingCode, externalReference, packageValue and packageDescription properties are optional. The trackingcode must include a valid prefix as discussed with Pargo.
If no trackingCode provided, the system will generate one for you.
Either the consignee.email or consignee.phoneNumbers are required (you can send both).
IMPORTANT: It is best practice to provide both cubicWeight and deadWeight for each order to ensure the accurate rate calculations.
It is possible to send us multiple phone numbers for a consignee if this person should be notified on multiple phone numbers.
\nYou can send either the pickupPointCode or pickupPointExternalReference. The pickupPointCode is the reference you'll get from the map or pickup point api endpoint. For specific vendors it's possible to set up a pickupPointExternalReference for some pickup points. Please contact Pargo for this functionality.
It is also possible to send no pickuppoint at all. In that case Pargo will assign a pickuppoint for you. To do this, we require you to send atleast the consignee.suburb, consignee.postalCode and consignee.city values. Optional you can send consignee.address1, consignee.address2, consignee.province and consignee.country.
Pargo can store multiple warehouse locations for your account. One of these locations is defined as the default/fallback location. Every location has a reference. You can specify what warehouse location has to be used for that order using the warehouseAddressCode parameter. For the return address you can use the parameter returnAddressCode. These 2 parameters are optional. When not provided the system will use the default/fallback location.
It is possible to specify which courier should be used for a specific order. You can specify this using the courierCode parameter. In consultation with Pargo we can allow your account to send specific courier codes. If left empty, the system will use the default courier.
Cash on Delivery (Only for Egypt) paymentOnCollectionAmount
You can override the default company name, support phone number, and support email address presented to the customer. To apply custom values, specify them in the communications property.
IMPORTANT: The values provided will be used on the Track & Trace page and in all customer notifications, including email, SMS, and WhatsApp messages. Note: this feature isn't enabled by default, so please contact Pargo if this feature is needed.
If you have a lot of warehouse addresses that cannot be communicated all initially you can send the entire warehouse address in the request itself. Pargo will create a warehouse entry (if it is a new one) on the fly and attach that order to it. Use the warehouseAddress and/or returnAddress properties to do so. If code is provided, the existing warehouse will be used and updated accordingly. Note: this feature isn't enabled by default, so please contact Pargo if this feature is needed.
The values for a single W2D order
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"password","value":"password"},{"key":"username","value":"email@example.com"},{"key":"tokenName","value":"The values for a single W2D order
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"password","value":"password"},{"key":"username","value":"email@example.com"},{"key":"tokenName","value":"A W2D order is an order that starts at a warehouse location and is delivered at the customers door.
\nNote:
\nWhen you want to send an order for one of your child suppliers, you can fill in the owner property. Please contact Pargo if you have child suppliers so they can set everything up. They'll also tell you what the contents of this property should be.
The trackingCode, externalReference and packageDescription properties are optional. The trackingcode must include a valid prefix as discussed with Pargo.
If no trackingCode provided, the system will generate one for you.
serviceType is optional. Possible values are ECO and NXT.
Either the consignee.email or consignee.phoneNumbers are required (you can send both).
IMPORTANT: It is best practice to provide both cubicWeight and deadWeight for each order to ensure the accurate rate calculations.
It is possible to send us multiple phone numbers for a consignee if this person should be notified on multiple phone numbers.
\nPargo can store multiple warehouse locations for your account. One of these locations is defined as the default/fallback location. Every location has a reference. You can specify what warehouse location has to be used for that order using the warehouseAddressCode parameter. For the return address you can use the parameter returnAddressCode. These 2 parameters are optional. When not provided the system will use the default/fallback location.
consignee.country has to be a valid country code using the ISO 3166-1 format with 2 letters (eg. ZA, SZ)
If you want to send multiple parcels/pieces you can put the total amount of parcels in the totalParcels (default = 1)
When you have additional details for your parcel(s), you can put them in the parcels attribute. For every parcel you can add the externalReference, cubicWeight, deadWeight, length, width and height. The order in this list is the same as the sequence for the parcels. So the first entry in parcels is the first parcel/piece in our system.
When sending us a multi parcel/piece order, the generated label pdf will contain individual labels for every parcel.
\nIt is possible to generate an OTP code for the order which is included in the relevant webhook payload. Please contact Pargo if you would like this feature enabled.
\nThe values for a single D2W order
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"password","value":"password"},{"key":"username","value":"email@example.com"},{"key":"tokenName","value":"The values for a single D2W order
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"password","value":"password"},{"key":"username","value":"email@example.com"},{"key":"tokenName","value":"A D2W order is an order that starts at the customers door and is delivered at a warehouse location.
\nNote:
\nowner property. Please contact Pargo if you have child suppliers so they can set everything up. They'll also tell you what the contents of this property should be.trackingCode, externalReference and packageDescription properties are optional. The trackingcode must include a valid prefix as discussed with Pargo.trackingCode provided, the system will generate one for you.serviceType is optional. Possible values are ECO and NXT.consignee.email or consignee.phoneNumbers are required (you can send both).warehouseAddressCode parameter. For the return address you can use the parameter returnAddressCode. These 2 parameters are optional. When not provided the system will use the default/fallback location.consignee.country has to be a valid country code using the ISO 3166-1 format with 2 letters (eg. ZA, SZ)totalParcels (default = 1)parcels attribute. For every parcel you can add the externalReference, cubicWeight, length, width and height. The order in this list is the same as the sequence for the parcels. So the first entry in parcels is the first parcel/piece in our system. The values for a single NP2P_CHILD order
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"password","value":"password"},{"key":"username","value":"email@example.com"},{"key":"tokenName","value":"The values for a single NP2P_CHILD order
\nNote:
\nowner property. Please contact Pargo if you have child suppliers so they can set everything up. They'll also tell you what the contents of this property should be.trackingCode, externalReference and packageDescription properties are optional. If provided, the trackingcode has to have a valid prefix as discussed with Pargo. If no trackingCode provided, the system will accept the order when the customer is at the pickup point and a product is scanned in.consignee.email or consignee.phoneNumbers are required (you can send both).pickupPointCode is optional. If provided the consignee will receive mail/sms messages that shows this particular pickup point.The values for a single P2W_RETURN order
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"password","value":"password"},{"key":"username","value":"email@example.com"},{"key":"tokenName","value":"The values for a single P2W_RETURN order
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"password","value":"password"},{"key":"username","value":"email@example.com"},{"key":"tokenName","value":"A P2W_RETURN is an order that starts when the customer drops the parcel at the selected pickup point and is delivered at the selected warehouse location
\nNote:
\nWhen you want to send an order for one of your child suppliers, you can fill in the owner property. Please contact Pargo if you have child suppliers so they can set everything up. They'll also tell you what the contents of this property should be.
The trackingCode, externalReference and packageDescription properties are optional. If provided, the trackingcode has to have a valid prefix as discussed with Pargo. If no trackingCode provided, the system will generate one for you.
Either the consignee.email or consignee.phoneNumbers are required (you can send both).
It is possible to send us multiple phone numbers for a consignee if this person should be notified on multiple phone numbers
\nPargo can store multiple warehouse locations for your account. One of these locations is defined as the default/fallback location. Every location has a reference. You can specify what warehouse location has to be used for that order using the warehouseAddressCode parameter. This parameter is optional. When not provided the system will use the default/fallback location.
It is possible to override/set the company name, support phone number and support email address being shown to the customer instead of the defaults. To send these values you can use the communications property. Note: this feature isn't enabled by default, so please contact Pargo if this feature is needed.
If you have a lot of warehouse addresses that cannot be communicated all initially you can send the entire warehouse address in the request itself. Pargo will create a warehouse entry (if it is a new one) on the fly and attach that order to it. Use the warehouseAddress properties to do so. If warehouse code is known, the system will attempt to match by provided code and will update the existing record with new address details before creating a new warehouse entry. Note: this feature isn't enabled by default, so please contact Pargo if this feature is needed.
The values for a single W2D order
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"password","value":"password"},{"key":"username","value":"email@example.com"},{"key":"tokenName","value":"A W2D PLUS order is an order that starts at a warehouse location and is delivered at the customers door. If the delivery cannot be delivered at the customers address (eg. customer is not at home), it will be delivered to the closest pickup point for collection.
\nNote:
\nowner property. Please contact Pargo if you have child suppliers so they can set everything up. They'll also tell you what the contents of this property should be.trackingCode, externalReference and packageDescription properties are optional. The trackingcode must include a valid prefix as discussed with Pargo.trackingCode provided, the system will generate one for you.serviceType is optional. Possible values are ECO and NXT.consignee.email or consignee.phoneNumbers are required (you can send both).warehouseAddressCode parameter. For the return address you can use the parameter returnAddressCode. These 2 parameters are optional. When not provided the system will use the default/fallback location.consignee.country has to be a valid country code using the ISO 3166-1 format with 2 letters (eg. ZA, SZ)totalParcels (default = 1)parcels attribute. For every parcel you can add the externalReference, cubicWeight, length, width and height. The order in this list is the same as the sequence for the parcels. So the first entry in parcels is the first parcel/piece in our system. The values for a single P2P order
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"password","value":"password"},{"key":"username","value":"email@example.com"},{"key":"tokenName","value":"A P2P order is an order that has 2 consignees, a sender and a receiver. The sender prepares the parcel and drops it off at the drop off point. From there the parcel will be transported to the collection point where the receiver can collect the parcel.
\nThis order module should be used in conjunction with either the Map Module, or the Pickup Points Module, in order to make the pickup-points available for selection to senders and receivers.
\nGeneral Notes:
\ntrackingCode, externalReference and packageDescription properties are optional.trackingCode is provided, the system will generate one for you.trackingcode it must include a valid prefix as discussed with Pargo.sender.email or sender.phonenumbers are required (you can send both).receiver.email or receiver.phonenumbers are required (you can send both).packageValue can be used to pass the monetary value of the parcel contents to Pargo, for use should an insurance claim arise. The value must be a number or null, eg. \"packageValue\": 500. This field is optional and can be left as null.Advanced Notes:
\nWhen you want to send an order for one of your child suppliers, you can fill in the owner property. Please contact Pargo if you have child suppliers for configurations and to ensure you have clarity on the contents required for this property.
You can send either the dropOffPickupPointCode / collectionPickupPointCode or dropOffPickupPointExternalReference / collectionPickupPointExternalReference. The PickupPointCode is the reference you'll get from the map or pickup point api endpoint. For specific vendors it's possible to set up a PickupPointExternalReference for some pickup points. Please contact Pargo for this functionality.
The values for a single P2D order
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"password","value":"password"},{"key":"username","value":"email@example.com"},{"key":"tokenName","value":"A P2D order is an order that has 2 consignees, a sender and a receiver. The sender prepares the parcel and drops it off at the drop off point. From there the parcel will be transported to the receivers home address.
\nThis order module should be used in conjunction with either the Map Module, or the Pickup Points Module, in order to make the drop-off points available for selection by the sender.
\nGeneral Notes:
\ntrackingCode, externalReference and packageDescription properties are optional.trackingCode is provided, the system will generate one for you.trackingcode it must include a valid prefix as discussed with Pargo.sender.email or sender.phonenumbers are required (you can send both).receiver.email or receiver.phonenumbers are required (you can send both).receiver.country has to be a valid country code using the ISO 3166-1 format with 2 letters (eg. ZA, SZ)packageValue can be used to pass the monetary value of the parcel contents to Pargo, for use should an insurance claim arise. The value must be a number or null, eg. \"packageValue\": 500. This field is optional and can be left as null.Advanced Notes:
\nWhen you want to send an order for one of your child suppliers, you can fill in the owner property. Please contact Pargo if you have child suppliers for configurations and to ensure you have clarity on the contents required for this property.
You can send either the dropOffPickupPointCode or dropOffPickupPointExternalReference. The dropOffPickupPointCode is the reference you'll get from the map or pickup point api endpoint. For specific vendors it's possible to set up a dropOffPickupPointExternalReference for some pickup points. Please contact Pargo for this functionality.
The difference with sending orders in a batch opposite to a single order is that the root data attribute is an array/list instead of struct. Inside this data array you list multiple order structs.
A previously stated, it is possible to send order by bulk / inside a batch. You can send multiple orders from the same type or different types in the same request. The contents of a single order block is the same as described above.
Depending on configuration, greenlighting is required before orders will be confirmed and processing will begin. Most API users do not need to perform this, but it is available on request.
\nThis functionality is currently in place for Warehouse to Pickup-Point and Warehouse to Door orders
\n","_postman_id":"1de90631-091b-444b-b24b-f524e6e296ad","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"password","value":"password"},{"key":"username","value":"email@example.com"},{"key":"tokenName","value":"Depending on configuration, greenlighting is required before orders will be confirmed and processing will begin. Most API users do not need to perform this, but it is available on request.
\nWhen this functionality is being used, orders can either be cancelled or confirmed ('greenlight')
\nThis functionality is currently in place for Warehouse to Pickup-Point and Warehouse to Door orders
\n","_postman_id":"7df3e109-ddf9-4796-b3eb-be366d0d1da1","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"password","value":"password"},{"key":"username","value":"email@example.com"},{"key":"tokenName","value":"This endpoint can be used to retrieve the order label URL if the label is generated and available for various order process types including the multi-parcel orders.
\nThe request will be successful if label has has been successfully generated and the user is the owner or initiator of the order.
\nBoth the order waybill number and external reference are accepted. If a # needs to be prepended for an external reference search, please contact Pargo.
It’s possible to send one or multiple orders in the same requests.\nWhen you’re sending multiple orders in a request a batch will be made and you’ll receive the batch reference in the meta property of the response.
\nIt is possible to send us 1 order at a time or multiple in a batch.\nThe data that has to be send for a specific order can be different depending on what type of order it is.\nBelow you'll find examples for sending a specific order and what data is required.\nAt the end we'll show you how to send a batch requests using one or multiple order types.\nEvery type is the same basic structure. It has a type parameter which indicates what order type should be used and a attributes parameter. The contents in attributes depends on the selected type.
The difference with sending courier tracking info in a batch opposite to a single order is that the root data attribute is an array/list instead of struct. Inside this data array you list multiple courier tracking info structs.
When sending courier tracking info make sure you are authorized with the courier login credentials.
\nA single block of tracking info contains a code, timestamp (valid ISO8601 format), orderReference, parcelReference (optional), externalTrackingReference (optional, for your own use), description (optional), attempts (optional, if you know how many times you've tried this action for this order), isForReturn (optional), ETA (optional, valid ISO8601 format, if you know when the delivery is expected), geolocation (optional, should be within valid range and valid lat/lng values).
When sending a POD code 50/52, you can optionally add fields signature (must be a valid Base 64 Encoded string), and receiverName. It is also possible to send us the alternativeAddress property. This property is used when you have a code 50 (POD / Delivered) on a different address than originally expected. If the package is delivered at a pickupPoint instead of a home address, the contents of this attribute should be formatted like this:
{\n \"data\": {\n \"type\": \"courierTrackingInfo\",\n \"attributes\": {\n ...\n \"alternativeAddress\": {\n \"pickupPointCode\": \"{{pup1}}\"\n }\n }\n }\n}\n\nThe code corresponds to one of our courier stages so we can map this request.
\nSelected event codes have support for supplementCode values which can provide further detail into the circumstances associated with that specific event: delivery type, delay, damage, loss or other escalation. It is an optional numeric value which is appended to the code and will trigger corresponding webhook requests. Additionally accepted values are NULL and an empy string \"\".
The difference with updateing package attributes in a batch opposite to a single request is that the root data attribute is an array/list instead of struct. Inside this data array you list multiple package attribute structs.
When updating the package attributes make sure you are authorized with the courier login credentials.
\n","_postman_id":"cee4b191-da07-48d3-9ade-dcfa97910e89","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"password","value":"password"},{"key":"username","value":"email@example.com"},{"key":"tokenName","value":"Use this endpoint if you want to request a new supplier. The request will be reviewed and approved by Pargo before the supplier is active. If you are a supplier yourself, this new supplier will be a child supplier to your account.
\nNote:
\ndefault and will be used for orders where no warehouseAddressCode is providedThis section outlines the webhooks triggered during different stages of the order process. Each webhook includes an event code, event name and description. Depending on the type of event, there might be additional orderData sent within the payload object.
This section outlines the webhooks triggered during different stages of the order process. Each webhook includes an event code, event name and description. Depending on the type of event, there might be additional orderData sent within the payload object.
This section outlines the webhooks triggered during different stages of the order process. Each webhook includes an event code, event name and description. Depending on the type of event, there might be additional orderData sent within the payload object.
This section outlines the webhooks triggered during different stages of the order process. Each webhook includes an event code, event name and description. Depending on the type of event, there might be additional orderData sent within the payload object.