Comment on page
Basics
- All request should be issued using HTTP protocol
- All request requires authentication
- Content type for responses will always be
application/json
To construct an API request the following components are required.
Component | Description |
The HTTP method | GET. Request data from resourcePOST . Submit data to a resource to process PUT . Update a resource DELETE . Deletes a resource |
The URL to the staging API service | |
The URL to the live API service | |
HTTP request header | Includes the Content-type header with the value application/json |
A JSON request body | required for making a request |
You are advised to make all test request on the staging API and ensure there are no errors before you deploy to users using the live API
This describes the response format for Sendbox API
Sendbox API calls return HTTP status codes in the response headers. API calls also return JSON response bodies that include information about the resource.
Each REST API request returns a success or error HTTP status code.we will talk about errors latter in the docs but for now, we will focus on success.
status code | Description |
200 | A successful GET request |
201 | A successful POST, PUT request means your request is created or updated. |
Fetching data means you will like to retrieve data from a resource. Most times, you are required to set header parameters usually the content-type and the authorization key and make a get request to an endpoint. For example, let say we want to get all shipments, we can simply make a get request and a successful request will come back with a 200 status code and return all the shipments in JSON format.
In this example, we are making a get request to shipment endpoint to fetch all shipments
Request
Response
200: OK
The response body is always in
JSON format. It contains all shipments details {
"next_page": "?page=2",
"prev": null,
"page_by": {
"total": 79,
"pages": 4,
"next": 2,
"per_page": 20,
"prev": null,
"page": 1
},
"print_string": "SELECT shipment.id AS shipment_id, shipment.code AS shipment_code, shipment.reference_code AS shipment_reference_code, shipment.notes AS shipment_notes, shipment.barcode AS shipment_barcode, shipment.awb_no AS shipment_awb_no, shipment.awb_endpoint AS shipment_awb_endpoint, shipment.package_type_code AS shipment_package_type_code, shipment.origin_merchant_id AS shipment_origin_merchant_id, shipment.origin_name AS shipment_origin_name, shipment.origin_phone AS shipment_origin_phone, shipment.origin_email AS shipment_origin_email, shipment.origin_street AS shipment_origin_street, shipment.origin_city AS shipment_origin_city, shipment.origin_city_id AS shipment_origin_city_id, shipment.origin_lat AS shipment_origin_lat, shipment.origin_lng AS shipment_origin_lng, shipment.origin_post_code AS shipment_origin_post_code, shipment.origin_state_code AS shipment_origin_state_code, shipment.origin_country_code AS shipment_origin_country_code, shipment.destination_merchant_id AS shipment_destination_merchant_id, shipment.destination_name AS shipment_destination_name, shipment.destination_phone AS shipment_destination_phone, shipment.destination_email AS shipment_destination_email, shipment.destination_street AS shipment_destination_street, shipment.destination_city AS shipment_destination_city, shipment.destination_lat AS shipment_destination_lat, shipment.destination_lng AS shipment_destination_lng, shipment.destination_post_code AS shipment_destination_post_code, shipment.destination_state_code AS shipment_destination_state_code, shipment.destination_country_code AS shipment_destination_country_code, shipment.time_schedule_code AS shipment_time_schedule_code, shipment.accept_value_on_delivery AS shipment_accept_value_on_delivery, shipment.total_value AS shipment_total_value, shipment.amount_to_receive AS shipment_amount_to_receive, shipment.pickup_eta AS shipment_pickup_eta, shipment.last_dispatch_time AS shipment_last_dispatch_time, shipment.accept_custom_fee AS shipment_accept_custom_fee, shipment.rate_fee AS shipment_rate_fee, shipment.custom_fee AS shipment_custom_fee, shipment.discount_fee AS shipment_discount_fee, shipment.fee AS shipment_fee, shipment.fee_balance AS shipment_fee_balance, shipment.paid AS shipment_paid, shipment.priority_pickup_fee AS shipment_priority_pickup_fee, shipment.discount AS shipment_discount, shipment.vat AS shipment_vat, shipment.fee_payment_status_code AS shipment_fee_payment_status_code, shipment.fee_payment_channel_code AS shipment_fee_payment_channel_code, shipment.pay_on_delivery_method_code AS shipment_pay_on_delivery_method_code, shipment.transaction_code AS shipment_transaction_code, shipment.transaction_id AS shipment_transaction_id, shipment.instruction_code AS shipment_instruction_code, shipment.length AS shipment_length, shipment.width AS shipment_width, shipment.height AS shipment_height, shipment.weight AS shipment_weight, shipment.user_weight AS shipment_user_weight, shipment.quantity AS shipment_quantity, shipment.is_fragile AS shipment_is_fragile, shipment.is_spillable AS shipment_is_spillable, shipment.is_confidential AS shipment_is_confidential, shipment.courier_id AS shipment_courier_id, shipment.agent_id AS shipment_agent_id, shipment.client_id AS shipment_client_id, shipment.merchant_id AS shipment_merchant_id, shipment.channel_code AS shipment_channel_code, shipment.pickup_date AS shipment_pickup_date, shipment.incoming_option_code AS shipment_incoming_option_code, shipment.delivery_type_code AS shipment_delivery_type_code, shipment.delivery_priority_code AS shipment_delivery_priority_code, shipment.payment_option_code AS shipment_payment_option_code, shipment.min_quoted_fee AS shipment_min_quoted_fee, shipment.max_quoted_fee AS shipment_max_quoted_fee, shipment.discount_min_quoted_fee AS shipment_discount_min_quoted_fee, shipment.discount_max_quoted_fee AS shipment_discount_max_quoted_fee, shipment.status_code AS shipment_status_code, shipment.delivery_callback AS shipment_delivery_callback, shipment.finance_callback AS shipment_finance_callback, shipment.selected_courier_id AS shipment_selected_courier_id, shipment.courier_ids AS shipment_courier_ids, shipment.cancel_reason AS shipment_cancel_reason, shipment.billing_code AS shipment_billing_code, shipment.platform_id AS shipment_platform_id, shipment.current_connector_code AS shipment_current_connector_code, shipment.current_awb AS shipment_current_awb, shipment.label_image AS shipment_label_image, shipment.invoice_image AS shipment_invoice_image, shipment.transfer_label_image AS shipment_transfer_label_image, shipment.transfer_invoice_image AS shipment_transfer_invoice_image, shipment.delivery_label_image AS shipment_delivery_label_image, shipment.pickup_number AS shipment_pickup_number, shipment.connector_pickup_schedule_id AS shipment_connector_pickup_schedule_id, shipment.account_type AS shipment_account_type, shipment.test AS shipment_test, shipment.is_first_shipment AS shipment_is_first_shipment, shipment.vehicle_type_code AS shipment_vehicle_type_code, shipment.pickup_code AS shipment_pickup_code, shipment.has_waybill_error AS shipment_has_waybill_error, shipment.waybill_error AS shipment_waybill_error, shipment.escalation_opened AS shipment_escalation_opened, shipment.dispute_opened AS shipment_dispute_opened, shipment.same_day AS shipment_same_day, shipment.fee_before_coupon AS shipment_fee_before_coupon, shipment.coupon_code AS shipment_coupon_code, shipment.coupon_id AS shipment_coupon_id, shipment.released_by_name AS shipment_released_by_name, shipment.released_by_phone AS shipment_released_by_phone, shipment.released_by_signature AS shipment_released_by_signature, shipment.requires_escrow AS shipment_requires_escrow, shipment.target AS shipment_target, shipment.amount AS shipment_amount, shipment.currency_code AS shipment_currency_code, shipment.escrow_reference AS shipment_escrow_reference, shipment.applied_credits AS shipment_applied_credits, shipment.applied_reward AS shipment_applied_reward, shipment.reward_value AS shipment_reward_value, shipment.package_courier_id AS shipment_package_courier_id, shipment.package_agent_id AS shipment_package_agent_id, shipment.package_received_by AS shipment_package_received_by, shipment.package_received_by_phone AS shipment_package_received_by_phone, shipment.package_received_by_signature AS shipment_package_received_by_signature, shipment.package_date_created AS shipment_package_date_created, shipment.package_last_updated AS shipment_package_last_updated, shipment.package_date_received AS shipment_package_date_received, shipment.package_rejection_reason AS shipment_package_rejection_reason, shipment.package_delivery_fee AS shipment_package_delivery_fee, shipment.package_delivery_status_code AS shipment_package_delivery_status_code, shipment.package_fulfilment_status_code AS shipment_package_fulfilment_status_code, shipment.package_delivery_date AS shipment_package_delivery_date, shipment.package_delivery_eta AS shipment_package_delivery_eta, shipment.package_delivery_attempt AS shipment_package_delivery_attempt, shipment.package_label_image AS shipment_package_label_image, shipment.package_invoice_image AS shipment_package_invoice_image, shipment.merchant_direction AS shipment_merchant_direction, shipment.drop_off_location_id AS shipment_drop_off_location_id, shipment.selected_drop_off_location_id AS shipment_selected_drop_off_location_id, shipment.customer_drop_off AS shipment_customer_drop_off, shipment.credits_transaction_id AS shipment_credits_transaction_id, shipment.insurance_option_code AS shipment_insurance_option_code, shipment.insurance_fee AS shipment_insurance_fee, shipment.insurance_value AS shipment_insurance_value, shipment.franchise_id AS shipment_franchise_id, shipment.package_connector_tarrif AS shipment_package_connector_tarrif, shipment.package_connector_discount AS shipment_package_connector_discount, shipment.package_connector_vat AS shipment_package_connector_vat, shipment.package_connector_forwaring_charge AS shipment_package_connector_forwaring_charge, shipment.package_connector_amount_due AS shipment_package_connector_amount_due, shipment.package_connector_weight AS shipment_package_connector_weight, shipment.package_connector_dimension_weight AS shipment_package_connector_dimension_weight, shipment.package_connector_billable_weight AS shipment_package_connector_billable_weight, shipment.package_connector_other_charge AS shipment_package_connector_other_charge, shipment.package_connector_other_charge_reason AS shipment_package_connector_other_charge_reason, shipment.last_updated AS shipment_last_updated, shipment.date_created AS shipment_date_created 
FROM shipment 
WHERE shipment.test != true AND shipment.status_code IN (%(status_code_1)s, %(status_code_2)s, %(status_code_3)s) AND shipment.merchant_id = %(merchant_id_1)s ORDER BY shipment.date_created DESC",
"results": [
{
"destination_contact_phone": "08012345678",
"code": "0006320484",
"status_code": "drafted",
"height": 0,
"time_schedule": {
"code": "anytime",
"name": "Anytime"
},
"amount": null,
"is_spillable": false,
"narration": null,
"owner": "Sendbox",
"destination_address": "20 Oregun Ikeja Ikeja Lagos Nigeria",
"destination_name": "Johnny English",
"incoming_option": {
"code": "pickup",
"name": "Pickup"
},
"payment_options": null,
"origin_city": "Lagos",
"width": 0,
"package_delivery_attempt": 0,
"short_origin_address": "Lagos Lagos Nigeria",
"origin_phone": "0801234567890",
"package_received_by": null,
"destination_city": "Ikeja",
"package_delivery_status_code": null,
"recurrent_cards": [],
"package_label_image": null,
"origin_state": {
"code": "LOS",
"name": "Lagos"
},
"has_waybill_error": false,
"insurance_option_code": null,
"pk": "894688",
"package_invoice_image": null,
"transaction_id": null,
"merchant": {
"username": null,
"email": "[email protected]",
"id": 10383,
"phone": "081234567890",
"name": "John"
},
"delivery_priority": {
"code": "next_day",
"name": "Next Day"
},
"payment_option": {
"code": null,
"name": null
},
"courier": {
"name": "Sixth Gear Logistics"
},
"total_value": 90,
"package_fulfilment_status_code": null,
"origin_address": "20 Old Yaba Road Lagos Lagos Lagos Nigeria",
"package_agent": {
"username": null,
"email": null,
"id": 0,
"phone": null,
"name": null
},
"min_quoted_fee": 1015,
"pickup_attempts": [],
"origin_state_code": "LOS",
"package_type_code": null,
"max_quoted_fee": 1015,
"tracking": {
"destination_country": null,
"status": null,
"origin_city": null,
"destination_city": null,
"origin_name": null,
"destination_name": null,
"current_awb": null,
"origin_country": null
},
"client_id": 0,
"destination_email": "[email protected]",
"origin_contact_phone": "080123456789",
"package_delivery_fee": 0,
"origin_post_code": null,
"coupon_description": null,
"possible_actions": [
{
"code": "pay",
"name": "Pay"
},
{
"code": "cancel",
"name": "Cancel"
}
],
"notes": null,
"current_status": {
"code": "drafted",
"name": "On Hold"
},
"use_selected_rate": null,
"destination_street": "20 Oregun Ikeja",
"package_delivery_date": null,
"reference_code": "74",
"selected_rate_id": null,
"pod": "Prepaid",
"destination_state": {
"code": "LOS",
"name": "Lagos"
},
"shipment_id": null,
"origin_city_id": 1175,
"domain": null,
"package_type": {
"code": null,
"name": null
},
"last_updated": "2019-11-15T14:41:06.185519",
"weight": 0,
"amount_to_receive": 1263.72,
"destination_state_code": "LOS",
"sensitivity": "",
"package_fulfilment_status": {
"code": null,
"name": null
},
"package_delivery_eta": null,
"origin_country": {
"code": "NG",
"name": "Nigeria"
},
"package_courier_id": null,
"delivery_priority_code": "next_day",
"origin_country_code": "NG",
"package_agent_id": 0,
"package_date_received": null,
"package_delivery_status": {
"code": null,
"name": null
},
"has_waybill": null,
"delivery_type_code": "last_mile",
"short_destination_address": "Ikeja Lagos Nigeria",
"pickup_courier": {
"status": null,
"courier_name": null
},HP
Posting data is a little different from fetching data. here you are required to make a post request to the endpoint and pass in a body of JSON data you would like to post. For example, let's say you want to get delivery quotes for a shipment. You simply make a post request to the delivery quotes endpoint this returns a status code 201 and quotes of that shipments in JSON format.
JSON body sample to make a post request
{
"origin_country":"Nigeria",
"origin_country_code":"NG",
"origin_state" : "Lagos",
"destination_country":"Nigeria",
"destination_country_code":" ",
"destination_state": "Abuja",
"weight" : 3,
"destination_state_code":"ABV",
"origin_state_code": "LOS"
}
https://live.sendbox.co/shipping/shipment_delivery_quoteIn this example, we are making a post request to the shipment_delivery_quote endpoint.
Request
Response
Name | Type | Description |
Authorization | String | Authorization-key |
Content-type | String | application/json |
Name | Type | Description |
origin_country | String | senders country |
origin_country_code | String | senders country code |
origin_state | String | senders state |
origin_state_code | String | senders state code |
destination_country | String | recipient country |
destination_country_code | String | recipient country code |
destination_state | String | recipient state |
destination_state_code | String | recipient state code |
weight | float | weight of package |
201: Created
{
"credit_amount": null,
"payment_option": {
"code": null,
"name": null
},
"weight": 8.1,
"total_value": 0,
"destination_state_code": "LOS",
"min_quoted_fee": 1000,
"origin_state_code": "LOS",
"time_schedule_code": "anytime",
"incoming_option_code": "pickup",
"max_quoted_fee": 8783.775,
"delivery_priority_code": "next_day",
"accept_value_on_delivery": null,
"selected_rate": {
"discount": null,
"courier_id": 0,
"fee": null,
"name": null,
"courier": {
"name": null
},
"return_fee": null,
"actual_fee": null,
"fee_with_return": null,
"id": null
},
"origin_country_code": "NG",
"payment_options": [
{
"pk": "book_on_hold",
"brand": "wallet",
"code": "book_on_hold",
"mask": "Book on hold",
"friendly_brand": "You will be debited from your wallet"
}
],
"origin_city": "Ketu",
"total_quantity": 0,
"delivery_type_code": "last_mile",
"payment_option_code": null,
"destination_city": "zone 5",
"destination_country_code": "NG",
"recurrent_cards": [
{
"pk": "book_on_hold",
"brand": "wallet",
"mask": "Book on hold",
"id": null,
"friendly_brand": "You will be debited from your wallet"
}
],
"rates": [
{
"discount": null,
"courier_id": 3,
"fee": 1000,
"name": "Sixth Gear Logistics",
"courier": {
"name": "Sixth Gear Logistics"
},
"return_fee": 50,
"actual_fee": null,
"fee_with_return": 1050,
"id": "3_1000.0"
},
{
"discount": null,
"courier_id": 19,
"fee": 2200,
"name": "Parcel Line Logistics",
"courier": {
"name": "Parcel Line Logistics"
},
"return_fee": 50,
"actual_fee": null,
"fee_with_return": 2250,
"id": "19_2200.0"
},
{
"discount": null,
"courier_id": 20,
"fee": 1800,
"name": "CRS Logistics",
"courier": {
"name": "CRS Logistics"
},
"return_fee": 50,
"actual_fee": null,
"fee_with_return": 1850,
"id": "20_1800.0"
},
{
"discount": null,
"courier_id": 22,
"fee": 8783.775,
"name": "DHL",
"courier": {
"name": "DHL"
},
"return_fee": 0,
"actual_fee": null,
"fee_with_return": null,
"id": "22"
}
],
"selected_rate_id": null,
"use_selected_rate": null,
"vat": null
}
Last modified 3yr ago