QuickShipper Delivery API

QuickShipper is a comprehensive platform designed to streamline order management for businesses operating across diverse sales channels. Whether you possess your own fleet of couriers or require efficient courier management and route planning, QuickShipper offers tailored solutions. Should you lack an existing courier network, QuickShipper seamlessly connects you with a range of reputable courier companies to fulfill your delivery needs.

We're currently working on preparing the documentation, which will soon be enriched with comprehensive instructions to guide you through the process effectively.

Was this section helpful?

What made this section unhelpful for you?

Authorization

To utilize the Delivery API, start by registering within the QuickShipper system. Connect with our team to initiate the integration process tailored to your needs.

To get an authorization token, you need to send a POST request to the address{BASE_URL}/connect/token

Base Url values are:

Test

Production

SHELL

shell
Select...
curl --request POST \
--url {BASE_URL}/connect/token \
--header 'Authorization: Basic RGVsaXZlcnlBcGlDbGllbnQ6RGVsaXZlcnlBcGlTZWNyZXQ=' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data '
{
"grant_type": "password",
"scope": "{SCOPE}",
"username": "{YOUR_USERNAME}",
"password": "{YOUR_PASSWORD}"
}

Was this section helpful?

What made this section unhelpful for you?

Endpoints


All ResponseModels have the following fields:

When the operation succeeds, the response will have Success set to true. In the event of failure, Success will be set to false, accompanied by an appropriate error message.

Base Response

httpStatusCodenumber
userMessagestring
developerMessagestring
successboolean
errorsarray

Endpoints

POST
GET
GET
GET
PUT
DELETE
GET
1 2 3 4 5 6 7 { "httpStatusCode": 200, "userMessage": "Operation Completed", "developerMessage": "Operation Completed", "success": true, "errors": [] }

Webhooks

Webhooks provide timely updates on your orders. To enable this feature, register your addresses in the system. Webhooks are characterized by an active status, the maximum call attempt count, and a type that specifies the content of the received event.

Enums

Objects

Was this section helpful?

What made this section unhelpful for you?

CustomFieldModel


CustomFieldModel

idstring
namestring
valueTypestring
isOptionalboolean
descriptionstring
placeholderstring
listValuesarray

Show child attributes

typestring
Was this section helpful?

What made this section unhelpful for you?

1 2 3 4 5 6 7 8 9 10 11 12 { "id": "", "name": "string", "valueType": "string", "isOptional": true, "description": "string", "placeholder": "string", "listValues": [ "string" ], "type": "string" }