Endpoints
POST
Create shipment
Register a new pickup request. Called by Shop.mn whenever a vendor confirms an order that requires PickPack delivery.
POSThttps://pickpack.api.demo.mn/pickpack/v1/shipments
Request body#
order_idrequiredstring
The Shop.mn order identifier this shipment is for. Returned in all webhook events tied to this shipment.
vendor_idrequiredstring
The Shop.mn vendor that is shipping the parcel.
pickup_addressrequiredobject
The address PickPack should collect the parcel from. See the Address object below.
delivery_addressrequiredobject
The customer-facing delivery destination.
parcelrequiredobject
Physical dimensions and weight of the parcel.
service_leveloptionalenum
Default:
standardDelivery speed tier requested by the vendor.
standardexpresssame_daycash_on_deliveryoptionalobject
Optional COD instructions. Include
amount and currency when present.metadataoptionalobject
Arbitrary key-value pairs Shop.mn attaches for its own tracking. Returned verbatim on every webhook.
The Address object#
Used for both pickup_address and delivery_address.
namerequiredstring
Contact name at this address.
phonerequiredstring
Contact phone in E.164 format (e.g. +97699112233).
line1requiredstring
Street address line 1.
line2optionalstring
Apartment, door code, or extra delivery hint.
districtrequiredstring
District (дүүрэг) name.
cityrequiredstring
City name. Defaults to "Ulaanbaatar".
latoptionalnumber
Latitude of the pin, if the vendor or customer dropped one.
lngoptionalnumber
Longitude of the pin.
Response#
Returns the newly created Shipment object on success with HTTP 201 Created.
idrequiredstring
PickPack shipment ID. Use this on all subsequent webhook events.
statusrequiredenum
Initial status — always `created` on success.
createdtracking_numberrequiredstring
Human-friendly tracking number shown to the end customer.
estimated_pickup_atrequiredtimestamp
ISO 8601 UTC timestamp of expected courier pickup.
label_urloptionalstring
Pre-signed URL to a PDF shipping label, valid for 24 hours.
created_atrequiredtimestamp
ISO 8601 UTC timestamp of resource creation.
Use Idempotency-Key
Always send an
Idempotency-Key header on this endpoint. A network retry without one can create a duplicate shipment for the same order.Phone format
All phone numbers must be in E.164 format. Requests with locally-formatted Mongolian numbers (e.g.
99112233) are rejected with 422 Unprocessable Entity.