Service requests
Apply and track value-added services on a package (inbound) or shipment (outbound).
Availability: Sandbox / Gateway MOCK is live.
| Method | Path | Scope | Purpose |
|---|---|---|---|
| POST | /v1/fulfillment/service-requests | shipment:create | Create Service Requests |
| GET | /v1/fulfillment/service-requests | warehouse:read | List Service Requests |
| GET | /v1/fulfillment/service-requests/{id} | warehouse:read | Get Service Request |
| POST | /v1/fulfillment/service-requests/{id}/confirm | shipment:create | Confirm Service Request |
IDs: svc_*. Statuses: PENDING · AWAITING_CONFIRMATION · PROCESSING · COMPLETED · FAILED · CANCELLED.
List filters
GET /v1/fulfillment/service-requests query parameters:
| Param | Notes |
|---|---|
resource_type | PACKAGE | SHIPMENT |
resource_id | Exact match (e.g. pkg_*, shipment id) |
service_code | Exact VAS CODE (normalized to uppercase) |
stage | INBOUND | OUTBOUND |
status | Multi: PENDING,COMPLETED or repeated status= |
created_from / created_to | Filter by created_at (ISO-8601) |
page / page_size | Default 1 / 20, max page_size 100 |
Detail GET …/service-requests/{id} has no filters — lookup by id only.
Create Service Requests
Requests one or more value-added services for a warehouse package or shipment. Each requested service is created as an independent service request.
Batch create is atomic (validate all, then create all). Stage is derived from resource_type (PACKAGE→INBOUND, SHIPMENT→OUTBOUND). Mismatched codes → VALUE_ADDED_SERVICE_INVALID_STAGE.
Pricing is snapshotted at create time from the current VAS catalog.
Get Service Request
Returns the current status, pricing and execution result of a value-added service request, including photos, videos or inspection results when available.
Confirm
For quoted fees (AWAITING_CONFIRMATION): send { "fee_amount", "currency" } matching current pricing.amount. Idempotent when already confirmed.
Sandbox
svc_photo_completed · svc_inspection_failed · svc_video_processing · svc_reinforce_pending · svc_wooden_awaiting (¥35)
Related
Get Support
Need integration help? Contact Developer Support at support@hiobuy.com · Response within 1–2 business days