Miravia Open Platform
Note:DBS (Delivery By Seller) feature is not available to all sellers.Only open to some sellers or brands
This tutorial will show you how to identify DBS type orders and use the Miravia fulfillment API to ship them.
The flow of API calls
1. Get OrderID and OrderItemID of new order
You can use GetOrders to retrieve a list of new orders and the order details. With Order ID of new order, you can use GetOrderItems to retrieve the product information of the order.
Response example (GetOrderItems)
{ "data": [ { "order_item_id": 33247176004, "order_id": 33247076004, "status": "pending", "warehouse_code": "dropshipping", "shipping_type": "Dropshipping", "created_at": "2022-08-01 14:47:30 +0800", "delivery_option_sof": 1, "updated_at": "2022-08-01 14:48:46 +0800", "currency": "EUR", "shipping_provider_type": "seller_own_fleet". } ], "code": "0", "request_id": "21038f5516593373640451144" }
Tips :
- Check the "delivery_option_sof" field in the response of GetOrderItems to confirm whether the item can be shipped using the DBS method, if the value of 1 means that the order item can be shipped in the DBS method, if the value is 0, the process cannot be used.
- Use the “CreatedAfter” parameter to filter newly created orders.
- Use the “Limit” and “Offset” parameters to set the number of orders returned.
- Save the order IDs.
2. Packaged orders
Use the order item ids and order ids obtained in the first step to call the Pack API to pack the order item ids into a package.
Request example
{ "pack_order_list": [ { "order_item_list": [ 33247176004,33247176005 ], "order_id": 33247076004 } ], "delivery_type": "dropship", "shipping_allocate_type": "TFS" }
Response example
{ "result": { "data": { "pack_order_list": [ { "order_item_list": [ { "order_item_id": 33247176004, "item_err_code": "0", "tracking_number": "SOF_33247076004", "shipment_provider": "Delivered by Seller", "package_id": "FP0900221001", "retry": false }, { "order_item_id": 33247176005, "item_err_code": "0", "tracking_number": "SOF_33247076004", "shipment_provider": "Delivered by Seller", "package_id": "FP0900221001", "retry": false } ], "order_id": 33247076004 } ] }, "success": true }, "code": "0", "request_id": "21038f5516593376367631145" }
Tips :
- Please fill in the shipping_allocate_type field with TFS.
- The delivery_type field can only be filled with dropship.
- DBS type orders do not require the "shipping_provider_code" field in this step, so please do not use this field.
3. Get shipping provider and Tracking number
You would need to call GetDBSShipmentProviders API to get the DBS shipping provider list to update the actual shipping provider of each parcel. Because you use the DBS method of shipping, the Miravia system will not automatically sense your package information.
Request example
{"sellerId":4000000176001}
Tips :
- You can call the GetSeller API to get the seller id
Response example
{ "result": { "data": { "shipment_providers": [ { "name": "Correos EXPRESS", "provider_code": "DBSSP100000016" }, { "name": "SF3", "provider_code": "DBSSP100000009" } ] }, "success": true }, "code": "0", "request_id": "211b500616593381296471086" }
Tips :
- This response is only an example, the actual result is based on the actual response from the API. The shipment provider of response may increase or decrease over time.
DBSShipmentProviders List
Note: This list is for reference only, please refer to the GetDBSShipmentProviders API response for the specific DBSShipmentProviders available.
Logistic name Tracking number rules Tracking number SampleSample Tracking inf.Link Correos EXPRESS ^([0-9]{16}|[0-9]{23})$ eg.32300041720095701420026 https://s.correosexpress.com/SeguimientoSinCP/search;jsessionid=UB6X2jZ4t2Aequ9T1DZ5OSkjNSItC2NOoJAq8Dz2.seguimientosincp-cex-677dc6d959-k778q SEUR ^([0-9]{7}|[0-9]{10}|[0-9]{11}|[0-9]{12}|[0-9]{13}|[0-9]{14}|[0-9]{6}[a-zA-Z]{3}|[0-9]{6}[a-zA-Z]{5})$ eg.11090140105784 https://www.seur.com/es/ GLS(Inc.ASM) ^([0-9]{14})$ eg.31306552116360 https://www.gls-spain.es/es/recibir-paquetes/seguimiento-envio/ MRW ^([0-9a-zA-Z]{12})$ eg.004003013617 https://www.mrw.es/seguimiento_envios/MRW_seguimiento_envios.asp Paqueteria Correos ^([a-zA-Z]{2}[0-9a-zA-Z]{4}[0-9]{9}[a-zA-Z]{1}|[a-zA-Z]{2}[0-9a-zA-Z]{4}[0-9]{16}[a-zA-Z]{1})$ eg.PK79W40200000040118329P https://www.correos.es/es/es/herramientas/localizador/envios ICP ^([a-zA-Z]{2}[0-9]{8})$ eg.AE17852042 DHL ^([0-9]{10}|[a-zA-Z]{2}[0-9]{18}|[a-zA-Z]{3}[0-9]{20})$ eg.JD014600008628708223 https://www.dhl.com/es-es/home.html https://www.dhl.com/es-es/home/seguimiento/etiqueta-de-identificacion.html UPS ^([0-9a-zA-Z]{18}|[0-9]{12}|[0-9a-zA-Z]{11}|[0-9]{9})$ eg.1Z0Y5W886897381391 https://www.ups.com/track?loc=es_ES&requester=ST/ https://www.ups.com/es/es/tracking/help/tracking/tnh.page TIPSA ^([0-9]{22})$ eg. 0460180460184000123998 https://www.etip-sa.com/localiza-envio ENVIALIA ^([0-9]{16})$ eg.0028960125448269 https://www.envialia.com/seguimiento/ NACEX ^([0-9a-zA-Z]{36})$ https://www.nacex.es/recargarPagina.do?pagina=0 ZELERIS ^([0-9a-zA-Z]{18})$ eg.1AE54180045223101W https://www.zeleris.com/busqueda-envio.aspx CTT EXPRESS ^[0-9]{22}|[0-9a-zA-Z]{13}$ https://www.cttexpress.com/home/index Others
4. Update shipping provider and Tracking number
Call the UpdateTrackingInfo API to upload your actual tracking number and shipping provider.
Request example
{ "update_packages": [ { "tracking_number": "9356463170722110", "package_id": "FP0900221001", "shipment_provider_code": "DBSSP100000016" } ] }
Tips :
- The package id can be obtained by checking the response of the second step or by calling GetOrderItems API
Response example
{ "result": { "data": { "packages": [ { "item_err_code": "0", "package_id": "FP0900221001", "retry": false } ] }, "success": true }, "code": "0", "request_id": "211b500616593388491761088" }
5. Set the order to RTS(Ready to ship) status
Call ReadyToShip API to update the order to RTS status.
Request example
{"packages":[{"package_id":"FP0900221001"}]}
Tips :
- The package id can be obtained by checking the response of the second step or by calling GetOrderItems.
- Once the order status is updated to RTS, the order will not be cancelled.
- This API can be called only after the third step is completed.
Response example
{ "result": { "data": { "packages": [ { "item_err_code": "0", "package_id": "FP0900221001", "retry": false } ] }, "success": true }, "code": "0", "request_id": "211b500616593408382921092" }
6. Set the order to delivery or failed delivery status.
After your shipping provider have delivered the DBS parcels and buyers have accepted them , then you need to trigger parcels as delivered status through ConfirmDeliveryForDBS API .
If your shipping provider fail delivery the DBS parcels , then you need to trigger the parcels as failed delivered stauts through FailedDeliveryForDBS API.
Request example
{"packages":[{"package_id":"FP0900221001"}]}
Response example
{ "result": { "data": { "packages": [ { "item_err_code": "0", "package_id": "FP0900221001", "retry": false } ] }, "success": true }, "code": "0", "request_id": "211b500616593408382921092" }
Tips :
- After calling the ConfirmDeliveryForDBS API, the order will be updated to shipped status and will be automatically updated to delivered status after 7 days.
- This operation is not reversible, so please be careful calling these two APIs.
- When using ConfirmDeliveryForDBS or FailedDeliveryForDBS calls, if the following error is returned "Package logistics information is tracked by ARISE and cannot be updated manually!" ,the reason is that: If our platform can identify the tracking number and can track it,in order to make the logistics status more accurate, then the platform will not allow you to delivered and the platform will update the order status based on the tracking number. Which can be understood as follows:
DBS parcels,
-if the platform can not track logistics information, it can be delivered or failed deliveried by seller themselves.
-if the platform can track logistics information, it can not be delivered or failed deliveried by seller themselves.
