Table of Contents
List Fulfilment Couriers
List Fulfilment Clients
List Fulfilment Cancellations
List Fulfilment Cancellations Billing
List Fulfilment Client Pick Rates
List Fulfilment Courier Billing
List Fulfilment Invoicing
List Fulfilment Picking Billing
List Fulfilment Processing
List Fulfilment Receiving
List Fulfilment Storage Billing
List Fulfilment Couriers
By specifying a client ID, you can retreive all couriers that have been assigned to said client.
Endpoint: https://YOUR-ACCOUNT-NAME.despatchcloud.co.uk/ws/v1/wsfulfilment/list_fulfilment_couriers
Method: GET
Filters are specified at the end of the URL like so: ?{{key}}={{value}}&{{key}}={{value}}
Filter | Description |
---|---|
client_id | ID of the client. Will show all clients if not specified. |
Example Response:
[
{
"id": "1",
"client_id": "0001",
"service_id": "1",
"service_price": "1.00",
"packaging_price": "1.00"
}
]
List Fulfilment Clients
Here you can receive a list of all of your fulfilment clients.
Endpoint: https://YOUR-ACCOUNT-NAME.despatchcloud.co.uk/ws/v1/wsfulfilment/list_fulfilment_clients
Method: GET
Example Response:
[
{
"id": "0001",
"name": "Demo Company Ltd",
"address_line_one": "Fake Street",
"address_line_two": "",
"city": "Fakeville",
"county": "",
"country": "United Kingdomm",
"contact_email": "[email protected]",
"billing_email": "[email protected]",
"phone": "01234567890",
"software_cost": "100.00",
"management_cost": "0.00",
"deleted": "0",
"storage_box_qty": "1",
"storage_box_price": "1.0000",
"storage_shelf_qty": "1",
"storage_shelf_price": "1.0000",
"storage_pick_pallet_qty": "1",
"storage_pick_pallet_price": "1.0000",
"storage_bulk_pallet_qty": "1",
"storage_bulk_pallet_price": "1.0000",
"receiving_box_price": "1.00",
"receiving_pallet_min_price": "1.00",
"label_processing_price": "1.00",
"promotional_material_price": "1.00",
"sort_bypass_item_qty": "1",
"management_price": "1.00",
"notes": "",
"accounts_id": "12345",
"hub_url": "https://example.despatchcloud.co.uk"
}
]
List Fulfilment Cancellations
By specifying a date, you can list any cancelled fulfilments.
Endpoint: https://YOUR-ACCOUNT-NAME.despatchcloud.co.uk/ws/v1/wsfulfilment/list_fulfilment_cancellations
Method: GET
Filters are specified at the end of the URL like so: ?{{key}}={{value}}&{{key}}={{value}}
Filter | Description |
---|---|
date | Date of the cancelled fulfilments, formatted YYYY-MM-DD |
page | Page number of your query. Will default to 1 if not specified. |
limit | How many results per page. Will default to 100 if not specified. |
Example Response:
[
{
"id": "1",
"order_id": "0001-1565942799-16",
"order_status": "8",
"date": "1566001013",
"status": "2"
},
{
"id": "2",
"order_id": "0001-1565942799-16",
"order_status": "8",
"date": "1566001069",
"status": "2"
}
]
List Fulfilment Cancellations Billing
By specifying a date, you can list any cancelled fulfilments.
Endpoint: https://YOUR-ACCOUNT-NAME.despatchcloud.co.uk/ws/v1/wsfulfilment/list_fulfilment_cancellations_billing
Method: GET
Filters are specified at the end of the URL like so: ?{{key}}={{value}}&{{key}}={{value}}
Filter | Description |
---|---|
client_id | ID of the client. Will show all clients if not specified. |
date | Date of the cancelled fulfilments, formatted YYYY-MM-DD. Will show all dates if not specified. |
page | Page number of your query. Will default to 1 if not specified. |
limit | How many results per page. Will default to 100 if not specified. |
Example Response:
[
{
"id": 1,
"client_id": "0001",
"order_id": "0001-1565942799-16",
"price": "4.50",
"date": "1566001069",
"status": 2,
"invoice_id": "INV-1566001069"
}
]
List Fulfilment Client Pick Rates
By specifying a client ID, you can list the pick rate(s) for the client.
Endpoint: https://YOUR-ACCOUNT-NAME.despatchcloud.co.uk/ws/v1/wsfulfilment/list_fulfilment_client_pick_rates?client_id={{client_id}}
Method: GET
Example Response:
[
{
"id": "1",
"client_id": "0001",
"rate_name": "Basic Rate",
"min_items": "1",
"max_items": "5",
"rate_price": "1.00"
}
]
List Fulfilment Courier Billing
By specifying the client ID, you can list what shipments the client has booked, as well as what has been charged to said client.
Endpoint: https://YOUR-ACCOUNT-NAME.despatchcloud.co.uk/ws/v1/wsfulfilment/list_fulfilment_courier_billing
Method: GET
Filters are specified at the end of the URL like so: ?{{key}}={{value}}&{{key}}={{value}}
Filter | Description |
---|---|
client_id | ID of the client. Will show all clients if not specified. |
status | Status ID of the shipment. Will show all statuses if not specified. |
date | Date of the cancelled fulfilments, formatted YYYY-MM-DD. Will show all dates if not specified. |
page | Page number of your query. Will default to 1 if not specified. |
limit | How many results per page. Will default to 100 if not specified. |
Example Response:
[
{
"id": 1,
"client_id": "0001",
"order_id": "0001-1565964885-38",
"service": "Courier Next Day",
"pieces": 1,
"service_price": "3.50",
"packaging_price": "1.23",
"date": 1565964885,
"despatch_date": 565965996,
"status": 5,
"invoice_id": "INV-1566814057"
}
]
List Fulfilment Invoicing
By specifying a client ID, you can obtain any invoices for said client.
Endpoint: https://YOUR-ACCOUNT-NAME.despatchcloud.co.uk/ws/v1/wsfulfilment/list_fulfilment_invoicing
Method: GET
Filters are specified at the end of the URL like so: ?{{key}}={{value}}&{{key}}={{value}}
Filter | Description |
---|---|
client_id | ID of the client. Will show all clients if not specified. |
status | Status ID of the shipment. Will show all statuses if not specified. |
date | Date of the cancelled fulfilments, formatted YYYY-MM-DD. Will show all dates if not specified. |
page | Page number of your query. Will default to 1 if not specified. |
limit | How many results per page. Will default to 100 if not specified. |
Example Response:
To be obtained
List Fulfilment Picking Billing
By specifying the client ID, you can get the billing for the client's picking.
Endpoint: https://YOUR-ACCOUNT-NAME.despatchcloud.co.uk/ws/v1/wsfulfilment/list_fulfilment_picking_billing
Method: GET
Filters are specified at the end of the URL like so: ?{{key}}={{value}}&{{key}}={{value}}
Filter | Description |
---|---|
client_id | ID of the client. Will show all clients if not specified. |
status | Status ID of the shipment. Will show all statuses if not specified. |
date | Date of the cancelled fulfilments, formatted YYYY-MM-DD. Will show all dates if not specified. |
page | Page number of your query. Will default to 1 if not specified. |
limit | How many results per page. Will default to 100 if not specified. |
Example Response:
To be obtained
List Fulfilment Processing
By specifying a client ID, you can list any fulfilments processing.
Endpoint: https://YOUR-ACCOUNT-NAME.despatchcloud.co.uk/ws/v1/wsfulfilment/list_fulfilment_processing
Method: GET
Filters are specified at the end of the URL like so: ?{{key}}={{value}}&{{key}}={{value}}
Filter | Description |
---|---|
client_id | ID of the client. Will show all clients if not specified. |
status | Status ID of the shipment. Will show all statuses if not specified. |
date | Date of the cancelled fulfilments, formatted YYYY-MM-DD. Will show all dates if not specified. |
page | Page number of your query. Will default to 1 if not specified. |
limit | How many results per page. Will default to 100 if not specified. |
Example Response:
To be obtained
List Fulfilment Receiving
By specifying a client ID, you can list any fulfilments processing.
Endpoint: https://YOUR-ACCOUNT-NAME.despatchcloud.co.uk/ws/v1/wsfulfilment/list_fulfilment_receiving
Method: GET
Filters are specified at the end of the URL like so: ?{{key}}={{value}}&{{key}}={{value}}
Filter | Description |
---|---|
client_id | ID of the client. Will show all clients if not specified. |
status | Status ID of the shipment. Will show all statuses if not specified. |
date | Date of the cancelled fulfilments, formatted YYYY-MM-DD. Will show all dates if not specified. |
page | Page number of your query. Will default to 1 if not specified. |
limit | How many results per page. Will default to 100 if not specified. |
Example Response:
To be obtained
List Fulfilment Storage Billing
By specifying a client ID, you can return any billing for storage.
Endpoint: https://YOUR-ACCOUNT-NAME.despatchcloud.co.uk/ws/v1/wsfulfilment/list_fulfilment_storage_billing
Method: GET
Filters are specified at the end of the URL like so: ?{{key}}={{value}}&{{key}}={{value}}
Filter | Description |
---|---|
client_id | ID of the client. Will show all clients if not specified. |
status | Status ID of the shipment. Will show all statuses if not specified. |
date | Date of the cancelled fulfilments, formatted YYYY-MM-DD. Will show all dates if not specified. |
page | Page number of your query. Will default to 1 if not specified. |
limit | How many results per page. Will default to 100 if not specified. |
Example Response:
To be obtained