# Boxme API

## Docs
- [Overview](https://developers.boxme.asia/doc-393601.md): 
- [Getting Started](https://developers.boxme.asia/doc-393238.md): 
- [Authentication](https://developers.boxme.asia/doc-393613.md): 
- [Q&A](https://developers.boxme.asia/doc-496458.md): 
- [Common Errors](https://developers.boxme.asia/doc-393602.md): 
- [API Call Flow](https://developers.boxme.asia/doc-399864.md): 
- [Instant Order Flow](https://developers.boxme.asia/doc-881399.md): 
- [Boxme's RTO and RPO](https://developers.boxme.asia/doc-400943.md): 
- Changelog [Overview](https://developers.boxme.asia/doc-394193.md): 
- Changelog > Order [Create B2C Order Api update 10/05/2024](https://developers.boxme.asia/doc-523492.md): 
- Changelog > Order [Update 21/01/2025](https://developers.boxme.asia/doc-815310.md): 
- Changelog > Order [Update 04/02/2025](https://developers.boxme.asia/doc-834081.md): 
- Changelog > Product [New API update 02/05/2024](https://developers.boxme.asia/doc-514358.md): 
- Changelog > Shipment (ASN) [New API update 02/05/2024](https://developers.boxme.asia/doc-514378.md): 
- Changelog > Webhooks [New Webhooks update 21/05/2024](https://developers.boxme.asia/doc-532893.md): 
- API References [Location](https://developers.boxme.asia/folder-710035.md): 
- API References > Product [Product API Overview](https://developers.boxme.asia/doc-416403.md): 
- API References [Shipment (ASN)](https://developers.boxme.asia/folder-710113.md): 
- API References > Orders [Order API Overview](https://developers.boxme.asia/doc-393944.md): 
- API References > Returns [Returns Flow](https://developers.boxme.asia/doc-400923.md): 
- Webhooks [Overview](https://developers.boxme.asia/doc-393648.md): 
- Webhooks [Webhook events](https://developers.boxme.asia/doc-956701.md): 
- Guidelines [Integration Guide for TikTok Shop FDR](https://developers.boxme.asia/doc-950649.md): 

## API Docs
- API References > Location [Province](https://developers.boxme.asia/api-4888023.md): Use this api to get provinces list by country
- API References > Location [District](https://developers.boxme.asia/api-4888582.md): 
- API References > Location [Sub-district](https://developers.boxme.asia/api-4888583.md): 
- API References > Location [Lookup zipcode](https://developers.boxme.asia/api-4888680.md): 
- API References > Pickup [Get Pickup List](https://developers.boxme.asia/api-5002019.md): Return the list of pick up infomation for requested Seller
- API References > Pickup [Create Pickup Address](https://developers.boxme.asia/api-15849669.md): 
- API References > Pickup [Active / Deactive Pickup](https://developers.boxme.asia/api-16204643.md): 
- API References > Product [Create Product](https://developers.boxme.asia/api-5002021.md): Use this API to create a single new product.
- API References > Product [Get Category Tree](https://developers.boxme.asia/api-5002022.md): Use this API to retrieve the list of all product categories in the system.
- API References > Product [Get Products](https://developers.boxme.asia/api-5002023.md): Use this API to get detailed information of the specified products.
- API References > Product [Get Product Units](https://developers.boxme.asia/api-5032586.md): 
- API References > Product [Deactive Product](https://developers.boxme.asia/api-5002025.md): Use this API to active/deactive selling status
- API References > Product [Update Product](https://developers.boxme.asia/api-5002026.md): Use this API to update attributes or SKUs of an existing product.
- API References > Product [Get Stock Available](https://developers.boxme.asia/api-5166027.md): Get stock detail by batch SKU. Limit access 20 sku.
- API References > Product [Reserved Stock](https://developers.boxme.asia/api-5169888.md): Update reserved stock quantity by warehouse. Limit 20 SKU
- API References > Product [Get Stock Report](https://developers.boxme.asia/api-5282362.md): Get Stock Report (Expiry date, Batch/Lot). 
- API References > Shipment (ASN) [Create Inbound Shipment (ASN)](https://developers.boxme.asia/api-5002029.md): Use API to register ASN to a Boxme warehouse network (Philippines, Thailand, Vietnam...)
- API References > Shipment (ASN) [Cancel ASN](https://developers.boxme.asia/api-5002035.md): Cancel shipment (ASN)
- API References > Shipment (ASN) [Get Shipment Detail](https://developers.boxme.asia/api-5002036.md): Use API to get Shipment detail information included quantity inbound by SKU, Proof of Delivery...
- API References > Shipment (ASN) [Get Receiving Note (GRN)](https://developers.boxme.asia/api-5286407.md): Get Receving Note (GRN) after shipment inbound successfully.
- API References > Shipment (ASN) [Get Inbound Serial List](https://developers.boxme.asia/api-5306460.md): Get Product Serial List by Inbound Shipment
- API References > Shipment (ASN) [Create ASN Booking](https://developers.boxme.asia/api-6615089.md): Schedule a ASN to warehouse based on available timeslot
- API References > Shipment (ASN) [Get ASN Available Timeslot](https://developers.boxme.asia/api-6615091.md): 
- API References > Shipment (ASN) [Cancel ASN Booking](https://developers.boxme.asia/api-6708766.md): 
- API References > Customer [Create B2B Customer](https://developers.boxme.asia/api-5247583.md): Add new b2b customer
- API References > Customer [Get Customer](https://developers.boxme.asia/api-5247588.md): Get list b2b customers (personal/offline/corporate/concession/consignment, ...)
- API References > Customer [Update Customer](https://developers.boxme.asia/api-5284101.md): Update customer based on customer_code. 
- API References > Orders [Get Shipping Option (Fulfillment)](https://developers.boxme.asia/api-4893907.md): Get available shipping options. The options based on coverage area, fufillment by Boxme.
- API References > Orders [Get Shipping Option (Dropship)](https://developers.boxme.asia/api-10467479.md): Get available shipping options. The options based on coverage area, weight and non-fulfillment by Boxme
- API References > Orders [Create B2C Order](https://developers.boxme.asia/api-4893913.md): Create order information.
- API References > Orders [Create Delivery Order](https://developers.boxme.asia/api-5360938.md): Use for create delivery order (non-fulfillment)
- API References > Orders [Create B2B Order](https://developers.boxme.asia/api-5097742.md): B2B orders allow you to create a bulk of items with some special requirements that fit with your business.
- API References > Orders [Update Document](https://developers.boxme.asia/api-4893914.md): 
- API References > Orders [Request Cancel Delivery Order](https://developers.boxme.asia/api-9368222.md): Request cancel delivery after order shipped. The API limited a specific sellers.
- API References > Orders [Cancel Order](https://developers.boxme.asia/api-4893915.md): 
- API References > Orders [Get Order Detail](https://developers.boxme.asia/api-4893991.md): 
- API References > Orders [Get Order List](https://developers.boxme.asia/api-4893994.md): Get Order list by time or status.
- API References > Orders [Get Courier List](https://developers.boxme.asia/api-5266298.md): Get list available courier
- API References > Orders [Get Courier Service](https://developers.boxme.asia/api-5100313.md): 
- API References > Orders [Get Packed Items](https://developers.boxme.asia/api-5154283.md): Get packed item detail by order. The API return packed quantity, expired date, batch/lot. Call API when order status is RTS or higher.
- API References > Orders [Order Pack](https://developers.boxme.asia/api-5231045.md): Use this API to confirm order ready to pack.
- API References > Orders [Get B2B Pickup TimeSlot](https://developers.boxme.asia/api-13244833.md): Use this API to retrieve the list of available pickup slots for B2B orders in case you want to schedule an exact handover for the order.
- API References > Returns [Create Returns Order](https://developers.boxme.asia/api-5002111.md): Use API to create a Returns order to boxme warehouse. 
- API References > Returns [Get Returns Order](https://developers.boxme.asia/api-5002117.md): Use API to get returns order information after finished inbound process  (Quantity accept, Proof of Delivery...)
- API References > Returns [Get Order Returns Receive](https://developers.boxme.asia/api-5363310.md): Get Order Returns Receive. Available when order completed.
- API References > Returns [Cancel Returns Order](https://developers.boxme.asia/api-5002118.md): Cancel returns order.
- API References > Finance [Get COD Statements List](https://developers.boxme.asia/api-5002870.md): Get the list of statements records of the specified date range, which is settled on a daily basis. You can filter the statements based on payment status.
- API References > Finance [Get COD Statement Transactions](https://developers.boxme.asia/api-5002876.md): Get a list of transactions based on statement_id. We will return a list of orders.
- API References > Finance [Get Order Fee](https://developers.boxme.asia/api-5002877.md): This API order fees (fulfillment, shipping...) associated with an order specified by the order ID.
- Webhooks [Shipment (ASN) Status Push](https://developers.boxme.asia/api-5181971.md): Push Shipment(ASN) status change
- Webhooks [Available Stock Change Push](https://developers.boxme.asia/api-9244408.md): This hook is used for self-managed inventory OMS systems. 
- Webhooks [Inventory Change Push](https://developers.boxme.asia/api-5181965.md): Push Inventory change
- Webhooks [Order Status Push](https://developers.boxme.asia/api-5181959.md): Push order status change.
- Webhooks [Product Update Push](https://developers.boxme.asia/api-5181972.md): Push Product status change
- Webhooks [Lazada Direct RTS](https://developers.boxme.asia/api-6243375.md): Implement this hook to avoid PNR issue.
- Webhooks [Sale Invoice Request](https://developers.boxme.asia/api-7188116.md): Requesting the generation of sale invoice in the ERP system.