# Introduction
Welcome to Senbox API documentation. These are the live APIs that can be used when integrating with Sendbox.
Sendbox API gives you an all access pass to all Sendbox features.. that you can use on our dashboard and any third-party app you might want to integrate sendbox with.
This API docs walks you through the process of using Sendbox API.
### About Sendbox
Sendbox is a robust software technology that aggregates logistics services on demand. It is truly the all-in-one solution for all your shipping needs, from request to delivery and payments for shipped goods.
With the APIs in this documentation you can integrate Sendbox with your existing infrastructure for seamless service delivery and escrow payment.
# Basics
Sendbox API are HTTP based [RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer) APIs. API request and response format are in JSON.
* All request should be issued using HTTP protocol
* All request requires authentication
* Content type for responses will always be `application/json`
## API Request
To construct an API request the following components are required.
| Component | Description |
| ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| The HTTP method |
GET. Request data from resource
POST . 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 | [https://live.sendbox.co/shipping/](https://api.sendbox.co/shipping/) |
| HTTP request header | Includes the `Content-type` header with the value `application/json` |
| A JSON request body | required for making a request |
{% hint style="info" %}
**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**
{% endhint %}
## API response
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
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.
## Fetch Data
[`https://live.sendbox.co/shipping/shipments` ]()
In this example, we are making a get request to shipment endpoint to fetch all shipments
{% tabs %}
{% tab title="Request" %}
## Headers
| Name | Type | Description |
| ------------- | ------ | ----------------- |
| Authorization | String | Authorization-key |
| Content-type | String | application/json |
| {% endtab %} | | |
{% tab title="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": "Johndoe@gmail.com",
"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": "janedoe@gmail.com",
"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
```
{% endtab %}
{% endtabs %}
## Posting Data
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"
}
```
## Post Data
/shipment\_delivery\_quote
`https://live.sendbox.co/shipping/shipment_delivery_quote`
In this example, we are making a post request to the shipment\_delivery\_quote endpoint.
{% tabs %}
{% tab title="Request" %}
### Headers
| Name | Type | Description |
| ------------- | ------ | ----------------- |
| Authorization | String | Authorization-key |
| Content-type | String | application/json |
### Body Parameters
| 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 |
| {% endtab %} | | |
{% tab title="Response" %}
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
}
```
{% endtab %}
{% endtabs %}
# Errors
Some errors might be encountered after an API request is made and a response is returned.
## Validation Errors
Validation errors occurs when one or more validation rules are not met. For example, not passing a required field in the body of a request this causes a 409 error
`Status code : 409 - Conflict error`
```
{
"required field": [
"error message"
]
}
```
## Authentication Errors
Authentication errors occur when you fail to authenticate a request or pass the correct authentication key or when you pass in an invalid key. For example making a request without an authorization key.
`Status code : 401 - unauthorized`
```
{
"description": "Please provide an auth token as part of the request.",
"title": "Auth token required"
}
```
Another instance of authentication error is making a request with a key that doesn't have permission to perform that request.
`Status code : 403 forbidden`
```
{
"message" :"error message"
}
```
## Other Errors
| Status Code | Description |
| ----------- | --------------------------------------------------------------------------------------------------------------------------- |
| 400 | The request could not be fulfilled because it already exists or is a bad request |
| 404 | The request could not be fulfilled as the request resources does not exist. |
| 500, 501 | This request could not be completed quickly contact Sendbox if you encounter any of these response. it almost never happens |
# Authentication
### **Introduction**
This document provides guidelines on how to authenticate your application with the Sendbox API. This updated version includes streamlined authentication processes and reflects recent changes to the API.
### Getting Started
To integrate with the Sendbox API, you'll need to create an application and obtain an access token, which will be used for all subsequent API requests. Here's how to get started:
{% hint style="info" %}
It is important to note that all development and testing are done on staging. Once completed, remember to update the production URL and follow all the same steps.
[https://developers.sendbox.co/](https://developers.staging.sendbox.co/)
{% endhint %}
channel the request is being made from; in this case set it to api
service_code
String
can be set to either international, nation-wide, and local.
region
String
region the shipment is being shipped from.
custom_options
String
custom options
callback_url
String
a webhook url to get the tracking update.
hts_code
String
pass in the item code to match it's description.
{% endtab %}
{% tab title="Response" %}
201: Created
Create shipment response returns details of the new shipment created. The status code is dependent on available balance in your Sendbox wallet if there is enough money at the time of creating shipment, the wallet is charged and status code is pending but without sufficient balance or empty wallet, status code comes back as drafted.
```json
{
"pickup_date": "2024-08-14 14:00:54.767000",
"has_waybill_error": true,
"selected_courier_id": "65901e2c2291eb2af1f23b4f",
"origin_city": "obanikoro",
"pickup_courier": {},
"code": "0002159289",
"recurrent_cards": [],
"origin_name": "Emotu Balogun",
"delivery_priority": {},
"origin_state": {
"name": "lagos",
"code": "lagos"
},
"package_invoice_image": null,
"destination_state_name": "paris",
"current_status": {
"name": "Book On Hold",
"code": "drafted"
},
"user_id": "66952257b84051001f2a2ace",
"destination_country": {
"name": "FR",
"code": "FR"
},
"date_created": "2024-08-12T17:07:00.072000",
"weight": 2.0,
"paid": 0.0,
"pod": "prepaid",
"destination_state_code": "paris",
"payment_data": {
"checkout_id": "b32b6dbc7e3cf0a44083d252c5948705",
"status": "pending",
"entity_id": null,
"currency": "NGN",
"reference_code": "0002159289",
"payment_source_code": null,
"amount": 33117.0
},
"destination_state": {
"name": "paris",
"code": "paris"
},
"destination_email": "",
"origin_country": {
"name": "NG",
"code": "NG"
},
"origin_state_code": "lagos",
"destination_country_name": "FR",
"items": [
{
"name": "African Wax Fabrics - Orange Lace Fabric that is Not Woven",
"weight": 2.0,
"quantity": 2,
"piece_id": "0002159289-01",
"description": "African Wax Fabrics - Orange Lace Fabric that is Not Woven",
"item_type": {
"name": "snail",
"code": "snail"
},
"value": 1500.0
}
],
"region": "NG",
"status_code": "drafted",
"fee": 33117.0,
"status": {
"name": "Book On Hold",
"code": "drafted"
},
"package_type": {
"weight": 10.0,
"name": "General items",
"description": "Everyday products for various uses."
},
"origin_country_name": "NG",
"possible_actions": [
{
"name": "Pay",
"code": "pay"
},
{
"name": "Cancel",
"code": "cancel"
}
],
"tracking_code": "0002159289",
"amount": 33117.0,
"package_delivery_attempt": 0,
"_id": "66ba41348f1bd40039f8f38a",
"origin_email": null,
"insurance_option_code": "standard",
"origin_state_name": "lagos",
"origin_street": "10 Olasheun Crescent",
"last_updated": "2024-08-12T17:07:07.214271",
"incoming_option": {
"name": null,
"code": null
},
"id": "66ba41348f1bd40039f8f38a",
"merchant": {
"name": "Love Quinn",
"email": "sales@quinn.com",
"phone": "+19400080111"
},
"pk": "66ba41348f1bd40039f8f38a",
"package_connector_other_charge": 0.0,
"destination_city": "paris",
"date_booked": "2024-08-12T17:07:00.072000",
"origin_phone": "+2348006660419",
"destination_name": "Forty Quinn",
"current_awb": null,
"courier": {
"name": ""
},
"origin_country_code": "NG",
"destination_phone": "+12672306531",
"destination_street": "31 Hall Crescent",
"max_quoted_fee": 33117.0,
"selected_courier": "65901e2c2291eb2af1f23b4f",
"min_quoted_fee": 33117.0,
"waybill_error": "Insufficient item description. Please update to continue",
"courier_id": "64f020fcf040ba4b3c1697e9",
"destination_country_code": "FR",
"quantity": 1.0,
"total_value": 1500.0
}
```
{% endtab %}
{% endtabs %}
### Payload Explained
While some of the payloads are self explained, lets go over some of them that seem a bit confusing.
#### channel\_code
This tells us where the request came from this case it's form the api.
#### Items
This is an array of objects. It includes the name of what you are shipping, weight, item\_type\_code, package\_size\_code, a value which is the total price of the item(s) you are shipping, and quantity of your shipment. An example of an items payload will look like this
```
"items": [
{
"name": "Laptop",
"item_type_code": "other",
"hts_code": "9001.10",
"package_size_code": "medium",
"quantity": 2,
"weight": 3,
"value":120000
}
]
```
#### Callback\_url
This should be a webhook url which you will pass with your other request shipment payloads. Sendbox will post tracking updates to this url from pending, processing and completed.
### Fund your staging account
To stimulate a successful request on your staging account you have to fund your staging account by making a post to add\_money endpoint
{% embed url="" %}
{% tabs %}
{% tab title="Request" %}
```json
{
"amount": 10000
}
```
{% endtab %}
{% tab title="Response" %}
```json
{
"status": "successful"
}
```
{% endtab %}
{% endtabs %}
### Check your staging account balance
You can simply do this by doing a get to the staging payment profile
### Stimulate webhooks events
You can stimulate webhook events for tracking status on staging by sending tracking code to move\_tracking endpoint
```
{
code:
}
```
# Calculate Landed Cost
This endpoint calculates the total landed cost of a shipment. To retrieve the landed cost, send a POST request to the landed cost endpoint using the same payload as required for the [create shipment request.](/shipping/create-new-shipment) This will return the full breakdown of costs, including taxes, duties, and shipping fees, providing an accurate total cost for the shipment.
## API Reference
`POST`
**Headers**
| Name | Value |
| ------------- | ------------------- |
| Content-Type | `application/json` |
| Authorization | authorization-token |
**Body**
| Name | Type | Description |
| ---------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| origin | object | Senders details |
| destination | object | Recipient details |
| weight | float | Weight of package |
| items | array |
An array of objects that contain:
- name \[String]
- weight \[Float]
- item\_type\_code \[String optional]
- hts\_code \[String optional]
- description \[String]
- quantity \[Integer]
- value \[Float]
|
| incoming\_option | string | set to either pickup or dropoff |
| pickup\_date | date | date in ISO format |
| total\_value | float | value of shipment |
| service\_code | string | can be set to either international, nation-wide, or local. |
| package\_type | string | package type |
| channel\_code | string | channel the request is being made from; in this case set it to api |
| region | string | region the shipment is being shipped from. |
| callback\_url | string | a webhook url to get the tracking update. |
| hts\_code | string | pass in the item code to match it's description. |
**Response**
{% tabs %}
{% tab title="200" %}
```json
{
"customs_option": "sender",
"dimension": {
"length": 1.0,
"width": 1.0,
"height": 1.0
},
"incoming_option": "pickup",
"estimate": {
"code": "duties_and_taxes",
"name": "Duties and taxes",
"description": "import duties and taxes",
"value": 18.93,
"breakdown": [
{
"code": "duties",
"name": "Duties",
"description": "",
"value": 0.0
},
{
"code": "taxes",
"name": "Taxes",
"description": "",
"value": 12.22
},
{
"code": "fees",
"name": "Fees",
"description": "",
"value": 6.71
}
],
"exchange_rate": 1669.025
},
"weight": 0.2,
"currency": "NGN",
"service_code": "standard",
"origin": {
"country": "NG",
"lat": 6.56,
"post_code": "102216",
"first_name": "Emotu",
"state": "abuja",
"city": "maitama",
"lng": 3.37
},
"destination": {
"country": "GB",
"lat": 37.81,
"post_code": "94612",
"first_name": "Ubani",
"state": "london",
"city": "london",
"last_name": "Balogun",
"lng": -122.27
},
"items": [
{
"name": "African Wax Fabrics - Orange Lace Fabric that is Not Woven",
"item_type": "herbal_tea",
"value": 100000.0,
"quantity": 4,
"weight": 0.5,
"hts_code": "1211.90.8980",
"disclaim": true
}
],
"service_type": "international",
"total_value": 100000.0,
"pickup_date": "2023-07-20T07:17:10.582Z",
"package_type": "general",
"region": "NG",
"instance_id": "6136dfa6a1ab9d318bcfcb94",
"user_id": "61f3f297f0bb8f001a8a34e0",
"entity_id": null
}
```
{% endtab %}
{% endtabs %}
# Tracking Shipment
Tracking a shipment requires you make a post request to the tracking endpoint, passing the shipment tracking number in the body of your request.
## Track Shipment
[`https://live.sendbox.co/shipping/tracking`](https://api.sendbox.co/shipping/tracking)
This tracks a shipment
{% tabs %}
{% tab title="Request" %}
## Headers
| Name | Type | Description |
| ------------- | ------ | ----------------- |
| Authorization | String | Authorization-key |
| Content-type | String | application/json |
## Body Parameters
| Name | Type | Description |
| ------------ | ------ | ---------------------- |
| code | String | shipment tracking code |
| {% endtab %} | | |
{% tab title="Response" %}
201: Created
This returns the details of a shipment and tracking events.
```
{
"status": {
"code": "delivered",
"name": "Delivered"
},
"code": "0008927630",
"last_updated": "2019-11-13T21:07:59.605566",
"courier": {
"name": "DHL"
},
"amount_to_receive": 5000,
"status_code": "delivered",
"sensitivity": null,
"reference_code": null,
"origin_state_code": "LOS",
"agent": {
"name": "DHL BOT"
},
"delivery_eta": "2019-11-09T23:59:59.976552",
"is_spillable": false,
"destination_name": "Paul Chukelu",
"destination_address": "512 Cobblestone Creek, Mableton, Georgia, Mableton Georgia United States Of America",
"origin_country_code": "NG",
"id": 51196,
"origin_country": {
"code": "NG",
"name": "Nigeria"
},
"is_confidential": false,
"short_destination_address": "Mableton Georgia United States Of America",
"origin_name": "Looks Like A Good Man",
"short_origin_address": "Anthony Lagos Nigeria",
"total_value": 5000,
"accept_value_on_delivery": false,
"origin_state": {
"code": "LOS",
"name": "Lagos"
},
"notes": null,
"origin_address": "71 Adebayo Mokuolu Street, New Castle Anthony Lagos Nigeria",
"date_created": "2019-11-08T16:50:17.044031",
"is_fragile": false,
"pickup_date": "2019-11-08T16:50:15.026374",
"events": [
{
"status": {
"code": "delivered",
"name": "Delivered"
},
"last_updated": "2019-11-13T21:08:00.685932",
"description": "package was delivered succesfully",
"courier": {
"name": "DHL"
},
"status_code": "delivered",
"previous_status": {
"code": "in_delivery",
"name": "In Delivery"
},
"tracking_code": "0008927630",
"delivery_eta": null,
"delivery_status": {
"code": null,
"name": null
},
"previous_status_code": "in_delivery",
"current_courier": {
"name": "DHL"
},
"location_description": "GA-US",
"delivery_status_code": null,
"date_created": "2019-11-13T21:08:00.685940"
}Staging URL: https://sandbox.staging.sendbox.co/shipping/tracking
```
{% endtab %}
{% endtabs %}
```
Staging URL: https://sandbox.staging.sendbox.co/shipping/tracking
```
### Tracking Response
At different times, there are different tracking status in the payload. Sendbox allows you track your shipment in real-time.
{% hint style="danger" %}
### Book on hold
This means the shipment hasn't been paid for. User might need to fund their account to complete their shipment request. it comes back with `code:"drafted"` as the status code in the response.
{% endhint %}
{% hint style="info" %}
### Pending
This means the shipment request was successful and is waiting to be picked up. comes back with code:"pending" as the status code in the response.
{% endhint %}
{% hint style="info" %}
### Pick up started
This means shipment has been picked up. comes back with `code:"pickup_started"` as the status code in the response.
{% endhint %}
{% hint style="info" %}
### Pick up completed
This means the pick up process has been completed. comes back with `code:"pickup_completed`" in the status code response.
{% endhint %}
{% hint style="info" %}
### Delivery Started
This means the delivery process has started. comes back with `code:in_delivery` in the status code response.
{% endhint %}
{% hint style="info" %}
### In Transit
This means delivery is in transit and it's updated in real-time. Comes back with `code:"in_transit"` as the status code in the response.
{% endhint %}
{% hint style="success" %}
### Delivered
This means the entire process has been completed and the shipment has been delivered. Comes back with `code:"deliverd"` as the status code in the response.
{% endhint %}
# Saved Addresses
Sendbox gives you access to user's saved addresses so you can easily get addresses used before that are saved. Make a request to saved address endpoint and pass in right header parameters.
[`https://live.sendbox.co/auth/addresses`](https://api.sendbox.co/auth/addresses)``
{% tabs %}
{% tab title="Request" %}
### Headers
| Name | Type | Description |
| ------------- | ------ | ----------------- |
| Authorization | String | Authorization-Key |
| Content-Type | String | application/json |
| {% endtab %} | | |
{% tab title="Response" %}
```
{
"count": 4,
"page_by": {
"next_page": null,
"prev_page": null,
"per_page": 20,
"total": 4,
"page": 1,
"pages": 1
},
"filter_by": {},
"query": null,
"view": null,
"results": [
{
"city": "Atlantis",
"post_code": null,
"user_id": "5d373bdb9ec77c00347719a0",
"name": "Jill",
"country": {
"code": "BD",
"name": "Bangladesh",
"is_shipment_origin": false,
"phone_code": null,
"enabled": true,
"requires_post_code": true,
"pk": "BD",
"slug": "bangladesh"
},
"phone": "+8809000000000",
"state": {
"pk": "BD_C",
"code": "BD_C",
"slug": "dhaka",
"country_code": "BD",
"name": "Dhaka"
},
"street": "Killua",
"address": "Jill- Killua Atlantis Dhaka Bangladesh",
"lat": null,
"pk": "5e3c45ca2a73f100393b868d",
"lng": null,
"_id": "5e3c45ca2a73f100393b868d",
"email": "Jill@sad.com"
},
{
"city": "Atlantis",
"post_code": null,
"user_id": "5d373bdb9ec77c00347719a0",
"name": "Ajill",
"country": {
"code": "BB",
"name": "Barbados",
"is_shipment_origin": false,
"phone_code": null,
"enabled": true,
"requires_post_code": null,
"pk": "BB",
"slug": "barbados"
},
"phone": "+109000000000",
"state": {
"pk": "BB_C",
"code": "BB_C",
"slug": "bridgetown",
"country_code": "BB",
"name": "Bridgetown"
},
"street": "Asem",
"address": "Ajill- Asem Atlantis Bridgetown Barbados",
"lat": null,
"pk": "5e3c45472f66b20049a825e6",
"lng": null,
"_id": "5e3c45472f66b20049a825e6",
"email": "Ajioll@sem.com"
},
{
"city": "lagos",
"post_code": null,
"user_id": "5d373bdb9ec77c00347719a0",
"name": "kalia",
"country": {
"code": "NG",
"name": "Nigeria",
"is_shipment_origin": false,
"phone_code": null,
"enabled": true,
"requires_post_code": null,
"pk": "NG",
"slug": "nigeria"
},
"phone": "+2349068772897",
"state": {
"pk": "LOS",
"code": "LOS",
"slug": "lagos",
"country_code": "NG",
"name": "Lagos"
},
"street": "sango",
"address": "kalia- sango lagos Lagos Nigeria",
"lat": null,
"pk": "5e3c3fbe71129b0041a36851",
"lng": null,
"_id": "5e3c3fbe71129b0041a36851",
"email": "jill@jack.gmail.com"
},
{
"city": "Ikeja",
"post_code": null,
"user_id": "5d373bdb9ec77c00347719a0",
"name": "Jason",
"country": {
"code": "NG",
"name": "Nigeria",
"is_shipment_origin": false,
"phone_code": null,
"enabled": true,
"requires_post_code": null,
"pk": "NG",
"slug": "nigeria"
},
"phone": "+2349083551998",
"state": {
"pk": "LOS",
"code": "LOS",
"slug": "lagos",
"country_code": "NG",
"name": "Lagos"
},
"street": "62 Old Yaba Road ",
"address": "Jason- 62 Old Yaba RoadIkeja Lagos Nigeria",
"lat": null,
"pk": "5dde412d2907a20040505426",
"lng": null,
"_id": "5dde412d2907a20040505426",
"email": null
}
],
"sort_by": [
{
"asc_desc": "descending",
"order_by": "date_created"
}
]
}
```
{% endtab %}
{% endtabs %}
# Introduction
You can seamlessly integrate Sendbox payment into your infrastructure. Your customers can have virtual accounts, fund their wallet and check their wallet balance.
# Payment Profile
To get payment profile, you make a get request to the payment profile endpoint and pass the required header parameters to get the appropriate response.
### Get Payment Profile
[`https://live.sendbox.co/payments/profile`](https://api.sendbox.co/payments/profile)
{% tabs %}
{% tab title="Request" %}
### Headers
| Name | Type | Description |
| ------------- | ------ | ----------------- |
| Authorization | String | Authorization-Key |
| Content-Type | String | application/json |
| {% endtab %} | | |
{% tab title="Response" %}
200:OK
```
{
"username": "jason@sendbox.ng",
"user_id": "5d373bdb9ec77c00347719a0",
"last_updated": "2020-03-20T15:15:17.408000+00:00",
"name": "Testing Roundabout Name Change",
"phone": "+2348087612345",
"credits_account": {
"balance": 0.0,
"currency": "NGN",
"key": "C0008157332",
"pk": "5d373bdbe4b32c00014eae48",
"_id": "5d373bdbe4b32c00014eae48",
"type": {
"pk": "credits",
"code": "credits",
"name": "Credits"
}
},
"bvn": null,
"funds": 38.0,
"escrow": 75.0,
"credits": 0.0,
"email": "jason@sendbox.ng",
"accounts": [
{
"balance": 75.0,
"currency": "NGN",
"key": "E0016700165",
"pk": "5d373bdbe4b32c00014eae47",
"_id": "5d373bdbe4b32c00014eae47",
"type": {
"pk": "escrow",
"code": "escrow",
"name": "Escrow"
}
},
{
"balance": 0.0,
"currency": "NGN",
"key": "C0008157332",
"pk": "5d373bdbe4b32c00014eae48",
"_id": "5d373bdbe4b32c00014eae48",
"type": {
"pk": "credits",
"code": "credits",
"name": "Credits"
}
},
{
"balance": 38.0,
"currency": "NGN",
"key": "F0006107729",
"pk": "5d373bdbe4b32c00014eae49",
"_id": "5d373bdbe4b32c00014eae49",
"type": {
"pk": "funds",
"code": "funds",
"name": "Funds"
}
}
],
"date_created": "2019-07-23T16:54:51.718000+00:00",
"virtual_bank_accounts": [
{
"bank_name": "Providus Bank",
"last_updated": "2019-11-27T16:42:37.305000+00:00",
"account_number": "9907710812",
"date_created": "2019-11-27T16:42:37.305000+00:00",
"pk": "vba_3gMbhPJLJVc",
"account_name": " KIKO JAYSON"
}
],
"_id": "5d373bdbe4b32c00014eae46",
"funds_account": {
"balance": 38.0,
"currency": "NGN",
"key": "F0006107729",
"pk": "5d373bdbe4b32c00014eae49",
"_id": "5d373bdbe4b32c00014eae49",
"type": {
"pk": "funds",
"code": "funds",
"name": "Funds"
}
},
"escrow_account": {
"balance": 75.0,
"currency": "NGN",
"key": "E0016700165",
"pk": "5d373bdbe4b32c00014eae47",
"_id": "5d373bdbe4b32c00014eae47",
"type": {
"pk": "escrow",
"code": "escrow",
"name": "Escrow"
}
}
}
```
{% endtab %}
{% endtabs %}
# Virtual Account
To get virtual account, you need to make a request to virtual account endpoint ensure to pass the required header parameters to get the right response.
### Get Virtual Account
[`https://live.sendbox.co/payments/virtual_accounts`](https://api.sendbox.co/payments/virtual_accounts)
{% tabs %}
{% tab title="Request" %}
### Headers
| Name | Type | Description |
| ------------- | ------ | ----------------- |
| Authorization | String | Authorization-Key |
| Content-Type | String | application/json |
| {% endtab %} | | |
{% tab title="Response" %}
200:OK
```
{
"count": 1,
"page_by": {
"next_page": null,
"prev_page": null,
"per_page": 20,
"total": 1,
"page": 1,
"pages": 0
},
"filter_by": {},
"query": null,
"view": null,
"results": [
{
"bank_name": "Providus Bank",
"last_updated": "2019-11-27T16:42:37.305000+00:00",
"account_number": "9907710812",
"date_created": "2019-11-27T16:42:37.305000+00:00",
"pk": "vba_3gMbhPJLJVc",
"account_name": " KIKO JAYSON"
}
],
"sort_by": [
{
"asc_desc": "descending",
"order_by": "date_created"
}
]
}
```
{% endtab %}
{% endtabs %}
# WooCommerce Plugin
Easily integrate woo-commerce sendbox-shipping plugin into your WordPress site.
## Requirements
> Sendbox Shipping plugin is a woo-commerce plugin. For it to work ensure you have woocommerce installed on your WordPress site.
## Installation Process
> WordPress allows two types of installation process manual installation and automatic installation. Following any of the process will get you up and running.
### Manual Installation
1. Download **Sendbox Shipping** plugin from [WordPress.org](https://wordpress.org/plugins/sendbox-shipping/) plugin directory.
2. Go to your WordPress Dashboard and click on **Plugins** > **Add New** to access the plugin installation screen.
3. Then click on **Upload** to access the plugin upload page
4. Find the downloaded zip file name **sendbox-shipping.zip** and select it.
5. Click on the **Install Now** button to run the install.
6. Once the plugin is successfully installed, click on **Activate** to activate the plugin.
Yaay 😃 your plugin has been activated successfully enjoy!
### Automatic Installation
1. Go to your WordPress Dashboard and click on **Plugins**>**Add New** to access the plugin installation screen.
2. Navigate to the search input and type **sendbox-shipping** select the result of your search and click on **Install Now**
3. Once the plugin is sucessfully installed, click on **Activate** to activate the plugin.
Now you are good to go!
## Configuration
> After your plugin has been sucessfully installed and activated, you have to do some configuration in the plugin settings following thesse simple steps below can you get started.
### Settings and Access Token
Go to your WordPress admin panel and navigate to woo-commerce settings. \
Click on **Settings** to display woo-commerce settings page.
\
Now navigate to **Shipping** and click on it to display woo commerce shipping page settings. \
You will notice **Sendbox Shipping** as one of the shipping settings. click on this to display Sendbox shipping settings page.
This page prompts you to input your access token and other required keys. This enables you to connect to Sendbox. \
To get these keys login to [Sendbox](https://developers.sendbox.co/) create an account. Then proceed to add a new app and fill in your site details.
If your access token is valid, the settings input fields are displayed. \
Your name, email and phone number are auto filled for you from your Sendbox profile. \
Your city and street are gotten from your woocommerce store details settings. \
Select the state where your store is located \
Select if you want your orders to be picked up or you will drop it off. \
Select if you want maximum or minimum rate fees from Sendbox. \
Input extra fess if you want to add to Sendbox shipping fees and make extra money from shipping. Leave at 0 if you are not interested. \
Then click on snyc changes and finally save changes.
### Shipping Zones.
Once your settings have been successfully saved, you click on shipping zones on your woo commerce settings to display shipping zones settings screen. \
In your shipping zones settings, you select areas you will like to ship to and then add sendbox shipping as a shipping method.
## Getting shipping quotes
> Sendbox shipping quotes come in maximum and minimum rates so you decide which you want to display to your customers in the settings.
Now shipping quotes is displayed to your customer anytime they enter their shipping address.
## Setting weight of product.
It is important to set weight of your product when uploading products that you are going to ship with Sendbox on woo commerce to get the accurate shipping fees.
## Request Shipment
> Requesting a new shipment is very easy. Follow the steps below to see how you can make a new shipping request from your store to Sendbox.
1. Navigate to woo commerce order to display order page.
2. click on the order you want to ship with Sendbox. This displays your specific order with their shipping details
3. On the right side of your dashboard you will find ship with Sendbox meta box.
4. Then click on select a courier to choose from any Sendbox courier partners. \
If you are satisfied with the shipping fee, you can now click on the request shipment button.
### Tracking code
Your order page is refreshed and your tracking code is displayed in your custom field with name wooss\_tracking\_code. \
You can login to [Sendbox](https://m.sendbox.co/tracking) and track your order with this code.
### Updating order status
Sendbox-shipping plugin automatically updates your status order. \
It updates from on hold to processing and then completed. \
Be sure to set your woo commerce to auto emailing your customers so each time an order status is updated your customers are notified.
## Errors
> Some of the errors you might face using this plugin and how you can fix them.
* If you don't get a tracking code after clicking on request shipment, rather you get an alert message saying cannot request shipment at this time please login to your Sendbox and top up your wallet. This means that you have insufficient funds in your Sendbox wallet and you need to login to your Sendbox account and top up your wallet.
* Not setting the correct weight of your products when uploading them can return an inaccurate shipping fee. ensure the accurate weight of the product is set to get correct shipping fee.
* If you try to request shipment and you don’t get any courier service kindly check your internet connection and refresh the page.
# Opencart Extension
Easily integrate sendbox shipping with your opencart ecommerce site.
## Requirements
Sendbox opencart extension requires a current version of opencart from 3.0 upwards it uses override engine which will be installed with your extension.
## Installation Process
To install, download the extension from opencart extension directory and unzip you will find an admin, catalog and system folder copy these folders and paste in your store root directory.
## Settings Page
Once you have successfully installed, go to extensions on your admin dashboard, click on shipping and then select sendbox shipping.
## Sendbox Settings
This part is very important so ensure you follow the instructions carefully so your extension can work. On this page, you will find a webhook url. Go to sendbox and register this url and then you will be given an app Id and a client secret on your sendbox dashboard.
Copy this app\_id and client secret and paste it in their respective fields then click on save once this is done, a connect to sendbox button is displayed.
Click on this button and you will be redirected to sendbox here you will be prompted to login once this is done, you will be redirected back to your store dashboard.
Now the settings page will be fully loaded. Fill the remaining fields like state, city, set the status to enabled and sort order to 1 and finally save. now your customer can ship with sendbox.
## Ship with Sendbox
Back on your admin dashboard, you will see a ship with sendbox. to ship, select a courier service and then click on the request shipment button and you will receive a message that your shipment is successful.
# Shopify
# Magento
Easily Integrate Sendbox shipping extension to your magneto store.
### Installation Process
Go to magneto marketplace and search for sendbox shipping module and download it, follow the instructions and install it on your site.
### Settings
To set up this module, login to your admin dashboard, navigate to stores then click on carriers you will see sendbox shipping as a shipping method. toggle down, copy the web-hook URL and go paste it on Sendbox this will create your app id and client secret copy these keys and come back to your admin dashboard and paste them in their respectively fields. fill in your remaining details and then click on connect the connect to Sendbox button this will authenticate you on the Sendbox platform. This step is very important and shouldn't be missed as it is the only way to ensure your extension works properly.
### Get shipping quotes
You don't need to do anything special for this to work. the extension automatically sends an API request and displays shipping quotes in the front for the customers.
### Requesting Shipment
This is done solely by you. Navigate to order page, click on the order you will like to ship and scroll to ship with sendbox part on the dashboard. select a courier of your choice, and click on ship request shipment button.
# WooCommerce
This page covers integrating Sendbox webhooks with WooCommerce store.
### Prerequisites
The following are required to integrate Sendbox webhooks:
1. Current [WooCommerce](https://wordpress.org/plugins/woocommerce/) Version
2. An active WooCommerce store URL
3. A [Sendbox business](https://business.sendbox.co) dashboard account.
### Authentication
For the integration to work, you must allow Sendbox to have webhooks on your store.
This leads us to connect your store to Sendbox. To connect your store, you will provide your store URL, and in return, Sendbox will give you an OAuth URL. When you paste this URL directly into a web browser, a popup will appear asking you to authorize permissions.
WooCommerce Permissions Screen
Once permissions are granted, Sendbox webhooks are automatically created on your store's WooCommerce admin dashboard.
### Import Products and Orders
During the OAuth flow, your already existing products and orders will automatically be imported to the Sendbox business dashboard.
### Create Product
The create product webhook will be triggered once a new product is created on your WooCommerce dashboard. This means that the product information will be automatically sent to Sendbox and will simultaneously be created on your Sendbox business dashboard as well.
### Create Order
The create order webhook will be triggered once a new order request is made on your store.
This means the order information will be sent to Sendbox and the fulfillment process for that order will commence from packaging to delivery.
### Order Notification
As the status of the order changes, the order webhook is once again trigged and automatically it updates the order status from pending to completed.
# WooCommerce
This page covers WooCommerce webhooks intergations.
### Prerequisites
The following are required to get sendbox webhooks set up on your WooCommerce store.
1. The current version of [WooCommerce](https://wordpress.org/plugins/woocommerce/)
2. An active WooCommerce store URL
3. A [Sendbox business](https://business.sendbox.co) dashboard account.
### Authentication
For this integration process, you must authenticate your store with Sendbox.
To do this, you will send your store URL, and a full authentication URL will be provided for you by Sendbox. Copy this URL and paste it on the web, then go ahead and approve the permissions automatically, Sendbox webhooks will be added to your WooCommerce dashboard.
