Inbound Service include APIs to support customer inbound their inventory into the TNSL warehouse network. The big picture below debrief the full flow of Inbound process:
Service Actions
The following operations are included in the Fulfillment Inbound Shipment API section:
| Operation Name | Operation Description | API Documentation |
| Get Inbound Guidance | Returns inbound guidance for a list of items by SKUs. Guidance includes: 1. List of accepted quantity for each SKUs 2. Timeslot which is available to deliver / pickup shipments | Documentation |
| Get Available Inbound Warehouses | Return list available warehouses for customer to inbound their products. | Documentation |
| Create Inbound Shipment | Create an inbound shipment to inbound customer inventory to TNSL Fulfillment Center. | Documentation |
| Get Label Of Inbound Shipment | Return the label that would place on the inbound shipment to helps TNSL Inbound staff correct receive & inbound packages. | Documentation |
| List Inbound Shipments | List all available inbound shipments of customer. | Documentation |
| Get Inbound Shipment Detail | Detail information of an inbound shipment of customer. | Documentation |
| Cancel Inbound Shipment | Cancel an inbound shipment of customer. | Documentation |
Terminology
The following table defines terminology for this API section:
| Term | Definition |
| Inbound Guidance | Set of guidances to helps customer prepare inbound packages properly & schedule the delivery / pickup of shipment. Guidance includes 2 important information: 1. List of accepted quantity for each SKUs 2. Timeslots which is available to deliver / pickup shipments |
| Inbound Warehouse | The warehouse in TNSL network which is available to receive the inbound shipment. |
| Inbound Shipment | Presents for an request generated from customer to inbound a set of SKUs to TNSL logistics network. |
| Inbound Shipping Plan | Available shipping plan to ship the inbound shipment to fulfillment centers. Currrently there are two available shipping plan: – SELF_DELIVERY: Customer deliver packages to inbound warehouse on the selected timeslots. – CARRIER_PICKUP: TNSL pickup the packages from customer’s store on selected timeslots, deliver to inbound warehouse. |
| Shipment Labels | The labels generated by Inbound systems & must place on inbound packages. There are two types of label: shipping & inbound labels. These label used by shipping & inbound staff to detect & properly inbound the packages. |
Inbound Shipment Statuses
| Status | Definition |
|---|---|
| CANCELED | IS was canceled by customer or system |
| COMPLETED | IS was completed |
| COMPLETED_PARTIALLY | IS was rejected a part of shipment |
| FAILED | IS was failed by business logic |
| IMPORTED_PARTAILLY | Items was imported partially and waiting for other items |
| NEW | IS(inbound shipment) was received by FSI |
| REJECTED | Items in shipment was rejected |
| WAITING_FOR_ITEMS | IS was created at ERP, and waiting for items |
API Response Code
| Code | Definition | Shipment Status Mapping |
|---|---|---|
| WARD_CODE_NOT_EXIST | ward_tiki_code không tồn tại | NOT CREATED |
| WARD_CODE_NOT_FOUND | Ward tiki code không tìm thấy | NOT CREATED |
| WARD_CODE_WRONG_TYPE | Ward tiki code không hợp lệ | NOT CREATED |
| SKU_NOT_FOUND | SKU không tìm thấy | NOT CREATED |
| INVALID_WAREHOUSE | Warehouse code không hợp lệ | FAILED |
| INVALID_INPUT | Input không hợp lệ | NOT CREATED |
| EXCEPTION | Server hiện đang có lỗi | FAILED |
| UNAVAILABLE_TIMESLOT | Thời gian giao hàng không còn khả dụng | FAILED |
| SALE_ORDER_NOT_FOUND | Sale order code không tìm thấy | FAILED |
| SELLER_NOT_FOUND | Seller không tìm thấy | FAILED |
| EXCEED_ACCEPTABLE_QUANTITY | Số lượng sản phẩm vượt quá mức cho phép | FAILED |
| FAILED_TO_CREATE_INBOUND | Tạo inbound shipment không thành công | FAILED |
| SKU_INVALID_INVENTORY_FORM | Dạng tồn kho của sku không đúng | FAILED |
| SKU_NOT_BELONG_TO_SELLER | Sku không thuộc về seller | FAILED |
| SKU_NOT_ALLOW | Kho không cho nhập SKU (bulky/non bulky) | FAILED |
| SKU_WRONG_BIZ_TYPE | SKU(s) wrong biz type | FAILED |
| INVALID_INBOUND_SHIPMENT_ID | Inbound Shipment id không hợp lệ | NOT CREATED |
| HTTP_CLIENT_FAILED_CONNECTION | Kết nối service nội bộ thất bại | NOT CREATED |
| INVALID_INPUT_BODY_EMPTY | body không thể bỏ trống | NOT CREATED |