MENU navbar-image

Introduction

Welcome to the V3 Collivery.net API reference. Please refer to the documentation of our older api Learn more

This documentation aims to provide all the information you need to work with our API.

Headers

{
    "X-App-Name": "My Custom App", // Application Name
    "X-App-Version": "0.2.1", // Application Version
    "X-App-Host": ".NET Framework 4.8", // Framework/CMS name and version
    "X-App-Lang": "C#", // Language your implementation is written in
    "X-App-Url": "https://example.com", // URL your site is hosted on. *Optional
}

The following headers are required with each request, they help us to track the requests from each app in order to offer you help when you get stuck.

As a reminder you will see this tag with each example to indicate that you must include these in production. requires headers

Please make these values your own, they will be rejected if they are all the default values suggested here. You can, however, use the default headers if you are logging in as api@collivery.co.za or demo@collivery.co.za.

Base URL

https://dev.api.collivery.co.za

Authenticating requests

To authenticate requests, include a query parameter api_token in the request.

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your dashboard and clicking Generate API token.

1. Authentication

### Please note: * Requires authentication indicates that this endpoint can only be accessed with your credentials * With these routes, you must provide an `api_token` parameter with the request * You can get your api_token calling the `/login` endpoint or by selecting `Edit` on Users index

Log in

requires headers

Log in with your credentials and receive back your api token (to be used in further calls)

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/login';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'json' => [
            'email' => 'demo@collivery.co.za',
            'password' => 'demo',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/login"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};

let body = {
    "email": "demo@collivery.co.za",
    "password": "demo"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl -X POST \
"https://dev.api.collivery.co.za/v3/login
" \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"                \
                                    -d '{"email":"demo@collivery.co.za","password":"demo"}'

Example response (500):

Show headers 

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
x-robots-tag: noindex
x-ratelimit-limit: 10
x-ratelimit-remaining: 9


{
    "message": "Server Error"
}

Request   

POST v3/login

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

Body Parameters

email   string     

Your email address. Example: demo@collivery.co.za

password   string     

Your login password. Example: demo

Register

requires authentication requires headers

Create a new client account. You will need to be provided with access to this endpoint. Please contact us to enable it.

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/register';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
        'json' => [
            'register_radio' => 'business',
            'name' => 'John Doe',
            'terms' => true,
            'email_address' => 'foobar@example.com',
            'cellphone' => 123456789,
            'suburb_id' => 1936,
            'street_name' => 'Webber Street',
            'street_number' => '58c',
            'building' => 'MDS House',
            'is_vat_registered' => 'no',
            'vendor_type' => [
                true,
            ],
            'vendor_no' => 'fstxgjeny',
            'affiliate_client_id' => 8,
            'town_id' => 147,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/register"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};

let body = {
    "register_radio": "business",
    "name": "John Doe",
    "terms": true,
    "email_address": "foobar@example.com",
    "cellphone": 123456789,
    "suburb_id": 1936,
    "street_name": "Webber Street",
    "street_number": "58c",
    "building": "MDS House",
    "is_vat_registered": "no",
    "vendor_type": [
        true
    ],
    "vendor_no": "fstxgjeny",
    "affiliate_client_id": 8,
    "town_id": 147
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl -X POST \
"https://dev.api.collivery.co.za/v3/register
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"                \
                                    -d '{"register_radio":"business","name":"John Doe","terms":true,"email_address":"foobar@example.com","cellphone":123456789,"suburb_id":1936,"street_name":"Webber Street","street_number":"58c","building":"MDS House","is_vat_registered":"no","vendor_type":[true],"vendor_no":"fstxgjeny","affiliate_client_id":8,"town_id":147}'

Example response (200):


{
    "data": {
        "id": 54596,
        "full_name": "John Doe",
        "email_address": "foobar@example.com",
        "landline_number": "123456789",
        "mobile_number": "123456789",
        "api_token": "q4HuuQP67J6NabYoqov4",
        "client": {
            "id": 40203,
            "name": "John Doe",
            "landline_number": "123456789",
            "mobile_number": "123456789",
            "account_code": null,
            "account_type": "pre-paid",
            "primary_address": {
                "id": 2433244,
                "custom_id": null,
                "town": "Johannesburg",
                "town_id": 147,
                "suburb": "Selby",
                "suburb_id": 1936,
                "text": "John Doe, MDS House, 58c Webber Street, Selby, Johannesburg",
                "short_text": "John Doe, Selby, Johannesburg"
            }
        }
    }
}

Example response (412):


{
    "error": [
        [
            "That email address is already registered. Please rather login through http://api.collivery.co.za/v3/login"
        ]
    ]
}

Request   

POST v3/register

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

Body Parameters

register_radio   string  optional    

Example: business

Must be one of:
  • private
  • business
name   string     

Your full name. Minimum 5 characters. Maximum 50 characters. Example: John Doe

terms   boolean     

Whether you accept all terms an conditions. Should be fetched from our /terms endpoint. Example: true

email_address   string     

A valid email address that is not yet registered. Example: foobar@example.com

telephone   integer  optional    

Your personal or business land-line number. One of telephone or cellphone must be provided.

cellphone   integer  optional    

Your personal or business mobile number. One of telephone or cellphone must be provided. Example: 123456789

suburb_id   integer     

A valid id of a suburb in the town provided, can be fetched from out /suburbs endpoint. Example: 1936

street_name   string     

The name of the street your primary address is on. Minimum 5 characters, maximum 50 characters. Example: Webber Street

street_number   string  optional    

The street number of your primary address. Maximum 5 characters. Example: 58c

building   string  optional    

The building name of your primary address. Maximum 50 characters. Example: MDS House

company_name   string  optional    

The name of your business. Indicates that this is a business registration. Minimum 5 characters. Maximum 70 characters.

id_number   integer  optional    

ID number of the person responsible for the payment of the account. Required if company_name is filled. Maximum 20 characters. If you are registering as a business and this is an invalid RSA id number your account will automatically be placed on hold, and we will contact you to get the correct details.

is_vat_registered   string  optional    

Example: no

Must be one of:
  • yes
  • no
vat_number   string  optional    

Your company VAT number. Required if company_name is filled. Maximum 20 characters.

registration   string  optional    

Your company registration number. Required if company_name is filled. Maximum 20 characters.

other_input   string  optional    

This field is required when find_how is 10.

vendor_type   boolean[]     

Must be accepted.

vendor_no   string  optional    

This field is required when vendor_type.TAK_SEL is present. Must not be greater than 50 characters. Example: fstxgjeny

affiliate_client_id   integer  optional    

Example: 8

town_id   integer     

A valid town id, can be fetched from out /towns endpoint. Example: 147

2. Addresses

Manage Addresses

Index

requires authentication requires headers

List your addresses

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/address';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
            'search' => 'Johannes',
            'page' => '1',
            'per_page' => '3',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/address"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
    "search": "Johannes",
    "page": "1",
    "per_page": "3",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
curl -X GET \
-G "https://dev.api.collivery.co.za/v3/address
    ?api_token=OpSjx5TlXGCGkzGAvUOm&search=Johannes&page=1&per_page=3
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"

Example response (500):

Show headers 

cache-control: no-cache, private
content-type: application/json


{
    "message": "Server Error"
}

Request   

GET v3/address

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

include   string  optional    

A comma separated list of relationships to return. Available entries: contacts, suburb, town, active_waybills.

custom_id   string  optional    

Search by this custom address id only.

search   string  optional    

Search in street, building, company_name, suburb or town for a match. Example: Johannes

town_id   string  optional    

Limit to results with this town id.

suburb_id   string  optional    

Limit to results with this suburb id.

page   string  optional    

Page number to return. Example: 1

per_page   string  optional    

The limit per page. If this option is provided, links and meta will exist in the response with further information about the full list.0 is the same as not limiting. Default is 100 Example: 3. Example: 3

Store

requires authentication requires headers

Save a new Address.

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/address';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
        'json' => [
            'town_id' => 147,
            'town_name' => 'Johannesburg',
            'province' => 'Gauteng',
            'suburb_id' => 1936,
            'suburb_name' => 'Selby',
            'company_name' => 'MDS Collivery',
            'building' => 'MDS House',
            'street_number' => '58c',
            'street' => 'Webber Street',
            'location_type' => 1,
            'location_type_name' => 'Business Premises',
            'contact' => [
                'id' => 2519728,
                'full_name' => 'John Doe',
                'cellphone' => '0723456789',
                'email_address' => 'demo@collivery.co.za',
            ],
            'country' => 'ZAF',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/address"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};

let body = {
    "town_id": 147,
    "town_name": "Johannesburg",
    "province": "Gauteng",
    "suburb_id": 1936,
    "suburb_name": "Selby",
    "company_name": "MDS Collivery",
    "building": "MDS House",
    "street_number": "58c",
    "street": "Webber Street",
    "location_type": 1,
    "location_type_name": "Business Premises",
    "contact": {
        "id": 2519728,
        "full_name": "John Doe",
        "cellphone": "0723456789",
        "email_address": "demo@collivery.co.za"
    },
    "country": "ZAF"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl -X POST \
"https://dev.api.collivery.co.za/v3/address
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"                \
                                    -d '{"town_id":147,"town_name":"Johannesburg","province":"Gauteng","suburb_id":1936,"suburb_name":"Selby","company_name":"MDS Collivery","building":"MDS House","street_number":"58c","street":"Webber Street","location_type":1,"location_type_name":"Business Premises","contact":{"id":2519728,"full_name":"John Doe","cellphone":"0723456789","email_address":"demo@collivery.co.za"},"country":"ZAF"}'

Example response (500):

Show headers 

cache-control: no-cache, private
content-type: application/json


{
    "message": "Server Error"
}

Request   

POST v3/address

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

Body Parameters

custom_id   string  optional    

The custom id you would like to assign to this address. Must be unique. Max 30 characters.

town_id   integer     

without town_name and suburb_id. Required with 'country' only if 'country' is sent or not ZAF . Can be obtained from /towns/ endpoint. Example: 147

town_name   string     

without town_id and suburb_id. Can be obtained from /towns/ endpoint. Example: Johannesburg

province   string.  optional    

The name of the province, useful when providing town_name to filter the towns. Example: Gauteng

suburb_id   integer     

without suburb_name. Can be obtained from /suburbs/ endpoint. Ignored when country sent is not ZAF. Example: 1936

suburb_name   string  optional    

Required when country is not ZAF or without suburb_id. South African suburbs can be obtained from /suburbs/ endpoint. Example: Selby

company_name   string  optional    

The name of the company of the address. Max 50 characters. Example: MDS Collivery

building   string  optional    

The building of the address. Max 50 characters. Example: MDS House

street_number   string  optional    

The number on the street of the address. Max 5 characters. Example: 58c

street   string     

The name of the street that the address is on. Max 50 characters. Example: Webber Street

location_type   integer     

without location_type_name. The id of the location type for the address. Can be obtained from /location_types/ endpoint. Example: 1

location_type_name   string     

without location_type. The name of the location type for the address. Can be obtained from /location_types/ endpoint. Example: Business Premises

contact   object  optional    

optional If you are creating/updating a contact with the address, please ensure that it is a valid JSON object.
id   integer  optional    

optional Only required for update requests. The id of the contact that you wish to update. Example: 2519728

full_name   string  optional    

optional If you are creating a contact with the address, their full name. Required if any of cellphone, work_phone or email_address is present in the contact object. Min 2 characters, max 50 characters. Example: John Doe

cellphone   string  optional    

optional If you are creating a contact with the address, their cellphone. Required if any of full_name or email_address is present in the contact object - and work_phone is not provided. Min 10 characters, max 20 characters. Example: 0723456789

work_phone   string  optional    

optional If you are creating a contact with the address, their cellphone. Required if any of full_name or email_address is present in the contact object - and cellphone is not provided. Min 10 characters, max 20 characters.

email_address   string  optional    

optional If you are creating a contact with the address, their full name. Useful for tracking updates to be sent to. Max 50 characters. Example: demo@collivery.co.za

country   string.  optional    

The three letter abbreviation (ISO 3166) for the country. Defaults to ZAF. Can be obtained from /country/ endpoint. Example: ZAF

Show

requires authentication requires headers

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/address/8';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/address/8"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
curl -X GET \
-G "https://dev.api.collivery.co.za/v3/address/8
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"

Example response (500):

Show headers 

cache-control: no-cache, private
content-type: application/json


{
    "message": "Server Error"
}

Request   

GET v3/address/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

URL Parameters

id   integer     

The ID of the address. Example: 8

address   number     

The address id. Example: 952

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

Update

requires authentication requires headers

Modify the details of a pre-existing address.

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/address/8';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
        'json' => [
            'town_id' => 147,
            'town_name' => 'Johannesburg',
            'province' => 'Gauteng',
            'suburb_id' => 1936,
            'suburb_name' => 'Selby',
            'company_name' => 'MDS Collivery',
            'building' => 'MDS House',
            'street_number' => '58c',
            'street' => 'Webber Street',
            'location_type' => 1,
            'location_type_name' => 'Business Premises',
            'contact' => [
                'id' => 2519728,
                'full_name' => 'John Doe',
                'cellphone' => '0723456789',
                'email_address' => 'demo@collivery.co.za',
            ],
            'country' => 'ZAF',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/address/8"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};

let body = {
    "town_id": 147,
    "town_name": "Johannesburg",
    "province": "Gauteng",
    "suburb_id": 1936,
    "suburb_name": "Selby",
    "company_name": "MDS Collivery",
    "building": "MDS House",
    "street_number": "58c",
    "street": "Webber Street",
    "location_type": 1,
    "location_type_name": "Business Premises",
    "contact": {
        "id": 2519728,
        "full_name": "John Doe",
        "cellphone": "0723456789",
        "email_address": "demo@collivery.co.za"
    },
    "country": "ZAF"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl -X PUT \
"https://dev.api.collivery.co.za/v3/address/8
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"                \
                                    -d '{"town_id":147,"town_name":"Johannesburg","province":"Gauteng","suburb_id":1936,"suburb_name":"Selby","company_name":"MDS Collivery","building":"MDS House","street_number":"58c","street":"Webber Street","location_type":1,"location_type_name":"Business Premises","contact":{"id":2519728,"full_name":"John Doe","cellphone":"0723456789","email_address":"demo@collivery.co.za"},"country":"ZAF"}'

Example response (200):


{
    "data": {
        "id": 2415979,
        "custom_id": "",
        "town": "Johannesburg",
        "town_id": 147,
        "suburb": "Selby",
        "suburb_id": 1936,
        "text": "MDS Collivery, MDS House, 58c Webber Street, Selby, Johannesburg",
        "short_text": "MDS Collivery, Selby, Johannesburg",
        "geocode_data": {
            "accuracy": 5,
            "accuracy_type": "Suburb",
            "last_geocoded_at": "1900-01-01",
            "latitude": 0,
            "longitude": 0
        }
    }
}

Example response (400):


{
    "error": {
        "http_code_text": "Bad Request",
        "http_code": 400,
        "message": "There are waybills linked to that address, rather create a new one."
    }
}

Request   

PUT v3/address/{id}

PATCH v3/address/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

URL Parameters

id   integer     

The ID of the address. Example: 8

address   number     

The address id. Example: 952

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

Body Parameters

custom_id   string  optional    

The custom id you would like to assign to this address. Must be unique. Max 30 characters.

town_id   integer     

without town_name and suburb_id. Required with 'country' only if 'country' is sent or not ZAF . Can be obtained from /towns/ endpoint. Example: 147

town_name   string     

without town_id and suburb_id. Can be obtained from /towns/ endpoint. Example: Johannesburg

province   string.  optional    

The name of the province, useful when providing town_name to filter the towns. Example: Gauteng

suburb_id   integer     

without suburb_name. Can be obtained from /suburbs/ endpoint. Ignored when country sent is not ZAF. Example: 1936

suburb_name   string  optional    

Required when country is not ZAF or without suburb_id. South African suburbs can be obtained from /suburbs/ endpoint. Example: Selby

company_name   string  optional    

The name of the company of the address. Max 50 characters. Example: MDS Collivery

building   string  optional    

The building of the address. Max 50 characters. Example: MDS House

street_number   string  optional    

The number on the street of the address. Max 5 characters. Example: 58c

street   string     

The name of the street that the address is on. Max 50 characters. Example: Webber Street

location_type   integer     

without location_type_name. The id of the location type for the address. Can be obtained from /location_types/ endpoint. Example: 1

location_type_name   string     

without location_type. The name of the location type for the address. Can be obtained from /location_types/ endpoint. Example: Business Premises

contact   object  optional    

optional If you are creating/updating a contact with the address, please ensure that it is a valid JSON object.
id   integer  optional    

optional Only required for update requests. The id of the contact that you wish to update. Example: 2519728

full_name   string  optional    

optional If you are creating a contact with the address, their full name. Required if any of cellphone, work_phone or email_address is present in the contact object. Min 2 characters, max 50 characters. Example: John Doe

cellphone   string  optional    

optional If you are creating a contact with the address, their cellphone. Required if any of full_name or email_address is present in the contact object - and work_phone is not provided. Min 10 characters, max 20 characters. Example: 0723456789

work_phone   string  optional    

optional If you are creating a contact with the address, their cellphone. Required if any of full_name or email_address is present in the contact object - and cellphone is not provided. Min 10 characters, max 20 characters.

email_address   string  optional    

optional If you are creating a contact with the address, their full name. Useful for tracking updates to be sent to. Max 50 characters. Example: demo@collivery.co.za

country   string.  optional    

The three letter abbreviation (ISO 3166) for the country. Defaults to ZAF. Can be obtained from /country/ endpoint. Example: ZAF

Delete

requires authentication requires headers

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/address/952';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/address/952"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};


fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
curl -X DELETE \
"https://dev.api.collivery.co.za/v3/address/952
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"

Example response (200):


{
    "data": {
        "message": "Address # 952 has been deleted"
    }
}

Example response (400):


{
    "error": {
        "http_code_text": "Bad Request",
        "http_code": 400,
        "message": "Address # 952 is already used for waybills, you cannot delete it."
    }
}

Request   

DELETE v3/address/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

URL Parameters

id   integer  optional    

required. Example: 952

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

Show Default Address

requires authentication requires headers

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/default_address';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/default_address"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
curl -X GET \
-G "https://dev.api.collivery.co.za/v3/default_address
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"

Example response (200):


{
    "data": {
        "id": 2415979,
        "custom_id": "",
        "town": "Johannesburg",
        "town_id": 147,
        "suburb": "Selby",
        "suburb_id": 1936,
        "text": "MDS Collivery, MDS House, 58c Webber Street, Selby, Johannesburg",
        "short_text": "MDS Collivery, Selby, Johannesburg"
    }
}

Example response (400):


{
    "error": {
        "http_code_text": "Bad Request",
        "http_code": 400,
        "message": "Default address not found."
    }
}

Request   

GET v3/default_address

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

3. Contacts

Manage Address Contacts

Index

requires authentication requires headers

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/contacts';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
            'search' => 'Collivery',
            'page' => '1',
            'per_page' => '3',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/contacts"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
    "search": "Collivery",
    "page": "1",
    "per_page": "3",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
curl -X GET \
-G "https://dev.api.collivery.co.za/v3/contacts
    ?api_token=OpSjx5TlXGCGkzGAvUOm&search=Collivery&page=1&per_page=3
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"

Example response (200):


{
    "data": [
        {
            "id": 729097,
            "email": "support@collivery.co.za",
            "full_name": "Collivery Support",
            "cell_no": null,
            "cellphone": null,
            "work_no": "0123456789",
            "work_phone": "0123456789"
        },
        {
            "id": 729098,
            "email": "integration@collivery.co.za",
            "full_name": "Collivery Integration",
            "cell_no": null,
            "cellphone": null,
            "work_no": "0123456789",
            "work_phone": "0123456789"
        },
        {
            "id": 729099,
            "email": "api@collivery.co.za",
            "full_name": "Collivery Api",
            "cell_no": null,
            "cellphone": null,
            "work_no": "0123456789",
            "work_phone": "0123456789"
        }
    ],
    "links": {
        "first": "https://api.collivery.co.za/v3/contacts?page=1",
        "last": "https://api.collivery.co.za/v3/contacts?page=1532",
        "next": "https://api.collivery.co.za/v3/contacts?page=1501",
        "prev": "https://api.collivery.co.za/v3/contacts?page=1499"
    },
    "meta": {
        "current_page": 1500,
        "from": 4498,
        "last_page": 1532,
        "path": "https://api.collivery.co.za/v3/contacts",
        "per_page": "3",
        "to": 4500,
        "total": 4596
    }
}

Request   

GET v3/contacts

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

address_id   string  optional    

Limit to contacts for this specific address.

search   string  optional    

Search in name for a match. Example: Collivery

page   string  optional    

Page number to return. Example: 1

per_page   string  optional    

The limit per page. If this option is provided, links and meta will exist in the response with further information about the full list.0 is the same as not limiting. Default is 100. Example: 3

Store

requires authentication requires headers

Save a new Contact.

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/contacts';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
        'json' => [
            'address_id' => 952,
            'email' => 'foo@example.com',
            'full_name' => 'John Doe',
            'cell_no' => '0721234567',
            'cellphone' => '0721234567',
            'work_no' => null,
            'work_phone' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/contacts"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};

let body = {
    "address_id": 952,
    "email": "foo@example.com",
    "full_name": "John Doe",
    "cell_no": "0721234567",
    "cellphone": "0721234567",
    "work_no": null,
    "work_phone": null
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl -X POST \
"https://dev.api.collivery.co.za/v3/contacts
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"                \
                                    -d '{"address_id":952,"email":"foo@example.com","full_name":"John Doe","cell_no":"0721234567","cellphone":"0721234567","work_no":null,"work_phone":null}'

Example response (500):

Show headers 

cache-control: no-cache, private
content-type: application/json


{
    "message": "Server Error"
}

Request   

POST v3/contacts

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

Body Parameters

address_id   integer     

The id of the address you wish to add this contact to. Can be fetched through the /addresses endpoint. Example: 952

email   string  optional    

optional Valid email address. Minimum 5 characters. Example: foo@example.com

full_name   string  optional    

required. The contact's full name. Minimum 3 characters. Example: John Doe

cell_no   string     

without work_phone. Minimum 10 characters. For legacy reasons, cell_no is also supported. Example: 0721234567

cellphone   string     

without work_phone. Minimum 10 characters. For legacy reasons, cell_no is also supported. Example: 0721234567

work_no   string     

without cellphone. Minimum 10 characters. For legacy reasons, work_no is also supported.

work_phone   string     

without cellphone. Minimum 10 characters. For legacy reasons, work_no is also supported.

Show

requires authentication requires headers

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/contacts/593';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/contacts/593"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
curl -X GET \
-G "https://dev.api.collivery.co.za/v3/contacts/593
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"

Example response (500):

Show headers 

cache-control: no-cache, private
content-type: application/json


{
    "message": "Server Error"
}

Request   

GET v3/contacts/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

URL Parameters

id   integer  optional    

required. Example: 593

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

Update

requires authentication requires headers

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/contacts/593';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
        'json' => [
            'address_id' => 952,
            'email' => 'foo@example.com',
            'full_name' => 'John Doe',
            'cell_no' => '0721234567',
            'cellphone' => '0721234567',
            'work_no' => null,
            'work_phone' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/contacts/593"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};

let body = {
    "address_id": 952,
    "email": "foo@example.com",
    "full_name": "John Doe",
    "cell_no": "0721234567",
    "cellphone": "0721234567",
    "work_no": null,
    "work_phone": null
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl -X PUT \
"https://dev.api.collivery.co.za/v3/contacts/593
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"                \
                                    -d '{"address_id":952,"email":"foo@example.com","full_name":"John Doe","cell_no":"0721234567","cellphone":"0721234567","work_no":null,"work_phone":null}'

Example response (500):

Show headers 

cache-control: no-cache, private
content-type: application/json


{
    "message": "Server Error"
}

Request   

PUT v3/contacts/{id}

PATCH v3/contacts/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

URL Parameters

id   string     

The id Example: 593

contact   number  optional    

id required The id Example: 593

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

Body Parameters

address_id   integer     

The id of the address you wish to add this contact to. Can be fetched through the /addresses endpoint. Example: 952

email   string  optional    

optional Valid email address. Minimum 5 characters. Example: foo@example.com

full_name   string  optional    

required. The contact's full name. Minimum 3 characters. Example: John Doe

cell_no   string     

without work_phone. Minimum 10 characters. For legacy reasons, cell_no is also supported. Example: 0721234567

cellphone   string     

without work_phone. Minimum 10 characters. For legacy reasons, cell_no is also supported. Example: 0721234567

work_no   string     

without cellphone. Minimum 10 characters. For legacy reasons, work_no is also supported.

work_phone   string     

without cellphone. Minimum 10 characters. For legacy reasons, work_no is also supported.

Delete

requires authentication requires headers

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/contacts/ex';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/contacts/ex"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};


fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
curl -X DELETE \
"https://dev.api.collivery.co.za/v3/contacts/ex
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"

Example response (200):


{
    "data": {
        "message": "Contact # 593 has been deleted."
    }
}

Example response (400):


{
    "error": {
        "http_code_text": "Bad Request",
        "http_code": 400,
        "message": "Contact # 593 is already used for waybills, you cannot delete it."
    }
}

Request   

DELETE v3/contacts/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

URL Parameters

id   string     

The ID of the contact. Example: ex

contact   string  optional    

Example: 593

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

4. Get Quote

Request a quote

requires authentication requires headers

Get a waybill quote based on the parameters provided.

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/quote';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
        'json' => [
            'services' => [
                2,
            ],
            'parcels' => [
                [
                    'length' => 21.5,
                    'width' => 10.0,
                    'height' => 5.5,
                    'weight' => 5.2,
                    'quantity' => 2,
                    'product_id' => 2542,
                ],
            ],
            'collection_town' => 147,
            'delivery_town' => 200,
            'collection_location_type' => 1,
            'delivery_location_type' => 5,
            'collection_time' => '2025-01-24 12:00',
            'delivery_time' => '2025-01-25 16:00:00',
            'strict_delivery_time' => false,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/quote"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};

let body = {
    "services": [
        2
    ],
    "parcels": [
        {
            "length": 21.5,
            "width": 10,
            "height": 5.5,
            "weight": 5.2,
            "quantity": 2,
            "product_id": 2542
        }
    ],
    "collection_town": 147,
    "delivery_town": 200,
    "collection_location_type": 1,
    "delivery_location_type": 5,
    "collection_time": "2025-01-24 12:00",
    "delivery_time": "2025-01-25 16:00:00",
    "strict_delivery_time": false
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl -X POST \
"https://dev.api.collivery.co.za/v3/quote
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"                \
                                    -d '{"services":[2],"parcels":[{"length":21.5,"width":10,"height":5.5,"weight":5.2,"quantity":2,"product_id":2542}],"collection_town":147,"delivery_town":200,"collection_location_type":1,"delivery_location_type":5,"collection_time":"2025-01-24 12:00","delivery_time":"2025-01-25 16:00:00","strict_delivery_time":false}'

Example response (500):

Show headers 

cache-control: no-cache, private
content-type: application/json


{
    "message": "Server Error"
}

Request   

POST v3/quote

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

Body Parameters

services   object[]  optional    

number A list of the services you would like a quote on. Any or none of 1,2,3,5. Defaults to all services.

parcels   object[]  optional    

Very important for determining accurate quote. Will default to an "average" parcel if not supplied. Dimensions are limited to 1000, weight is limited to 400
length   number  optional    

The length of the parcel. Values in centimetres. Can be supplied as floats or integers. Example: 21.5

width   number  optional    

The width of the parcel. Values in centimetres. Can be supplied as floats or integers. Example: 10

height   number  optional    

The height of the parcel. Values in centimetres. Can be supplied as floats or integers. Example: 5.5

weight   number  optional    

The weight of the parcel. Values in kilograms. Can be supplied as floats or integers. Example: 5.2

quantity   integer  optional    

The amount of parcels of this type. Example: 2

product_id   integer  optional    

The id of the predefined parcel. Length, width, height and weight will be ignored if value is set. Can be obtained from /predefined_parcels/ endpoint. Example: 2542

collection_address   integer/object  optional    

optional Required if collection_town is not supplied. Can be the id of the address or a json object if the address is not yet stored. See below for object structure
custom_id   string  optional    

The custom id you would like to assign to this address. Must be unique. Max 20 characters.

country   string.  optional    

The three letter abbreviation (ISO 3166) for the country. Only ZAF supported currently. Can be obtained from /country/ endpoint. Example: ZAF

town_id   integer  optional    

Required without town_name and suburb_id. Can be obtained from /towns/ endpoint.

town_name   string  optional    

Required without town_id and suburb_id. Can be obtained from /towns/ endpoint.

suburb_id   integer  optional    

Required without suburb_name. Can be obtained from /suburbs/ endpoint.

suburb_name   string  optional    

Required when country is not ZAF or without suburb_id. South African suburbs can be obtained from /suburbs/ endpoint. No-Example Example: ex

company_name   string  optional    

The name of the company of the address. Max 50 characters.

building   string  optional    

The building of the address. Max 50 characters.

street_number   string  optional    

The number on the street of the address. Max 5 characters.

street   string  optional    

optional Required if the collection_address is filled. The name of the street that the address is on. Max 50 characters.

location_type   integer  optional    

Required without location_type_name. The id of the location type for the address. Can be obtained from /location_types/ endpoint.

location_type_name   string  optional    

Required without location_type. The name of the location type for the address. Can be obtained from /location_types/ endpoint.

delivery_address   integer/object  optional    

optional Required if delivery_town is not supplied. Can be the id of the address or a json object if the address is not yet stored. See below for object structure
custom_id   string  optional    

The custom id you would like to assign to this address. Must be unique. Max 20 characters.

country   string.  optional    

The three letter abbreviation (ISO 3166) for the country. Defaults to ZAF. Can be obtained from /country/ endpoint. Example: ZAF

town_id   integer  optional    

Required without town_nameand suburb_id. Can be obtained from /towns/ endpoint.

town_name   string  optional    

Required without town_idand suburb_id. Can be obtained from /towns/ endpoint.

suburb_id   integer  optional    

Required without suburb_name. Can be obtained from /suburbs/ endpoint. Ignored when country sent is not ZAF.

suburb_name   string  optional    

Required when country is not ZAF or without suburb_id. South African suburbs can be obtained from /suburbs/ endpoint. No-Example Example: ex

company_name   string  optional    

The name of the company of the address. Max 50 characters.

building   string  optional    

The building of the address. Max 50 characters.

street_number   string  optional    

The number on the street of the address. Max 5 characters.

street   string  optional    

optional Required if the delivery_address is filled. The name of the street that the address is on. Max 50 characters.

location_type   integer  optional    

Required without location_type_name. The id of the location type for the address. Can be obtained from /location_types/ endpoint.

location_type_name   string  optional    

Required without location_type. The name of the location type for the address. Can be obtained from /location_types/ endpoint.

collection_town   integer  optional    

optional Required if collection_address is not supplied. Example: 147

delivery_town   integer  optional    

optional Required if delivery_address is not supplied. Example: 200

collection_location_type   integer  optional    

optional Must be a valid location type. Values can be gotten from our /location_type endpoint. Example: 1

delivery_location_type   integer  optional    

optional Must be a valid location type. Values can be gotten from our /location_type endpoint. Example: 5

collection_time   string  optional    

optional Any future date/time representation that can be parsed by PHP strtotime(). Interpreted as GMT+2. If left empty no time surcharges will be encountered. Must be after current time. Example: 2025-01-24 12:00

delivery_time   string  optional    

Any future date/time representation that can be parsed by PHP strtotime(). Interpreted as GMT+2. If left empty no time surcharges will be encountered. Must be after collection_time. Example: 2025-01-25 16:00:00

exclude_weekend   boolean  optional    

optional Whether to allow for weekend collection or delivery. Surcharges will be applied. Defaults to true.

risk_cover   boolean  optional    

optional Whether to enable risk cover over and above the default cover. See terms and conditions. Surcharges will be applied. Defaults to false.

rica   boolean  optional    

optional Whether this delivery requires RICA information and documentation to be supplied. Surcharges will be applied. Defaults to false.

consignee   boolean  optional    

optional Whether this delivery can only be received by the person it is addressed to, with identity document required. Surcharges will be applied. Defaults to false.

sms_tracking   boolean  optional    

optional Whether to send SMS updates to you, the collection and delivery contacts. Surcharges will be applied. Defaults to false.

hide_collection_address   boolean  optional    

optional Whether to reprint the waybill when received in order to hide collection details from delivery recipient. Surcharges will be applied. Defaults to false.

delivery_pin   boolean  optional    

optional Whether to enable delivery pin. Pin is emailed/SMS'd to the delivery contact and is verified upon delivery. Surcharges will be applied. Defaults to false.

strict_delivery_time   boolean  optional    

Example: false

document_express   boolean  optional    

optional Whether to set the waybill to use Document Express. This is an over-night service for documents only. Service sent will be ignored and parcels if exist must validate to be below 2Kg. Defaults to false.

5. Waybills

Index

requires authentication requires headers

List your waybills

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/waybill';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
        'json' => [
            'custom_id' => 'CustomID_786',
            'per_page' => '15',
            'statuses' => '3',
            'show' => 'active',
            'include' => 'client,collection_address',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/waybill"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};

let body = {
    "custom_id": "CustomID_786",
    "per_page": "15",
    "statuses": "3",
    "show": "active",
    "include": "client,collection_address"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl -X GET \
-G "https://dev.api.collivery.co.za/v3/waybill
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"                \
                                    -d '{"custom_id":"CustomID_786","per_page":"15","statuses":"3","show":"active","include":"client,collection_address"}'

Example response (500):

Show headers 

cache-control: no-cache, private
content-type: application/json


{
    "message": "Server Error"
}

Request   

GET v3/waybill

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

Body Parameters

custom_id   string  optional    

Custom Waybill ID. Example: CustomID_786

per_page   The  optional    

limit per page. Max is 10000. If this option is provided, 'links' and meta will exist in the response with further information about the full list of waybills. 0 is the same as not limiting. Default is 100. Example: 15

statuses   optional  optional    

A comma-separated list of statuses to limit the results to. Defaults to all active statuses. Example: 3

show   optional  optional    

The value represent group of statuses. Acceptable values include: 'active', 'in-active', 'cancelled', 'all', 'pre-collected', 'pre-delivered', 'pre-received', or 'failed'. If no value is provided, only items with 'active' status will be returned by default. Example: active

start_date   optional  optional    

Any valid time representation that can be parsed by PHP strtotime(). Refers to the date the waybill was created. Defaults to 1 week ago.

end_date   Any  optional    

valid time representation that can be parsed by PHP strtotime(). Refers to the date the waybill was created. Defaults to now.

include   A  optional    

comma separated list of relationships to return. Available entries: client, collection_address, delivery_address, collection_contact, delivery_contact, proofs_of_delivery. Example: client,collection_address

Store

requires authentication requires headers

Create a new waybill

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/waybill';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
        'json' => [
            'service' => 3,
            'parcels' => [
                [
                    'length' => 21.5,
                    'width' => 10.0,
                    'height' => 5.5,
                    'weight' => 5.2,
                    'quantity' => 2,
                    'product_id' => 2542,
                    'ref' => 'sfngnhcxu',
                ],
            ],
            'collection_address' => '952',
            'collection_contact' => 593,
            'delivery_address' => '955',
            'delivery_contact' => 596,
            'exclude_weekend' => null,
            'risk_cover' => true,
            'consolidate' => null,
            'battery_type' => 'pi_965',
            'parcel_type' => 2,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/waybill"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};

let body = {
    "service": 3,
    "parcels": [
        {
            "length": 21.5,
            "width": 10,
            "height": 5.5,
            "weight": 5.2,
            "quantity": 2,
            "product_id": 2542,
            "ref": "sfngnhcxu"
        }
    ],
    "collection_address": "952",
    "collection_contact": 593,
    "delivery_address": "955",
    "delivery_contact": 596,
    "exclude_weekend": null,
    "risk_cover": true,
    "consolidate": null,
    "battery_type": "pi_965",
    "parcel_type": 2
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl -X POST \
"https://dev.api.collivery.co.za/v3/waybill
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"                \
                                    -d '{"service":3,"parcels":[{"length":21.5,"width":10,"height":5.5,"weight":5.2,"quantity":2,"product_id":2542,"ref":"sfngnhcxu"}],"collection_address":"952","collection_contact":593,"delivery_address":"955","delivery_contact":596,"exclude_weekend":null,"risk_cover":true,"consolidate":null,"battery_type":"pi_965","parcel_type":2}'

Example response (500):

Show headers 

cache-control: no-cache, private
content-type: application/json


{
    "message": "Server Error"
}

Request   

POST v3/waybill

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

Body Parameters

service   integer  optional    

A service you would like to deliver the waybill on. Defaults to 2 (Overnight Express). Example: 3

parcels   object[]  optional    

Very important for determining accurate a quote. Will default to an "average" parcel if not supplied. Dimensions are limited to 1000, weight is limited to 400
length   number  optional    

The length of the parcel. Values in centimetres. Can be supplied as floats or integers. Example: 21.5

width   number  optional    

The width of the parcel. Values in centimetres. Can be supplied as floats or integers. Example: 10

height   number  optional    

The height of the parcel. Values in centimetres. Can be supplied as floats or integers. Example: 5.5

weight   number  optional    

The weight of the parcel. Values in kilograms. Can be supplied as floats or integers. Example: 5.2

quantity   integer  optional    

The amount of parcels of this type. Example: 2

product_id   integer  optional    

The id of the predefined parcel. Length, width, height and weight will be ignored if value is set. Can be obtained from /predefined_parcels/ endpoint. Example: 2542

ref   string  optional    

Must not be greater than 25 characters. Example: sfngnhcxu

reference   string  optional    

Parcel reference. Max 25 characters.

delivery_method   integer  optional    

The vehicle that we should collect it with. Defaults to 1 (Motorbike).

collection_address   integer/object  optional    

optional Required if collection_town is not supplied. Can be the id of the address or a json object if the address is not yet stored. See below for object structure. Example: 952
custom_id   string  optional    

The custom id you would like to assign to this address. Must be unique. Max 30 characters.

country   string.  optional    

The three letter abbreviation (ISO 3166) for the country. Only ZAF supported currently. Can be obtained from /country/ endpoint.

town_id   integer     

without town_name and suburb_id. Required with 'country' only if 'country' is sent or not ZAF . Can be obtained from /towns/ endpoint.

town_name   string  optional    

Required without town_id and suburb_id. Can be obtained from /towns/ endpoint.

suburb_id   integer  optional    

Required without suburb_name. Can be obtained from /suburbs/ endpoint. Ignored when country sent is not ZAF.

suburb_name   string  optional    

Required when country is not ZAF or without suburb_id. South African suburbs can be obtained from /suburbs/ endpoint.

company_name   string  optional    

The name of the company of the address. Max 50 characters.

building   string  optional    

The building of the address. Max 50 characters.

street_number   string  optional    

The number on the street of the address. Max 5 characters.

street   string  optional    

optional Required if the collection_address is filled. The name of the street that the address is on. Max 50 characters.

location_type   integer  optional    

Required without location_type_name. The id of the location type for the address. Can be obtained from /location_types/ endpoint.

location_type_name   string  optional    

Required without location_type. The name of the location type for the address. Can be obtained from /location_types/ endpoint.

contact   object  optional    

optional If you are creating a contact with the address, please ensure that it is a valid JSON object.
full_name   string  optional    

optional If you are creating a contact with the address, their full name. Required if any of cellphone, work_phone or email_address is present in the contact object. Min 2 characters, max 50 characters.

cellphone   string  optional    

optional If you are creating a contact with the address, their cellphone. Required if any of full_name or email_address is present in the contact object - and work_phone is not provided. Min 10 characters, max 20 characters.

work_phone   string  optional    

optional If you are creating a contact with the address, their cellphone. Required if any of full_name or email_address is present in the contact object - and cellphone is not provided. Min 10 characters, max 20 characters.

email_address   string  optional    

optional If you are creating a contact with the address, their full name. Useful for tracking updates to be sent to. Max 50 characters.

collection_contact   integer  optional    

optional The id of the Collection Contact. Required only if you are not providing the contact object in collection_address. Example: 593

delivery_address   integer/object  optional    

optional Required if delivery_town is not supplied. Can be the id of the address or a json object if the address is not yet stored. See below for object structure. Example: 955
custom_id   string  optional    

The custom id you would like to assign to this address. Must be unique. Max 20 characters.

country   string.  optional    

The three letter abbreviation (ISO 3166) for the country. Defaults to ZAF. Can be obtained from /country/ endpoint.

town_id   integer     

without town_name and suburb_id. Required with 'country' only if 'country' is sent or not ZAF . Can be obtained from /towns/ endpoint.

town_name   string  optional    

Required without town_id and suburb_id. Can be obtained from /towns/ endpoint.

suburb_id   integer  optional    

Required without suburb_name. Can be obtained from /suburbs/ endpoint. Ignored when country sent is not ZAF.

suburb_name   string  optional    

Required when country is not ZAF or without suburb_id. South African suburbs can be obtained from /suburbs/ endpoint.

company_name   string  optional    

The name of the company of the address. Max 50 characters.

building   string  optional    

The building of the address. Max 50 characters.

street_number   string  optional    

The number on the street of the address. Max 5 characters.

street   string  optional    

optional Required if the delivery_address is filled. The name of the street that the address is on. Max 50 characters.

location_type   integer  optional    

Required without location_type_name. The id of the location type for the address. Can be obtained from /location_types/ endpoint.

location_type_name   string  optional    

Required without location_type. The name of the location type for the address. Can be obtained from /location_types/ endpoint.

contact   object  optional    

optional If you are creating a contact with the address, please ensure that it is a valid JSON object.
full_name   string  optional    

optional If you are creating a contact with the address, their full name. Required if any of cellphone, work_phone or email_address is present in the contact object. Min 2 characters, max 50 characters.

cellphone   string  optional    

optional If you are creating a contact with the address, their cellphone. Required if any of full_name or email_address is present in the contact object - and work_phone is not provided. Min 10 characters, max 20 characters.

work_phone   string  optional    

optional If you are creating a contact with the address, their cellphone. Required if any of full_name or email_address is present in the contact object - and cellphone is not provided. Min 10 characters, max 20 characters.

email_address   string  optional    

optional If you are creating a contact with the address, their full name. Useful for tracking updates to be sent to. Max 50 characters.

delivery_contact   integer  optional    

optional The id of the Delivery Contact. Required only if you are not providing the contact object in delivery_address. Example: 596

custom_id   string  optional    

A custom id for you to track the waybill by. Max 25 characters.

reference   string  optional    

Customer reference number. Max 100 characters.

description   string  optional    

A description of the package. Required for international waybills. Max 100 characters.

special_instructions   string  optional    

Any instructions on the handling, collection or delivery of your waybill. Max 2048 characters.

collection_time   string  optional    

optional Any future date/time representation that can be parsed by PHP strtotime(). Interpreted as GMT+2. If left empty no time surcharges will be encountered. Must be after current time.

delivery_time   string  optional    

Any future date/time representation that can be parsed by PHP strtotime(). Interpreted as GMT+2. If left empty no time surcharges will be encountered. Must be after collection_time.

exclude_weekend   boolean  optional    

optional Whether to allow for weekend collection or delivery. Surcharges will be applied. Defaults to true.

risk_cover   boolean  optional    

optional Whether to enable risk cover over and above the default cover. See terms and conditions. Surcharges will be applied. Defaults to false. Example: true

rica   boolean  optional    

optional Whether this delivery requires RICA information and documentation to be supplied. Surcharges will be applied. Defaults to false.

consignee   boolean  optional    

optional Whether this delivery can only be received by the person it is addressed to, with identity document required. Surcharges will be applied. Defaults to false.

sms_tracking   boolean  optional    

optional Whether to send SMS updates to you, the collection and delivery contacts. Surcharges will be applied. Defaults to false.

hide_collection_address   boolean  optional    

optional Whether to reprint the waybill when received in order to hide collection details from delivery recipient. Surcharges will be applied. Defaults to false.

delivery_pin   boolean  optional    

optional Whether to enable delivery pin. Pin is emailed/SMS'd to the delivery contact and is verified upon delivery. Surcharges will be applied. Defaults to false.

strict_delivery_time   boolean  optional    

Waybill should not be delivered before delivery_time. Delivery time may change if it cannot be reached, this setting does not stop that.

consolidate   boolean  optional    

optional Whether to allow for waybill to be consolidated with existing pre-collected waybill that has matching addresses, service and dates. NB: Consolidation also need to be activated on your account so please contact support@colllivery.co.za if you wish to do so. Defaults to false.

auto_accept   boolean  optional    

optional Whether waybill added should immediately be accepted. Defaults to false.

battery_type   string  optional    

optional Does the parcel contain any lithium-ion batteries. The values for this can be gotten from our /battery_types endpoint. Defaults to false. Required for international waybills. Example: pi_965

document_express   boolean  optional    

optional Whether to set the waybill to use Document Express. This is an over-night service for documents only. Service sent will be ignored and parcels if exist must validate to be below 2Kg. Defaults to false.

parcel_type   integer  optional    

Required if waybill is international export, or if Can be obtained from /parcel_types/ endpoint . Example: 2

include_pricing   boolean  optional    

optional Defaults to false. Set to true to include pricing breakdown details for the waybill.

Show

requires authentication requires headers

This will return a waybill's information, optionally along with addresses, contacts, proofs of delivery as needed

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/waybill/2904397';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
            'include' => 'client,collection_address',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/waybill/2904397"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
    "include": "client,collection_address",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
curl -X GET \
-G "https://dev.api.collivery.co.za/v3/waybill/2904397
    ?api_token=OpSjx5TlXGCGkzGAvUOm&include=client%2Ccollection_address
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"

Example response (200):


{
    "data": {
        "id": 2904397,
        "custom_id": "",
        "service_type_id": 2,
        "service_type_name": "Next Day",
        "collection_time": 1559127600,
        "customer_reference": "",
        "delivery_time": 1559224800,
        "parcel_count": 1,
        "special_instructions": "",
        "collection_address_id": 647187,
        "collection_contact_id": 671846,
        "delivery_address_id": 660058,
        "delivery_contact_id": 684889,
        "status_id": 6,
        "status_name": "Invoiced",
        "parcel_description": "",
        "weight": 0.4,
        "volumetric_weight": 0.6,
        "total_price": 100,
        "risk_cover": false,
        "parcels": [
            {
                "add_method": "client",
                "created_at": "2020-09-18 14:33:41",
                "custom_id": "",
                "height": "6.0",
                "id": 7699472,
                "waybill_id": 4001907,
                "length": "22.0",
                "parcel_number": 1,
                "quantity": 1,
                "volumetric_weight": "0.3",
                "weight": "5.2",
                "width": "10.0"
            }
        ],
        "client": {
            "id": 116,
            "name": "Test Collivery (Pty) Ltd",
            "landline_number": "011 241 4911",
            "mobile_number": null,
            "account_code": null,
            "account_type": "account"
        },
        "collection_address": {
            "id": 647187,
            "custom_id": null,
            "town_id": 147,
            "suburb_id": 1936,
            "text": "MDS Collivery, MDS House, 58c Webber St, Selby, Johannesburg",
            "short_text": "MDS Collivery, Selby, Johannesburg"
        }
    }
}

Example response (403):


{
    "error": {
        "http_code_text": "Forbidden",
        "http_code": 403,
        "message": "That waybill is not linked to your account."
    }
}

Request   

GET v3/waybill/{collivery_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

URL Parameters

collivery_id   string     

The waybill's ID. Example: 2904397

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

include   string  optional    

A comma separated list of relationships to return. Available entries: client, collection_address, delivery_address, collection_contact, delivery_contact, proofs_of_delivery. Example: client,collection_address

Update

requires authentication requires headers

Allows you to update the waybill's service type.

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/waybill/8';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
            'include' => 'client,collection_address',
        ],
        'json' => [
            'service' => 3,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/waybill/8"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
    "include": "client,collection_address",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};

let body = {
    "service": 3
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl -X PUT \
"https://dev.api.collivery.co.za/v3/waybill/8
    ?api_token=OpSjx5TlXGCGkzGAvUOm&include=client%2Ccollection_address
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"                \
                                    -d '{"service":3}'

Example response (200):


{
    "data": {
        "id": 4001907,
        "custom_id": "",
        "service_type_id": 3,
        "service_type_name": "Road Freight",
        "collection_time": 1559127600,
        "customer_reference": "",
        "delivery_time": 1559224800,
        "parcel_count": 1,
        "special_instructions": "",
        "collection_address_id": 647187,
        "collection_contact_id": 671846,
        "delivery_address_id": 660058,
        "delivery_contact_id": 684889,
        "status_id": 6,
        "status_name": "Invoiced",
        "parcel_description": "",
        "weight": 0.4,
        "volumetric_weight": 0.6,
        "total_price": 100,
        "risk_cover": false,
        "parcels": [
            {
                "add_method": "client",
                "created_at": "2020-09-18 14:33:41",
                "custom_id": "",
                "height": "6.0",
                "id": 7699472,
                "waybill_id": 4001907,
                "length": "22.0",
                "parcel_number": 1,
                "quantity": 1,
                "volumetric_weight": "0.3",
                "weight": "5.2",
                "width": "10.0"
            }
        ],
        "client": {
            "id": 116,
            "name": "Test Collivery (Pty) Ltd",
            "landline_number": "011 241 4911",
            "mobile_number": null,
            "account_code": null,
            "account_type": "account"
        },
        "collection_address": {
            "id": 647187,
            "custom_id": null,
            "town_id": 147,
            "suburb_id": 1936,
            "text": "MDS Collivery, MDS House, 58c Webber St, Selby, Johannesburg",
            "short_text": "MDS Collivery, Selby, Johannesburg"
        }
    }
}

Example response (401):


{
    "error": {
        "http_code_text": "Bad Request",
        "http_code": 401,
        "message": "Waybill # 4001907 has already started collection/delivery process, cannot update."
    }
}

Request   

PUT v3/waybill/{collivery_id}

PATCH v3/waybill/{collivery_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

URL Parameters

collivery_id   integer     

The ID of the collivery. Example: 8

waybill   string     

The waybill id. Example: 4001907

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

include   string  optional    

A comma separated list of relationships to return. Available entries: client, collection_address, delivery_address, collection_contact, delivery_contact, proofs_of_delivery. Example: client,collection_address

Body Parameters

service   integer  optional    

The new service you would like to deliver the waybill on. Example: 3

PrintLabel

requires authentication requires headers

Print waybill labels (only for customers who have a WebPrinter installed)

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/waybill/8/print_label/6';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/waybill/8/print_label/6"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
curl -X GET \
-G "https://dev.api.collivery.co.za/v3/waybill/8/print_label/6
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"

Example response (403):


{
    "error": {
        "http_code_text": "Forbidden",
        "http_code": 403,
        "message": "That waybill is not linked to your account."
    }
}

Example response (500):

Show headers 

cache-control: no-cache, private
content-type: application/json


{
    "message": "Server Error"
}

Request   

GET v3/waybill/{waybill_collivery_id}/print_label/{printer?}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

URL Parameters

waybill_collivery_id   integer     

The ID of the waybill collivery. Example: 8

printer   string  optional    

optional The printer id you want to print to. Can be obtained from /web_printer/ endpoint. Example: 6

waybill   string     

The waybill id. Example: 4001907

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

6. Status Tracking

Fetch and query status updates for your waybills

Index

requires authentication requires headers

Show a list of status tracking records

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/status_tracking';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
        'json' => [
            'statuses' => '1,3',
            'per_page' => 100,
            'start_date' => '2023-10-10',
            'end_date' => '2023-11-10',
            'page' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/status_tracking"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};

let body = {
    "statuses": "1,3",
    "per_page": 100,
    "start_date": "2023-10-10",
    "end_date": "2023-11-10",
    "page": 1
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl -X GET \
-G "https://dev.api.collivery.co.za/v3/status_tracking
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"                \
                                    -d '{"statuses":"1,3","per_page":100,"start_date":"2023-10-10","end_date":"2023-11-10","page":1}'

Example response (200):


{
    "data": [
        {
            "status_id": 1,
            "status_name": "Waiting Client Acceptance",
            "waybill_id": 4105972,
            "created_at": "2019-08-12 06:02"
        },
        {
            "status_id": 3,
            "status_name": "Quote Accepted",
            "waybill_id": 4105972,
            "created_at": "2019-08-12 06:02"
        },
        {
            "status_id": 1,
            "status_name": "Waiting Client Acceptance",
            "waybill_id": 4105999,
            "created_at": "2019-08-12 06:03"
        }
    ],
    "links": {
        "first": "http://api.collivery.co.za/v3/status_tracking?page=1",
        "last": "http://api.collivery.co.za/v3/status_tracking?page=33",
        "prev": null,
        "next": "http://api.collivery.co.za/v3/status_tracking?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 33,
        "path": "http://api.collivery.co.za/v3/status_tracking",
        "per_page": "3",
        "to": 3,
        "total": 98
    }
}

Request   

GET v3/status_tracking

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

Body Parameters

statuses   optional  optional    

A comma-separated list of statuses to limit the results to. Defaults to all statuses. Example: 1,3

per_page   integer     

The limit per page. Max is 50. If this option is provided, links and meta will exist in the response with further information about the full list.0 is the same as not limiting. Default is 100. Example: 100

start_date   optional  optional    

Any valid time representation that can be parsed by PHP strtotime(). Defaults to a week ago. Example: 2023-10-10

end_date   optional.  optional    

Example: 2023-11-10

page   integer     

page number to return. . Example: 1

Show

requires authentication requires headers

Display all status tracking for a specific waybill

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/status_tracking/8';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/status_tracking/8"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
curl -X GET \
-G "https://dev.api.collivery.co.za/v3/status_tracking/8
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"

Example response (500):

Show headers 

cache-control: no-cache, private
content-type: application/json


{
    "message": "Server Error"
}

Request   

GET v3/status_tracking/{waybill_collivery_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

URL Parameters

waybill_collivery_id   integer     

The ID of the waybill collivery. Example: 8

waybill   number     

The waybill id. Example: 4001907

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

Update

requires authentication requires headers

Accept, Cancel, or Unhold a waybill

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/status_tracking/8';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
        'json' => [
            'status_id' => 3.0,
            'cheapest' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/status_tracking/8"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};

let body = {
    "status_id": 3,
    "cheapest": true
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl -X PUT \
"https://dev.api.collivery.co.za/v3/status_tracking/8
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"                \
                                    -d '{"status_id":3,"cheapest":true}'

Example response (200):


{
    "data": {
        "message": "Waybill 4001907 updated to Quote Accepted"
    }
}

Example response (400):


{
    "error": {
        "http_code_text": "Bad Request",
        "http_code": 400,
        "message": "You have a prepaid account, you need to pay before accepting waybill # 4001907."
    },
    "meta": {
        "payment_needed": "https://collivery.net/payment_requests/store?waybills%5B0%5D=4001907"
    }
}

Example response (400):


{
    "error": {
        "http_code_text": "Bad Request",
        "http_code": 400,
        "message": "Waybill # 4001907 has already started collection/delivery process, cannot cancel."
    }
}

Example response (400):


{
    "error": {
        "http_code_text": "Bad Request",
        "http_code": 400,
        "message": "Your client is not allowed to unhold waybills."
    }
}

Request   

PUT v3/status_tracking/{waybill_collivery_id}

PATCH v3/status_tracking/{waybill_collivery_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

URL Parameters

waybill_collivery_id   integer     

The ID of the waybill collivery. Example: 8

waybill   number     

The waybill id. Example: 4001907

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

Body Parameters

status_id   number     

The id of the status you want to update to. Must be 3 (Quote Accepted), 5 (Cancelled), or 34 (Unhold). Example: 3

cheapest   boolean  optional    

Whether you would like the waybill to be accepted at the cheapest rate Example: true

7. Waybill Documents

Get your Quote or Waybill documents

Index

requires authentication requires headers

List your waybill documents

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/waybill_documents/4001907';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/waybill_documents/4001907"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
curl -X GET \
-G "https://dev.api.collivery.co.za/v3/waybill_documents/4001907
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"

Example response (500):

Show headers 

cache-control: no-cache, private
content-type: application/json


{
    "message": "Server Error"
}

Request   

GET v3/waybill_documents/{waybill}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

URL Parameters

waybill   number     

The waybill id you are requesting documents for. Example: 4001907

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

Show

requires authentication requires headers

Get the details and base64 encoded image of the waybill document

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/waybill_documents/4001907/waybill';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/waybill_documents/4001907/waybill"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
curl -X GET \
-G "https://dev.api.collivery.co.za/v3/waybill_documents/4001907/waybill
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"

Example response (200):


{
    "data": {
        "id": 4001907,
        "type": "waybill",
        "file_name": "4001907.pdf",
        "pages": 1,
        "mime": "application/pdf",
        "size": 2605,
        "created_at": "2019-05-29 18:41:11",
        "image": "JVBERi0xLjMgCjEgMCBvYmoKPDwKL1BhZ2VzIDIgMCBSCi9UeXBlIC9DYXRhbG9nCj4+CmVuZG9iagoyIDAgb2JqCjw8Ci9UeXBlIC9QYWdlcwovS2lkcyBbIDMgMCBSIF0KL0NvdW50IDEKPj4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovUmVzb3VyY2VzIDw8Ci9YT2JqZWN0IDw8IC9JbTAgOCAwIFIgPj4KL1Byb2NTZXQgNiAwIFIgPj4KL01lZGlhQm94IFswIDAgMSAxXQovQ3JvcEJveCBbMCAwIDEgMV0KL0NvbnRlbnRzIDQgMCBSCi9UaHVtYiAxMSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL0xlbmd0aCA1IDAgUgo+PgpzdHJlYW0KcQoxIDAgMCAxIDAgMCBjbQovSW0wIERvClEKCmVuZHN0cmVhbQplbmRvYmoKNSAwIG9iagoyNwplbmRvYmoKNiAwIG9iagpbIC9QREYgL1RleHQgL0ltYWdlQyBdCmVuZG9iago3IDAgb2JqCjw8Cj4+CmVuZG9iago4IDAgb2JqCjw8Ci9UeXBlIC9YT2JqZWN0Ci9TdWJ0eXBlIC9JbWFnZQovTmFtZSAvSW0wCi9GaWx0ZXIgWyAvRENURGVjb2RlIF0KL1dpZHRoIDEKL0hlaWdodCAxCi9Db2xvclNwYWNlIDEwIDAgUgovQml0c1BlckNvbXBvbmVudCA4Ci9MZW5ndGggOSAwIFIKPj4Kc3RyZWFtCv/Y/+AAEEpGSUYAAQEAAAEAAQAA/9sAQwAMCAkKCQcMCgoKDQ0MDhIeExIQEBIkGhsVHismLSwqJikpLzVEOi8yQDMpKTtRPEBGSUxNTC45VFpTSllES0xJ/8AACwgAAQABAQERAP/EABQAAQAAAAAAAAAAAAAAAAAAAAf/xAAUEAEAAAAAAAAAAAAAAAAAAAAA/9oACAEBAAA/AFV//9kKZW5kc3RyZWFtCmVuZG9iago5IDAgb2JqCjE2MAplbmRvYmoKMTAgMCBvYmoKL0RldmljZUdyYXkKZW5kb2JqCjExIDAgb2JqCjw8Ci9GaWx0ZXIgWyAvRENURGVjb2RlIF0KL1dpZHRoIDEKL0hlaWdodCAxCi9Db2xvclNwYWNlIDEwIDAgUgovQml0c1BlckNvbXBvbmVudCA4Ci9MZW5ndGggMTIgMCBSCj4+CnN0cmVhbQr/2P/gABBKRklGAAEBAAABAAEAAP/bAEMADAgJCgkHDAoKCg0NDA4SHhMSEBASJBobFR4rJi0sKiYpKS81RDovMkAzKSk7UTxARklMTUwuOVRaU0pZREtMSf/AAAsIAAEAAQEBEQD/xAAUAAEAAAAAAAAAAAAAAAAAAAAH/8QAFBABAAAAAAAAAAAAAAAAAAAAAP/aAAgBAQAAPwBVf//ZCmVuZHN0cmVhbQplbmRvYmoKMTIgMCBvYmoKMTYwCmVuZG9iagoxMyAwIG9iago8PAo+PgplbmRvYmoKMTQgMCBvYmoKMTYwCmVuZG9iagoxNSAwIG9iago8PAo+PgplbmRvYmoKMTYgMCBvYmoKMTYwCmVuZG9iagoxNyAwIG9iago8PAovVGl0bGUgPEZFRkYwMDYxMDAwMD4KL0NyZWF0aW9uRGF0ZSAoRDoyMDE5MDkxMTA2MjMxMykKL01vZERhdGUgKEQ6MjAxOTA5MTEwNjIzMTMpCi9Qcm9kdWNlciAoaHR0cHM6Ly9pbWFnZW1hZ2ljay5vcmcpCj4+CmVuZG9iagp4cmVmCjAgMTgKMDAwMDAwMDAwMCA2NTUzNSBmIAowMDAwMDAwMDEwIDAwMDAwIG4gCjAwMDAwMDAwNTkgMDAwMDAgbiAKMDAwMDAwMDExOCAwMDAwMCBuIAowMDAwMDAwMjkyIDAwMDAwIG4gCjAwMDAwMDAzNzIgMDAwMDAgbiAKMDAwMDAwMDM5MCAwMDAwMCBuIAowMDAwMDAwNDI4IDAwMDAwIG4gCjAwMDAwMDA0NDkgMDAwMDAgbiAKMDAwMDAwMDc4NSAwMDAwMCBuIAowMDAwMDAwODA0IDAwMDAwIG4gCjAwMDAwMDA4MzIgMDAwMDAgbiAKMDAwMDAwMTEyOCAwMDAwMCBuIAowMDAwMDAxMTQ4IDAwMDAwIG4gCjAwMDAwMDExNzAgMDAwMDAgbiAKMDAwMDAwMTE5MCAwMDAwMCBuIAowMDAwMDAxMjEyIDAwMDAwIG4gCjAwMDAwMDEyMzIgMDAwMDAgbiAKdHJhaWxlcgo8PAovU2l6ZSAxOAovSW5mbyAxNyAwIFIKL1Jvb3QgMSAwIFIKL0lEIFs8ZTAwZTVlYjk0NDQxODJmMzUyMzIzMzc0ZWY0ZTA4ZWJjYjc4NDcyNWZkZDRmZDYxMmQ3NzMwNTQwYjNlMGM4Yz4gPGUwMGU1ZWI5NDQ0MTgyZjM1MjMyMzM3NGVmNGUwOGViY2I3ODQ3MjVmZGQ0ZmQ2MTJkNzczMDU0MGIzZTBjOGM+XQo+PgpzdGFydHhyZWYKMTM3MwolJUVPRgo"
    }
}

Request   

GET v3/waybill_documents/{waybill}/{type}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

URL Parameters

waybill   number     

The waybill id you are requesting documents for. Example: 4001907

type   string     

The type of document, 'waybill' or 'quote' or 'label'. Example: waybill

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

8. Proofs of Delivery

Index

requires authentication requires headers

List your waybill proofs of delivery

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/proofs_of_delivery';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
            'page' => '1',
            'per_page' => '3',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/proofs_of_delivery"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
    "page": "1",
    "per_page": "3",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
curl -X GET \
-G "https://dev.api.collivery.co.za/v3/proofs_of_delivery
    ?api_token=OpSjx5TlXGCGkzGAvUOm&page=1&per_page=3
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"

Example response (500):

Show headers 

cache-control: no-cache, private
content-type: application/json


{
    "message": "Server Error"
}

Request   

GET v3/proofs_of_delivery

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

waybill_id   string  optional    

Limit to results with this waybill.

page   string  optional    

Page number to return. Example: 1

per_page   string  optional    

The limit per page. If this option is provided, links and meta will exist in the response with further information about the full list.0 is the same as not limiting. Default is 100. Example: 3

Show

requires authentication requires headers

Get the details and base64 encoded image of the waybill proof of delivery

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/proofs_of_delivery/211515';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/proofs_of_delivery/211515"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
curl -X GET \
-G "https://dev.api.collivery.co.za/v3/proofs_of_delivery/211515
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"

Example response (200):


{
    "data": {
        "id": 211515,
        "type": "",
        "file_name": "4001907_POD.pdf",
        "pages": 1,
        "mime": "application/pdf",
        "size": 2605,
        "created_at": "2019-05-29 18:41:11",
        "image_url": "https://api.collivery.co.za/v3/proofs_of_delivery/211515",
        "image": "JVBERi0xLjMgCjEgMCBvYmoKPDwKL1BhZ2VzIDIgMCBSCi9UeXBlIC9DYXRhbG9nCj4+CmVuZG9iagoyIDAgb2JqCjw8Ci9UeXBlIC9QYWdlcwovS2lkcyBbIDMgMCBSIF0KL0NvdW50IDEKPj4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovUmVzb3VyY2VzIDw8Ci9YT2JqZWN0IDw8IC9JbTAgOCAwIFIgPj4KL1Byb2NTZXQgNiAwIFIgPj4KL01lZGlhQm94IFswIDAgMSAxXQovQ3JvcEJveCBbMCAwIDEgMV0KL0NvbnRlbnRzIDQgMCBSCi9UaHVtYiAxMSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL0xlbmd0aCA1IDAgUgo+PgpzdHJlYW0KcQoxIDAgMCAxIDAgMCBjbQovSW0wIERvClEKCmVuZHN0cmVhbQplbmRvYmoKNSAwIG9iagoyNwplbmRvYmoKNiAwIG9iagpbIC9QREYgL1RleHQgL0ltYWdlQyBdCmVuZG9iago3IDAgb2JqCjw8Cj4+CmVuZG9iago4IDAgb2JqCjw8Ci9UeXBlIC9YT2JqZWN0Ci9TdWJ0eXBlIC9JbWFnZQovTmFtZSAvSW0wCi9GaWx0ZXIgWyAvRENURGVjb2RlIF0KL1dpZHRoIDEKL0hlaWdodCAxCi9Db2xvclNwYWNlIDEwIDAgUgovQml0c1BlckNvbXBvbmVudCA4Ci9MZW5ndGggOSAwIFIKPj4Kc3RyZWFtCv/Y/+AAEEpGSUYAAQEAAAEAAQAA/9sAQwAMCAkKCQcMCgoKDQ0MDhIeExIQEBIkGhsVHismLSwqJikpLzVEOi8yQDMpKTtRPEBGSUxNTC45VFpTSllES0xJ/8AACwgAAQABAQERAP/EABQAAQAAAAAAAAAAAAAAAAAAAAf/xAAUEAEAAAAAAAAAAAAAAAAAAAAA/9oACAEBAAA/AFV//9kKZW5kc3RyZWFtCmVuZG9iago5IDAgb2JqCjE2MAplbmRvYmoKMTAgMCBvYmoKL0RldmljZUdyYXkKZW5kb2JqCjExIDAgb2JqCjw8Ci9GaWx0ZXIgWyAvRENURGVjb2RlIF0KL1dpZHRoIDEKL0hlaWdodCAxCi9Db2xvclNwYWNlIDEwIDAgUgovQml0c1BlckNvbXBvbmVudCA4Ci9MZW5ndGggMTIgMCBSCj4+CnN0cmVhbQr/2P/gABBKRklGAAEBAAABAAEAAP/bAEMADAgJCgkHDAoKCg0NDA4SHhMSEBASJBobFR4rJi0sKiYpKS81RDovMkAzKSk7UTxARklMTUwuOVRaU0pZREtMSf/AAAsIAAEAAQEBEQD/xAAUAAEAAAAAAAAAAAAAAAAAAAAH/8QAFBABAAAAAAAAAAAAAAAAAAAAAP/aAAgBAQAAPwBVf//ZCmVuZHN0cmVhbQplbmRvYmoKMTIgMCBvYmoKMTYwCmVuZG9iagoxMyAwIG9iago8PAo+PgplbmRvYmoKMTQgMCBvYmoKMTYwCmVuZG9iagoxNSAwIG9iago8PAo+PgplbmRvYmoKMTYgMCBvYmoKMTYwCmVuZG9iagoxNyAwIG9iago8PAovVGl0bGUgPEZFRkYwMDYxMDAwMD4KL0NyZWF0aW9uRGF0ZSAoRDoyMDE5MDkxMTA2MjMxMykKL01vZERhdGUgKEQ6MjAxOTA5MTEwNjIzMTMpCi9Qcm9kdWNlciAoaHR0cHM6Ly9pbWFnZW1hZ2ljay5vcmcpCj4+CmVuZG9iagp4cmVmCjAgMTgKMDAwMDAwMDAwMCA2NTUzNSBmIAowMDAwMDAwMDEwIDAwMDAwIG4gCjAwMDAwMDAwNTkgMDAwMDAgbiAKMDAwMDAwMDExOCAwMDAwMCBuIAowMDAwMDAwMjkyIDAwMDAwIG4gCjAwMDAwMDAzNzIgMDAwMDAgbiAKMDAwMDAwMDM5MCAwMDAwMCBuIAowMDAwMDAwNDI4IDAwMDAwIG4gCjAwMDAwMDA0NDkgMDAwMDAgbiAKMDAwMDAwMDc4NSAwMDAwMCBuIAowMDAwMDAwODA0IDAwMDAwIG4gCjAwMDAwMDA4MzIgMDAwMDAgbiAKMDAwMDAwMTEyOCAwMDAwMCBuIAowMDAwMDAxMTQ4IDAwMDAwIG4gCjAwMDAwMDExNzAgMDAwMDAgbiAKMDAwMDAwMTE5MCAwMDAwMCBuIAowMDAwMDAxMjEyIDAwMDAwIG4gCjAwMDAwMDEyMzIgMDAwMDAgbiAKdHJhaWxlcgo8PAovU2l6ZSAxOAovSW5mbyAxNyAwIFIKL1Jvb3QgMSAwIFIKL0lEIFs8ZTAwZTVlYjk0NDQxODJmMzUyMzIzMzc0ZWY0ZTA4ZWJjYjc4NDcyNWZkZDRmZDYxMmQ3NzMwNTQwYjNlMGM4Yz4gPGUwMGU1ZWI5NDQ0MTgyZjM1MjMyMzM3NGVmNGUwOGViY2I3ODQ3MjVmZGQ0ZmQ2MTJkNzczMDU0MGIzZTBjOGM+XQo+PgpzdGFydHhyZWYKMTM3MwolJUVPRgo"
    }
}

Request   

GET v3/proofs_of_delivery/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

URL Parameters

id   number     

The proof of delivery id. Example: 211515

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

9. Parcel Images

Index

requires authentication requires headers

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/parcel_images';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
            'page' => '1',
            'per_page' => '3',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/parcel_images"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
    "page": "1",
    "per_page": "3",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
curl -X GET \
-G "https://dev.api.collivery.co.za/v3/parcel_images
    ?api_token=OpSjx5TlXGCGkzGAvUOm&page=1&per_page=3
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"

Example response (200):


{
    "data": [
        {
            "id": 2681479,
            "waybill_id": 3012330,
            "parcel_number": 1,
            "file_name": "3012330-1.jpeg",
            "mime_type": "image/jpeg",
            "size": 26287,
            "created_at": "2017-07-17 13:06:57",
            "image_url": "https://api.collivery.co.za/v3/parcel_images/2681479"
        },
        {
            "id": 2694043,
            "waybill_id": 3041631,
            "parcel_number": 1,
            "file_name": "3041631-1.jpeg",
            "mime_type": "image/jpeg",
            "size": 32399,
            "created_at": "2017-07-25 14:37:50",
            "image_url": "https://api.collivery.co.za/v3/parcel_images/2694043"
        },
        {
            "id": 2694087,
            "waybill_id": 3041631,
            "parcel_number": 2,
            "file_name": "3041631-2.jpeg",
            "mime_type": "image/jpeg",
            "size": 34726,
            "created_at": "2017-07-25 14:52:37",
            "image_url": "https://api.collivery.co.za/v3/parcel_images/2694087"
        }
    ],
    "links": {
        "first": "https://api.collivery.co.za/v3/parcel_images?page=1",
        "last": "https://api.collivery.co.za/v3/parcel_images?page=2",
        "next": "https://api.collivery.co.za/v3/parcel_images?page=2",
        "prev": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 2,
        "path": "https://api.collivery.co.za/v3/parcel_images",
        "per_page": "3",
        "to": 3,
        "total": 6
    }
}

Request   

GET v3/parcel_images

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

waybill_id   string  optional    

A waybill id that you would like to limit the parcel images to.

page   string  optional    

Page number to return. Example: 1

per_page   string  optional    

The limit per page. If this option is provided, links and meta will exist in the response with further information about the full list.0 is the same as not limiting. Default is 100. Example: 3

Show

requires authentication requires headers

Get the base64 encoded image

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/parcel_images/8';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/parcel_images/8"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
curl -X GET \
-G "https://dev.api.collivery.co.za/v3/parcel_images/8
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"

Example response (200):


{
    "data": {
        "file_name": "3041631-1.jpeg",
        "mime_type": "image/jpeg",
        "image": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAUFBQUFBQUGBgUICAcICAsKCQkKCxEMDQwNDBEaEBMQEBMQGhcbFhUWGxcpIBwcICkvJyUnLzkzMzlHREddXX0BBQUFBQUFBQYGBQgIBwgICwoJCQoLEQwNDA0MERoQExAQExAaFxsWFRYbFykgHBwgKS8nJScvOTMzOUdER11dff/CABEIAAEAAQMBIgACEQEDEQH/xAAUAAEAAAAAAAAAAAAAAAAAAAAI/9oACAEBAAAAAGX/AP/EABQBAQAAAAAAAAAAAAAAAAAAAAD/2gAIAQIQAAAAf//EABQBAQAAAAAAAAAAAAAAAAAAAAD/2gAIAQMQAAAAf//EABQQAQAAAAAAAAAAAAAAAAAAAAD/2gAIAQEAAT8Af//EABQRAQAAAAAAAAAAAAAAAAAAAAD/2gAIAQIBAT8Af//EABQRAQAAAAAAAAAAAAAAAAAAAAD/2gAIAQMBAT8Af//Z"
    }
}

Request   

GET v3/parcel_images/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

URL Parameters

id   integer     

The ID of the parcel image. Example: 8

parcel_image   number     

The parcel image id. Example: 3041631

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

10. Country

Show and search for countries

Index

requires authentication requires headers

Show all countries

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/country';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
            'page' => '1',
            'per_page' => '3',
        ],
        'json' => [
            'search' => 'south',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/country"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
    "page": "1",
    "per_page": "3",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};

let body = {
    "search": "south"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl -X GET \
-G "https://dev.api.collivery.co.za/v3/country
    ?api_token=OpSjx5TlXGCGkzGAvUOm&page=1&per_page=3
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"                \
                                    -d '{"search":"south"}'

Example response (500):

Show headers 

cache-control: no-cache, private
content-type: application/json


{
    "message": "Server Error"
}

Request   

GET v3/country

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

page   string  optional    

Page number to return. Example: 1

per_page   string  optional    

The limit per page. If this option is provided, links and meta will exist in the response with further information about the full list.0 is the same as not limiting. Default is 300. Example: 3

Body Parameters

search   required  optional    

Must be at least 3 characters. Example: south

11. Towns

Show and search for Towns

Index

requires authentication requires headers

Show all towns for a country or search towns.

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/towns';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
            'page' => '1',
            'per_page' => '3',
        ],
        'json' => [
            'country' => 'ZAF',
            'province' => 'Gauteng',
            'search' => 'Joh',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/towns"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
    "page": "1",
    "per_page": "3",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};

let body = {
    "country": "ZAF",
    "province": "Gauteng",
    "search": "Joh"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl -X GET \
-G "https://dev.api.collivery.co.za/v3/towns
    ?api_token=OpSjx5TlXGCGkzGAvUOm&page=1&per_page=3
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"                \
                                    -d '{"country":"ZAF","province":"Gauteng","search":"Joh"}'

Example response (500):

Show headers 

cache-control: no-cache, private
content-type: application/json


{
    "message": "Server Error"
}

Request   

GET v3/towns

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

page   string  optional    

Page number to return. Example: 1

per_page   string  optional    

The limit per page. If this option is provided, links and meta will exist in the response with further information about the full list.0 is the same as not limiting. Default is 300. Example: 3

Body Parameters

country   The  optional    

three letter abbreviation (ISO 3166) for the country. Defaults to ZAF. Example: ZAF

province   Filter  optional    

by province name. Valid values are: Eastern Cape, Free State, Gauteng, KwaZulu Natal, Limpopo, Mpumalanga,Northern Cape, North West, Western Cape. Example: Gauteng

search   Search  optional    

by town name. Example: Joh

12. Suburbs

Show and filter suburbs

Index

requires authentication requires headers

Show all suburbs for a town or country or search suburbs.

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/suburbs';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
            'page' => '1',
            'per_page' => '3',
        ],
        'json' => [
            'town_id' => '147',
            'country' => 'ZAF',
            'latitude' => '-26.212500',
            'longitude' => '28.037500',
            'postal_code' => '2000',
            'postal_code_range' => '100',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/suburbs"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
    "page": "1",
    "per_page": "3",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};

let body = {
    "town_id": "147",
    "country": "ZAF",
    "latitude": "-26.212500",
    "longitude": "28.037500",
    "postal_code": "2000",
    "postal_code_range": "100"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl -X GET \
-G "https://dev.api.collivery.co.za/v3/suburbs
    ?api_token=OpSjx5TlXGCGkzGAvUOm&page=1&per_page=3
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"                \
                                    -d '{"town_id":"147","country":"ZAF","latitude":"-26.212500","longitude":"28.037500","postal_code":"2000","postal_code_range":"100"}'

Example response (500):

Show headers 

cache-control: no-cache, private
content-type: application/json


{
    "message": "Server Error"
}

Request   

GET v3/suburbs

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

page   string  optional    

Page number to return. Example: 1

per_page   string  optional    

The limit per page. If this option is provided, links and meta will exist in the response with further information about the full list.0 is the same as not limiting. Default is 2000. Example: 3

Body Parameters

town_id   Required  optional    

without country. Can be obtained from /towns/ endpoint. Example: 147

country   Required  optional    

without town_id. The three letter abbreviation (ISO 3166) for the country. Defaults to ZAF. Example: ZAF

latitude   A  optional    

latitude to search for the closest 5 suburbs. Required if longitude is provided. Example: -26.212500

longitude   A  optional    

longitude to search for the closest 5 suburbs. Required if latitude is provided. Example: 28.037500

postal_code   A  optional    

postal code to limit the result set to. Example: 2000

postal_code_range   The  optional    

range within which to match the postal codes. For example the 2000 with a range of 100 matches postal codes 1900 to 2100. Defaults to 0 (ie. exact postal code match) Example: 100

postal_code_type   The  optional    

type of postal code to limit matches to. street or box are allowed. Defaults to a match on either.

search   Search  optional    

by suburb name.

Show

requires authentication requires headers

Show details of one particular suburb. Loaded with Town details included

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/suburbs/-1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/suburbs/-1"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
curl -X GET \
-G "https://dev.api.collivery.co.za/v3/suburbs/-1
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"                \

Example response (500):

Show headers 

cache-control: no-cache, private
content-type: application/json


{
    "message": "Server Error"
}

Request   

GET v3/suburbs/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

URL Parameters

id   integer     

The ID of the suburb. Example: -1

suburb   number     

The suburb id. Example: 1936

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

Body Parameters

suburb   string  optional    

requires authentication requires headers

Search by name for suburbs and/or town. Results are returned in order of most populated areas by default

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/town_suburb_search';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
        'json' => [
            'search_text' => 'westcli',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/town_suburb_search"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};

let body = {
    "search_text": "westcli"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl -X GET \
-G "https://dev.api.collivery.co.za/v3/town_suburb_search
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"                \
                                    -d '{"search_text":"westcli"}'

Example response (500):

Show headers 

cache-control: no-cache, private
content-type: application/json


{
    "message": "Server Error"
}

13. Service Types

Show all service types or searched

Index

requires authentication requires headers

Get available service types with delivery days

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/service_types';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/service_types"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
curl -X GET \
-G "https://dev.api.collivery.co.za/v3/service_types
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"

Example response (500):

Show headers 

cache-control: no-cache, private
content-type: application/json


{
    "message": "Server Error"
}

Request   

GET v3/service_types

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

Show

requires authentication requires headers

Get specific service type by id

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/service_type/2';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/service_type/2"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
curl -X GET \
-G "https://dev.api.collivery.co.za/v3/service_type/2
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"

Example response (500):

Show headers 

cache-control: no-cache, private
content-type: application/json


{
    "message": "Server Error"
}

Request   

GET v3/service_type/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

URL Parameters

id   integer     

Example: 2

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

14. Location Types

Index

requires authentication requires headers

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/location_types';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
            'search' => 'business',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/location_types"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
    "search": "business",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
curl -X GET \
-G "https://dev.api.collivery.co.za/v3/location_types
    ?api_token=OpSjx5TlXGCGkzGAvUOm&search=business
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"

Example response (500):

Show headers 

cache-control: no-cache, private
content-type: application/json


{
    "message": "Server Error"
}

Request   

GET v3/location_types

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

search   string  optional    

An optional search string matched against the location types names. Example: business

surcharge_only   string  optional    

{include, exclude} include will return only surchargeable location types, exclude will return only non-surchargeable location types.

15. Battery Types

Index Get all battery types.

requires authentication requires headers

Get all battery types, to be used when booking a waybill. Should be aggressively cached, or even statically defined.

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/battery_types';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/battery_types"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
curl -X GET \
-G "https://dev.api.collivery.co.za/v3/battery_types
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"

Example response (500):

Show headers 

cache-control: no-cache, private
content-type: application/json


{
    "message": "Server Error"
}

Request   

GET v3/battery_types

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

16. Parcel Types

Index

requires authentication requires headers

Get all parcel types, to be used when booking a waybill. Should be aggressively cached, or even statically defined.

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/parcel_types';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/parcel_types"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
curl -X GET \
-G "https://dev.api.collivery.co.za/v3/parcel_types
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"

Example response (500):

Show headers 

cache-control: no-cache, private
content-type: application/json


{
    "message": "Server Error"
}

Request   

GET v3/parcel_types

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

17. Terms and Conditions

Index

requires authentication requires headers

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/terms_and_conditions';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/terms_and_conditions"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
curl -X GET \
-G "https://dev.api.collivery.co.za/v3/terms_and_conditions
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"

Example response (500):

Show headers 

cache-control: no-cache, private
content-type: application/json


{
    "message": "Server Error"
}

Request   

GET v3/terms_and_conditions

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

18. Vendors

Manage Vendors

Index

requires authentication requires headers

Show all vendors, or all vendors of a certain type

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/vendors';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
        'json' => [
            'vendor_type' => 'TAK_SUP',
            'vendor_id' => '123152',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/vendors"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};

let body = {
    "vendor_type": "TAK_SUP",
    "vendor_id": "123152"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl -X GET \
-G "https://dev.api.collivery.co.za/v3/vendors
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"                \
                                    -d '{"vendor_type":"TAK_SUP","vendor_id":"123152"}'

Example response (200):


{
    "data": [
        {
            "id": 1770,
            "vendor_type": "TAK_SUP",
            "vendor_id": 32143451,
            "verified": false,
            "deleted": false
        },
        {
            "id": 1774,
            "vendor_type": "TAK_SUP",
            "vendor_id": 32143451,
            "verified": false,
            "deleted": false
        },
        {
            "id": 1775,
            "vendor_type": "TAK_SUP",
            "vendor_id": 32143451,
            "verified": false,
            "deleted": false
        },
        {
            "id": 1776,
            "vendor_type": "TAK_SUP",
            "vendor_id": 32143451,
            "verified": false,
            "deleted": false
        }
    ]
}

Request   

GET v3/vendors

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

Body Parameters

vendor_type   string  optional    

Example: TAK_SUP

Must be one of:
  • TAK_SUP
  • TAK_SEL
  • SUP_SUP
waybill_id   string  optional    

Must match an existing stored value.

vendor_id   string  optional    

optional The vendor id. Required if vendor_type TAK_SEL. Example: 123152

id   optional  optional    

The waybill id.

Store

requires authentication requires headers

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/vendors';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
        'json' => [
            'vendor_type' => 'TAK_SUP',
            'vendor_id' => '123152',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/vendors"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};

let body = {
    "vendor_type": "TAK_SUP",
    "vendor_id": "123152"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl -X POST \
"https://dev.api.collivery.co.za/v3/vendors
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"                \
                                    -d '{"vendor_type":"TAK_SUP","vendor_id":"123152"}'

Example response (200):


{
    "data": [
        {
            "id": 1770,
            "vendor_type": "TAK_SUP",
            "vendor_id": 123152,
            "verified": false,
            "deleted": false
        }
    ]
}

Request   

POST v3/vendors

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

URL Parameters

id   string     

The vendor's ID. Example: 123152

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

Body Parameters

vendor_type   string     

The vendor type SUP_SUP, TAK_SUP or TAK_SEL. Example: TAK_SUP

vendor_id   string  optional    

optional The vendor id. Required if vendor_type TAK_SEL. Example: 123152

Update

requires authentication requires headers

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/vendors/123152';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
        'json' => [
            'vendor_type' => 'TAK_SUP',
            'vendor_id' => '123152',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/vendors/123152"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};

let body = {
    "vendor_type": "TAK_SUP",
    "vendor_id": "123152"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl -X PUT \
"https://dev.api.collivery.co.za/v3/vendors/123152
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"                \
                                    -d '{"vendor_type":"TAK_SUP","vendor_id":"123152"}'

Example response (200):


{
    "data": [
        {
            "id": 1770,
            "vendor_type": "TAK_SUP",
            "vendor_id": 123152,
            "verified": false,
            "deleted": false
        }
    ]
}

Request   

PUT v3/vendors/{id}

PATCH v3/vendors/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

URL Parameters

id   string     

The vendor's ID. Example: 123152

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

Body Parameters

vendor_type   string     

The vendor type SUP_SUP, TAK_SUP or TAK_SEL. Example: TAK_SUP

vendor_id   string  optional    

optional The vendor id. Required if vendor_type TAK_SEL. Example: 123152

Destroy

requires authentication requires headers

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/vendors/4';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/vendors/4"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};


fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
curl -X DELETE \
"https://dev.api.collivery.co.za/v3/vendors/4
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"

Example response (200):


{
    "data": [
        {
            "id": 1770,
            "vendor_type": "TAK_SUP",
            "vendor_id": 123152,
            "verified": false,
            "deleted": true
        }
    ]
}

Request   

DELETE v3/vendors/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

URL Parameters

id   integer     

The ID of the vendor. Example: 4

vendor   number     

The vendor id. Example: 1770

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

19. Vendor Reports

View

Index

requires authentication requires headers

List of Takealot waybills

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/vendor/reports';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
        'json' => [
            'per_page' => 9,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/vendor/reports"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};

let body = {
    "per_page": 9
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl -X GET \
-G "https://dev.api.collivery.co.za/v3/vendor/reports
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"                \
                                    -d '{"per_page":9}'

Example response (200):


{
    "data": [
        {
            "waybill": 5518724,
            "purchase_orders": [
                {
                    "po": "12345678",
                    "asn": null,
                    "due_date": "2021-10-25",
                    "quantity": 1
                },
                {
                    "po": "12345679",
                    "asn": null,
                    "due_date": "2021-10-25",
                    "quantity": 2
                },
                {
                    "po": "12345673",
                    "asn": null,
                    "due_date": "2021-10-25",
                    "quantity": 1
                },
                {
                    "po": "12345674",
                    "asn": null,
                    "due_date": "2021-10-25",
                    "quantity": 2
                },
                {
                    "po": "12345672",
                    "asn": null,
                    "due_date": "2021-10-25",
                    "quantity": 1
                }
            ],
            "client": "Nuoli",
            "waybill_quantity": 7,
            "service": "Road Freight",
            "status": "Quote Accepted",
            "sla_status": "not delivered"
        }
    ],
    "meta": {
        "next_url": null,
        "previous_url": null,
        "pages": 0
    }
}

Request   

GET v3/vendor/reports

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

URL Parameters

dc   string  optional    

The id of the DC. Takealot JNB (40) or Takealot JNB Bulk (39) or Takealot CPT (41) depot. Example: 40

per_page   integer  optional    

Number of waybills per page. Max is 50. Example: 20

vendor   string  optional    

MDS Vendor id. Can be obtained from /vendors/ endpoint. Example: 1285

status   string  optional    

Status id. Can be obtained from /statuses/ endpoint. Example: 3

po_number   integer  optional    

Purchase order number. Example: 52044591

asn   string  optional    

ASN.

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

Body Parameters

dc   string  optional    

Must match an existing stored value.

per_page   number  optional    

Must not be greater than 50. Example: 9

OnTime

requires authentication requires headers

On time report for Takealot Waybills

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/vendor/reports/on_time';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
        'json' => [
            'direction' => 'collection',
            'distribution_center' => 'DBN Main DC',
            'po_number_search' => 'ex',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/vendor/reports/on_time"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};

let body = {
    "direction": "collection",
    "distribution_center": "DBN Main DC",
    "po_number_search": "ex"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl -X GET \
-G "https://dev.api.collivery.co.za/v3/vendor/reports/on_time
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"                \
                                    -d '{"direction":"collection","distribution_center":"DBN Main DC","po_number_search":"ex"}'

Example response (200):


{
    "data": [
        {
            "waybill": 5674754,
            "status": "Invoiced",
            "po": "12345678",
            "asn": "1",
            "client": "Acme Trading (Pty) Ltd",
            "quantity": 1,
            "service": "Road Freight",
            "due_date": "2022-01-06",
            "collection_time": "2022-01-05 09:00:00",
            "collected_at": "2022-01-05 13:44:58",
            "deliver_before": "2022-01-6 14:00:00",
            "days_late": 2
        }
    ],
    "meta": {
        "summary": {
            "total_failures": 0,
            "total": 1,
            "percentage": 0
        }
    }
}

Request   

GET v3/vendor/reports/on_time

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

URL Parameters

start_date   string  optional    

The date of the start of the report. Example: 2022-01-10

end_date   string  optional    

The date of the end of the report. Example: 2022-01-11

direction   string  optional    

Direction. Collect from client (collection), Deliver to client (delivery), or Collection and Delivery (both) . Example: collection

distribution_center   string  optional    

The id of the DC. Takealot JNB (JNB) or Takealot JNB Bulk (JNB_BULK) or Takealot CPT (CPT) depot. Example: JNB_BULK

po_number_search   integer  optional    

Comma seperated Purchase order numbers to search. Example: 1231242

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

Body Parameters

start_date   string  optional    
end_date   string  optional    
direction   string  optional    

Example: collection

Must be one of:
  • collection
  • delivery
  • both
distribution_center   string  optional    

Example: DBN Main DC

Must be one of:
  • JHB Bulk DC3
  • CPT Main DC
  • JHB Main DC
  • CPT Bulk DC2
  • DBN Main DC
po_number_search   string  optional    

Example: ex

InFull

requires authentication requires headers

In full report for Takealot Waybills

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/vendor/reports/in_full';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
        'json' => [
            'direction' => 'collection',
            'distribution_center' => 'DBN Main DC',
            'po_number_search' => 'ex',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/vendor/reports/in_full"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};

let body = {
    "direction": "collection",
    "distribution_center": "DBN Main DC",
    "po_number_search": "ex"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl -X GET \
-G "https://dev.api.collivery.co.za/v3/vendor/reports/in_full
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"                \
                                    -d '{"direction":"collection","distribution_center":"DBN Main DC","po_number_search":"ex"}'

Example response (200):


{
    "data": [
        {
            "waybill": 5504810,
            "status": "Invoiced",
            "po": "34456899",
            "asn": null,
            "client": "Acme Trading  Pty Ltd",
            "quantity": 2,
            "service": "Road Freight",
            "quantity_at_dest": 0
        },
        {
            "waybill": 5504810,
            "status": "Invoiced",
            "po": "123789",
            "asn": null,
            "client": "Acme Trading Pty Ltd",
            "quantity": 2,
            "service": "Road Freight",
            "quantity_at_dest": 0
        },
        {
            "waybill": 5504810,
            "status": "Invoiced",
            "po": "23456789",
            "asn": null,
            "client": "Acme Trading Pty Ltd",
            "quantity": 2,
            "service": "Road Freight",
            "quantity_at_dest": 0
        }
    ],
    "meta": {
        "summary": {
            "failures": 3,
            "total": 137961,
            "percentage": 0
        }
    }
}

Request   

GET v3/vendor/reports/in_full

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

URL Parameters

start_date   string  optional    

The date of the start of the report. Example: 2022-01-10

end_date   string  optional    

The date of the end of the report. Example: 2022-01-11

direction   string  optional    

Direction. Collect from client (collection), Deliver to client (delivery), or Collection and Delivery (both) . Example: collection

distribution_center   string  optional    

The id of the DC. Takealot JNB (JNB) or Takealot JNB Bulk (JNB_BULK) or Takealot CPT (CPT) depot. Example: JNB_BULK

po_number_search   integer  optional    

Comma seperated Purchase order numbers to search. Example: 1231242

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

Body Parameters

start_date   string  optional    
end_date   string  optional    
direction   string  optional    

Example: collection

Must be one of:
  • collection
  • delivery
  • both
distribution_center   string  optional    

Example: DBN Main DC

Must be one of:
  • JHB Bulk DC3
  • CPT Main DC
  • JHB Main DC
  • CPT Bulk DC2
  • DBN Main DC
po_number_search   string  optional    

Example: ex

LostOrDamaged

requires authentication requires headers

Lost or damaged report for Takealot Waybills including claim status

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/vendor/reports/lost_or_damaged';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
        'json' => [
            'direction' => 'collection',
            'distribution_center' => 'DBN Main DC',
            'po_number_search' => 'ex',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/vendor/reports/lost_or_damaged"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};

let body = {
    "direction": "collection",
    "distribution_center": "DBN Main DC",
    "po_number_search": "ex"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl -X GET \
-G "https://dev.api.collivery.co.za/v3/vendor/reports/lost_or_damaged
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"                \
                                    -d '{"direction":"collection","distribution_center":"DBN Main DC","po_number_search":"ex"}'

Example response (200):


{
    "data": [
        {
            "waybill": 4899591,
            "status": "Invoiced",
            "po": "12312351",
            "asn": "ASNCQWERT036712920",
            "client": "Acme Trading Pty Ltd",
            "quantity": 2,
            "service": "Road Freight",
            "claim_approved": false,
            "claim_value_rands": 400,
            "claim_status": "Denied",
            "claim_reason": "Dear Acme, it appears the item was not packaged in line with TakeAlot packaging standards. Unfortunately we are unable to assist with the claim"
        },
        {
            "waybill": 4909021,
            "status": "Invoiced",
            "po": "3622220",
            "asn": null,
            "client": "Acme Trading Pty Ltd",
            "quantity": 2,
            "service": "Road Freight",
            "claim_approved": true,
            "claim_value_rands": 3995,
            "claim_status": "Completed",
            "claim_reason": "Dear Acme, thank you for submitted your claim. After review of the photographic evidence your claim has been approved. Please supply invoice for cost"
        }
    ],
    "meta": {
        "summary": {
            "claims_total": 2,
            "accepted_total": 1,
            "rejected_total": 1,
            "total": 2590,
            "percentage": 0.04
        }
    }
}

Request   

GET v3/vendor/reports/lost_or_damaged

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

URL Parameters

start_date   string  optional    

The date of the start of the report. Example: 2022-01-10

end_date   string  optional    

The date of the end of the report. Example: 2022-01-11

direction   string  optional    

Direction. Collect from client (collection), Deliver to client (delivery), or Collection and Delivery (both) . Example: collection

distribution_center   string  optional    

The id of the DC. Takealot JNB (JNB) or Takealot JNB Bulk (JNB_BULK) or Takealot CPT (CPT) depot. Example: JNB_BULK

po_number_search   integer  optional    

Comma seperated Purchase order numbers to search. Example: 1231242

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

Body Parameters

start_date   string  optional    
end_date   string  optional    
direction   string  optional    

Example: collection

Must be one of:
  • collection
  • delivery
  • both
distribution_center   string  optional    

Example: DBN Main DC

Must be one of:
  • JHB Bulk DC3
  • CPT Main DC
  • JHB Main DC
  • CPT Bulk DC2
  • DBN Main DC
po_number_search   string  optional    

Example: ex

20. Vendor Waybills

Add Vendor Waybill bookings

Store

requires authentication requires headers

Create a new vendor waybill

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/vendor_bookings';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
        'json' => [
            'vendor_depot' => 'JHB Bulk DC3',
            'vehicle_type' => 2,
            'risk_cover' => true,
            'collection_time' => '2025-01-24',
            'orders' => [
                [
                    'purchase_order_number' => 'ex',
                    'parcel_count' => 2,
                    'vendor_id' => 1772,
                    'due_date' => '2012-02-25',
                    'asn' => 'ex',
                    'length' => 21.5,
                    'width' => 10.0,
                    'height' => 5.5,
                    'weight' => 5.5,
                ],
            ],
            'delivery_address' => '952',
            'service_type' => 3,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/vendor_bookings"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};

let body = {
    "vendor_depot": "JHB Bulk DC3",
    "vehicle_type": 2,
    "risk_cover": true,
    "collection_time": "2025-01-24",
    "orders": [
        {
            "purchase_order_number": "ex",
            "parcel_count": 2,
            "vendor_id": 1772,
            "due_date": "2012-02-25",
            "asn": "ex",
            "length": 21.5,
            "width": 10,
            "height": 5.5,
            "weight": 5.5
        }
    ],
    "delivery_address": "952",
    "service_type": 3
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl -X POST \
"https://dev.api.collivery.co.za/v3/vendor_bookings
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"                \
                                    -d '{"vendor_depot":"JHB Bulk DC3","vehicle_type":2,"risk_cover":true,"collection_time":"2025-01-24","orders":[{"purchase_order_number":"ex","parcel_count":2,"vendor_id":1772,"due_date":"2012-02-25","asn":"ex","length":21.5,"width":10,"height":5.5,"weight":5.5}],"delivery_address":"952","service_type":3}'

Example response (500):

Show headers 

cache-control: no-cache, private
content-type: application/json


{
    "message": "Server Error"
}

Request   

POST v3/vendor_bookings

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

Body Parameters

vendor_depot   string     

JNB Main (JHB Main DC), CPT Main (CPT Main DC), JNB Bulk (JHB Bulk DC3), CPT Bulk (CPT Bulk DC2) . Example: JHB Bulk DC3

vehicle_type   integer     

The vehicle that we should collect it with. Defaults to 1 (Motorbike). Example: 2

risk_cover   boolean  optional    

optional Whether to enable risk cover over and above the default cover. See terms and conditions. Surcharges will be applied. Defaults to false. Example: true

collection_time   string     

Any future date/time representation that can be parsed by PHP strtotime(). Interpreted as GMT+2. If left empty no time surcharges will be encountered. Must be after current time. Example: 2025-01-24

orders   object[]  optional    

Purchase orders.
purchase_order_number   string     

The Purchase order number. Example 165488742 Example: ex

parcel_count   integer     

The amount of parcels of this type. Example: 2

vendor_id   integer     

The id of the vendor stored with Collivery. Example: 1772

due_date   date     

The date the order is due at Vendor depot. Example: 2012-02-25

asn   string  optional    

optional The ASN of order. Example TAL_12341 Example: ex

length   number  optional    

optional The length of the parcel. Values in centimetres. Can be supplied as floats or integers. Example: 21.5

width   number  optional    

optional The width of the parcel. Values in centimetres. Can be supplied as floats or integers. Example: 10

height   number  optional    

optional The height of the parcel. Values in centimetres. Can be supplied as floats or integers. Example: 5.5

weight   number  optional    

optional The weight of the parcel. Values in kilograms. Can be supplied as floats or integers. Example: 5.5

collection_address   integer/object  optional    

optional Required if delivery_address not supplied, can be the id of the address or a json object if the address is not yet stored. See below for object structure.
custom_id   string  optional    

The custom id you would like to assign to this address. Must be unique. Max 20 characters.

town_id   integer  optional    

Required without town_name and suburb_id. Can be obtained from /towns/ endpoint.

town_name   string  optional    

Required without town_idand suburb_id. Can be obtained from /towns/ endpoint.

suburb_id   integer  optional    

Required without suburb_name. Can be obtained from /suburbs/ endpoint.

suburb_name   string  optional    

Required without suburb_id. Can be obtained from /suburbs/ endpoint.

company_name   string  optional    

The name of the company of the address. Max 50 characters.

building   string  optional    

The building of the address. Max 50 characters.

street_number   string  optional    

The number on the street of the address. Max 5 characters.

street   string  optional    

optional Required if the address is filled. The name of the street that the address is on. Max 50 characters.

location_type   integer  optional    

Required without location_type_name. The id of the location type for the address. Can be obtained from /location_types/ endpoint.

location_type_name   string  optional    

Required without location_type. The name of the location type for the address. Can be obtained from /location_types/ endpoint.

contact   object  optional    

optional If you are creating a contact with the address, please ensure that it is a valid JSON object.
full_name   string  optional    

optional If you are creating a contact with the address, their full name. Required if any of cellphone, work_phone or email_address is present in the contact object. Min 2 characters, max 50 characters.

cellphone   string  optional    

optional If you are creating a contact with the address, their cellphone. Required if any of full_name or email_address is present in the contact object - and work_phone is not provided. Min 10 characters, max 20 characters.

work_phone   string  optional    

optional If you are creating a contact with the address, their cellphone. Required if any of full_name or email_address is present in the contact object - and cellphone is not provided. Min 10 characters, max 20 characters.

email_address   string  optional    

optional If you are creating a contact with the address, their full name. Useful for tracking updates to be sent to. Max 50 characters.

delivery_address   integer/object  optional    

optional Required if collection_address not supplied, can be the id of the address or a json object if the address is not yet stored. See below for object structure. Example: 952
custom_id   string  optional    

The custom id you would like to assign to this address. Must be unique. Max 20 characters.

town_id   integer  optional    

Required without town_name and suburb_id. Can be obtained from /towns/ endpoint.

town_name   string  optional    

Required without town_id and suburb_id. Can be obtained from /towns/ endpoint.

suburb_id   integer  optional    

Required without suburb_name. Can be obtained from /suburbs/ endpoint.

suburb_name   string  optional    

Required without suburb_id. Can be obtained from /suburbs/ endpoint.

company_name   string  optional    

The name of the company of the address. Max 50 characters.

building   string  optional    

The building of the address. Max 50 characters.

street_number   string  optional    

The number on the street of the address. Max 5 characters.

street   string  optional    

optional Required if the address is filled. The name of the street that the address is on. Max 50 characters.

location_type   integer  optional    

Required without location_type_name. The id of the location type for the address. Can be obtained from /location_types/ endpoint.

location_type_name   string  optional    

Required without location_type. The name of the location type for the address. Can be obtained from /location_types/ endpoint.

contact   object  optional    

optional If you are creating a contact with the address, please ensure that it is a valid JSON object.
full_name   string  optional    

optional If you are creating a contact with the address, their full name. Required if any of cellphone, work_phone or email_address is present in the contact object. Min 2 characters, max 50 characters.

cellphone   string  optional    

optional If you are creating a contact with the address, their cellphone. Required if any of full_name or email_address is present in the contact object - and work_phone is not provided. Min 10 characters, max 20 characters.

work_phone   string  optional    

optional If you are creating a contact with the address, their cellphone. Required if any of full_name or email_address is present in the contact object - and cellphone is not provided. Min 10 characters, max 20 characters.

email_address   string  optional    

optional If you are creating a contact with the address, their full name. Useful for tracking updates to be sent to. Max 50 characters.

service_type   integer     

A service you would like to deliver the waybill on. Defaults to 2 (Overnight Express). Example: 3

Quote

requires authentication requires headers

Quote on a vendor waybill

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/vendor_bookings/quote';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
        'json' => [
            'vendor_depot' => 'JHB Bulk DC3',
            'vehicle_type' => 2,
            'risk_cover' => true,
            'collection_time' => '2025-01-24',
            'orders' => [
                [
                    'purchase_order_number' => 'ex',
                    'parcel_count' => 2,
                    'vendor_id' => 1772,
                    'due_date' => '2012-02-25',
                    'asn' => 'ex',
                    'length' => 21.5,
                    'width' => 10.0,
                    'height' => 5.5,
                    'weight' => 5.5,
                ],
            ],
            'delivery_address' => '952',
            'service_types' => [
                2,
                5,
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/vendor_bookings/quote"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};

let body = {
    "vendor_depot": "JHB Bulk DC3",
    "vehicle_type": 2,
    "risk_cover": true,
    "collection_time": "2025-01-24",
    "orders": [
        {
            "purchase_order_number": "ex",
            "parcel_count": 2,
            "vendor_id": 1772,
            "due_date": "2012-02-25",
            "asn": "ex",
            "length": 21.5,
            "width": 10,
            "height": 5.5,
            "weight": 5.5
        }
    ],
    "delivery_address": "952",
    "service_types": [
        2,
        5
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl -X POST \
"https://dev.api.collivery.co.za/v3/vendor_bookings/quote
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"                \
                                    -d '{"vendor_depot":"JHB Bulk DC3","vehicle_type":2,"risk_cover":true,"collection_time":"2025-01-24","orders":[{"purchase_order_number":"ex","parcel_count":2,"vendor_id":1772,"due_date":"2012-02-25","asn":"ex","length":21.5,"width":10,"height":5.5,"weight":5.5}],"delivery_address":"952","service_types":[2,5]}'

Example response (500):

Show headers 

cache-control: no-cache, private
content-type: application/json


{
    "message": "Server Error"
}

Request   

POST v3/vendor_bookings/quote

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

Body Parameters

vendor_depot   string     

JNB Main (JHB Main DC), CPT Main (CPT Main DC), JNB Bulk (JHB Bulk DC3), CPT Bulk (CPT Bulk DC2) . Example: JHB Bulk DC3

vehicle_type   integer     

The vehicle that we should collect it with. Defaults to 1 (Motorbike). Example: 2

risk_cover   boolean  optional    

optional Whether to enable risk cover over and above the default cover. See terms and conditions. Surcharges will be applied. Defaults to false. Example: true

collection_time   string     

Any future date/time representation that can be parsed by PHP strtotime(). Interpreted as GMT+2. If left empty no time surcharges will be encountered. Must be after current time. Example: 2025-01-24

orders   object[]  optional    

Purchase orders.
purchase_order_number   string     

The Purchase order number. Example 165488742 Example: ex

parcel_count   integer     

The amount of parcels of this type. Example: 2

vendor_id   integer     

The id of the vendor stored with Collivery. Example: 1772

due_date   date     

The date the order is due at Vendor depot. Example: 2012-02-25

asn   string  optional    

optional The ASN of order. Example TAL_12341 Example: ex

length   number  optional    

optional The length of the parcel. Values in centimetres. Can be supplied as floats or integers. Example: 21.5

width   number  optional    

optional The width of the parcel. Values in centimetres. Can be supplied as floats or integers. Example: 10

height   number  optional    

optional The height of the parcel. Values in centimetres. Can be supplied as floats or integers. Example: 5.5

weight   number  optional    

optional The weight of the parcel. Values in kilograms. Can be supplied as floats or integers. Example: 5.5

collection_address   integer/object  optional    

optional Required if delivery_address not supplied, can be the id of the address or a json object if the address is not yet stored. See below for object structure.
custom_id   string  optional    

The custom id you would like to assign to this address. Must be unique. Max 20 characters.

town_id   integer  optional    

Required without town_name and suburb_id. Can be obtained from /towns/ endpoint.

town_name   string  optional    

Required without town_idand suburb_id. Can be obtained from /towns/ endpoint.

suburb_id   integer  optional    

Required without suburb_name. Can be obtained from /suburbs/ endpoint.

suburb_name   string  optional    

Required without suburb_id. Can be obtained from /suburbs/ endpoint.

company_name   string  optional    

The name of the company of the address. Max 50 characters.

building   string  optional    

The building of the address. Max 50 characters.

street_number   string  optional    

The number on the street of the address. Max 5 characters.

street   string  optional    

optional Required if the address is filled. The name of the street that the address is on. Max 50 characters.

location_type   integer  optional    

Required without location_type_name. The id of the location type for the address. Can be obtained from /location_types/ endpoint.

location_type_name   string  optional    

Required without location_type. The name of the location type for the address. Can be obtained from /location_types/ endpoint.

contact   object  optional    

optional If you are creating a contact with the address, please ensure that it is a valid JSON object.
full_name   string  optional    

optional If you are creating a contact with the address, their full name. Required if any of cellphone, work_phone or email_address is present in the contact object. Min 2 characters, max 50 characters.

cellphone   string  optional    

optional If you are creating a contact with the address, their cellphone. Required if any of full_name or email_address is present in the contact object - and work_phone is not provided. Min 10 characters, max 20 characters.

work_phone   string  optional    

optional If you are creating a contact with the address, their cellphone. Required if any of full_name or email_address is present in the contact object - and cellphone is not provided. Min 10 characters, max 20 characters.

email_address   string  optional    

optional If you are creating a contact with the address, their full name. Useful for tracking updates to be sent to. Max 50 characters.

delivery_address   integer/object  optional    

optional Required if collection_address not supplied, can be the id of the address or a json object if the address is not yet stored. See below for object structure. Example: 952
custom_id   string  optional    

The custom id you would like to assign to this address. Must be unique. Max 20 characters.

town_id   integer  optional    

Required without town_name and suburb_id. Can be obtained from /towns/ endpoint.

town_name   string  optional    

Required without town_id and suburb_id. Can be obtained from /towns/ endpoint.

suburb_id   integer  optional    

Required without suburb_name. Can be obtained from /suburbs/ endpoint.

suburb_name   string  optional    

Required without suburb_id. Can be obtained from /suburbs/ endpoint.

company_name   string  optional    

The name of the company of the address. Max 50 characters.

building   string  optional    

The building of the address. Max 50 characters.

street_number   string  optional    

The number on the street of the address. Max 5 characters.

street   string  optional    

optional Required if the address is filled. The name of the street that the address is on. Max 50 characters.

location_type   integer  optional    

Required without location_type_name. The id of the location type for the address. Can be obtained from /location_types/ endpoint.

location_type_name   string  optional    

Required without location_type. The name of the location type for the address. Can be obtained from /location_types/ endpoint.

contact   object  optional    

optional If you are creating a contact with the address, please ensure that it is a valid JSON object.
full_name   string  optional    

optional If you are creating a contact with the address, their full name. Required if any of cellphone, work_phone or email_address is present in the contact object. Min 2 characters, max 50 characters.

cellphone   string  optional    

optional If you are creating a contact with the address, their cellphone. Required if any of full_name or email_address is present in the contact object - and work_phone is not provided. Min 10 characters, max 20 characters.

work_phone   string  optional    

optional If you are creating a contact with the address, their cellphone. Required if any of full_name or email_address is present in the contact object - and cellphone is not provided. Min 10 characters, max 20 characters.

email_address   string  optional    

optional If you are creating a contact with the address, their full name. Useful for tracking updates to be sent to. Max 50 characters.

service_types   object[]  optional    

number A list of the services you would like a quote on. Any or none of 2,3,5. Defaults to all services.

21. Statuses

View Statuses

Index

requires authentication requires headers

List all in use statuses

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/statuses';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/statuses"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
curl -X GET \
-G "https://dev.api.collivery.co.za/v3/statuses
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"

Example response (500):

Show headers 

cache-control: no-cache, private
content-type: application/json


{
    "message": "Server Error"
}

Request   

GET v3/statuses

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

22. WebPrinter

Get your Printers Available and execute jobs

Index

requires authentication requires headers

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/web_printer';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/web_printer"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
curl -X GET \
-G "https://dev.api.collivery.co.za/v3/web_printer
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"

Example response (500):

Show headers 

cache-control: no-cache, private
content-type: application/json


{
    "message": "Server Error"
}

Request   

GET v3/web_printer

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

23. Predefined Parcels

Manage Predefined Parcels

Index

requires authentication requires headers

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/predefined_parcels';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
            'search' => 'pizza',
            'page' => '1',
            'per_page' => '3',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/predefined_parcels"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
    "search": "pizza",
    "page": "1",
    "per_page": "3",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
curl -X GET \
-G "https://dev.api.collivery.co.za/v3/predefined_parcels
    ?api_token=OpSjx5TlXGCGkzGAvUOm&search=pizza&page=1&per_page=3
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"

Example response (200):


{
   "data": [
     {
       'product_id': 1,
       'client_id': 1,
       'description': 'Small Pizza Box',
       'length': 20,
       'width': 20,
       'height': 20,
       'weight': 1,
       'deleted': false
     },
     {
       'product_id': 2,
       'client_id': 1,
       'description': 'Medium Pizza Box',
       'length': 30,
       'width': 30,
       'height': 30,
       'weight': 2,
       'deleted': false
     }
   ],
   "links": {
     'first': 'http://collivery.net/api/external/predefined-parcels?page=1',
     'last': 'http://collivery.net/api/external/predefined-parcels?page=1',
     'prev': null,
     'next': null
   },
   "meta": {
     'current_page': 1,
     'from': 1,
     'last_page': 1,
     'path': 'http://collivery.net/api/external/predefined-parcels',
     'per_page': 100,
     'to': 2,
     'total': 2
   }
 }

Request   

GET v3/predefined_parcels

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

search   string  optional    

An optional search string matched against the location types names. Example: pizza

page   string  optional    

Page number to return. Example: 1

per_page   string  optional    

The limit per page. If this option is provided, links and meta will exist in the response with further information about the full list.0 is the same as not limiting. Default is 100. Example: 3

Store

requires authentication requires headers

Save a new Predefined Parcel.

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/predefined_parcels';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
        'json' => [
            'length' => 21.5,
            'width' => 10.0,
            'height' => 5.5,
            'weight' => 5.2,
            'description' => 'Pizza box',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/predefined_parcels"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};

let body = {
    "length": 21.5,
    "width": 10,
    "height": 5.5,
    "weight": 5.2,
    "description": "Pizza box"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl -X POST \
"https://dev.api.collivery.co.za/v3/predefined_parcels
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"                \
                                    -d '{"length":21.5,"width":10,"height":5.5,"weight":5.2,"description":"Pizza box"}'

Example response (500):

Show headers 

cache-control: no-cache, private
content-type: application/json


{
    "message": "Server Error"
}

Request   

POST v3/predefined_parcels

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

Body Parameters

length   number     

The length of the parcel. Values in centimetres. Can be supplied as floats or integers. Example: 21.5

width   number     

The width of the parcel. Values in centimetres. Can be supplied as floats or integers. Example: 10

height   number     

The height of the parcel. Values in centimetres. Can be supplied as floats or integers. Example: 5.5

weight   number     

The weight of the parcel. Values in kilograms. Can be supplied as floats or integers. Example: 5.2

description   string     

The description of the box/parcel. Max 50 characters. Example: Pizza box

Show

requires authentication requires headers

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/predefined_parcels/13900';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/predefined_parcels/13900"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
curl -X GET \
-G "https://dev.api.collivery.co.za/v3/predefined_parcels/13900
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"

Example response (500):

Show headers 

cache-control: no-cache, private
content-type: application/json


{
    "message": "Server Error"
}

Request   

GET v3/predefined_parcels/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

URL Parameters

id   integer  optional    

required. Example: 13900

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

Update

requires authentication requires headers

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/predefined_parcels/13900';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
        'json' => [
            'length' => 21.5,
            'width' => 10.0,
            'height' => 5.5,
            'weight' => 5.2,
            'description' => 'Pizza box',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/predefined_parcels/13900"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};

let body = {
    "length": 21.5,
    "width": 10,
    "height": 5.5,
    "weight": 5.2,
    "description": "Pizza box"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl -X PUT \
"https://dev.api.collivery.co.za/v3/predefined_parcels/13900
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"                \
                                    -d '{"length":21.5,"width":10,"height":5.5,"weight":5.2,"description":"Pizza box"}'

Example response (500):

Show headers 

cache-control: no-cache, private
content-type: application/json


{
    "message": "Server Error"
}

Request   

PUT v3/predefined_parcels/{id}

PATCH v3/predefined_parcels/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

URL Parameters

id   string     

The id Example: 13900

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm

Body Parameters

length   number     

The length of the parcel. Values in centimetres. Can be supplied as floats or integers. Example: 21.5

width   number     

The width of the parcel. Values in centimetres. Can be supplied as floats or integers. Example: 10

height   number     

The height of the parcel. Values in centimetres. Can be supplied as floats or integers. Example: 5.5

weight   number     

The weight of the parcel. Values in kilograms. Can be supplied as floats or integers. Example: 5.2

description   string     

The description of the box/parcel. Max 50 characters. Example: Pizza box

24. Delivery Methods

Show available delivery methods

Index

requires authentication requires headers

Get available delivery methods

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://dev.api.collivery.co.za/v3/delivery_methods';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-App-Name' => 'My Custom App',
            'X-App-Version' => '0.2.1',
            'X-App-Host' => '.NET Framework 4.8',
            'X-App-Lang' => 'C#',
            'X-App-Url' => 'https://example.com',
        ],
        'query' => [
            'api_token' => 'OpSjx5TlXGCGkzGAvUOm',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://dev.api.collivery.co.za/v3/delivery_methods"
);

const params = {
    "api_token": "OpSjx5TlXGCGkzGAvUOm",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-App-Name": "My Custom App",
    "X-App-Version": "0.2.1",
    "X-App-Host": ".NET Framework 4.8",
    "X-App-Lang": "C#",
    "X-App-Url": "https://example.com",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
curl -X GET \
-G "https://dev.api.collivery.co.za/v3/delivery_methods
    ?api_token=OpSjx5TlXGCGkzGAvUOm
    " \
                    -H "Content-Type: application/json"                \
                                -H "Accept: application/json"                \
                                -H "X-App-Name: My Custom App"                \
                                -H "X-App-Version: 0.2.1"                \
                                -H "X-App-Host: .NET Framework 4.8"                \
                                -H "X-App-Lang: C#"                \
                                -H "X-App-Url: https://example.com"

Example response (500):

Show headers 

cache-control: no-cache, private
content-type: application/json


{
    "message": "Server Error"
}

Request   

GET v3/delivery_methods

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

X-App-Name        

Example: My Custom App

X-App-Version        

Example: 0.2.1

X-App-Host        

Example: .NET Framework 4.8

X-App-Lang        

Example: C#

X-App-Url        

Example: https://example.com

Query Parameters

api_token   string     

Authentication key. Example: OpSjx5TlXGCGkzGAvUOm