{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/orders/fulfill.json","auth":"required","examples":{"codes":[{"language":"curl","code":"curl -X POST https://tophatter.com/merchant_api/v1/orders/fulfill.json \\\n-d 'access_token=YOUR_ACCESS_TOKEN' \\\n-d 'order_id=1035509247' \\\n-d 'carrier=USPS' \\\n-d 'tracking_number=9400111899562173406594'"}]},"method":"post","params":[{"name":"order_id","type":"int","default":"","desc":"The order_id of the order you wish to fulfill.","required":true,"in":"body","ref":"","_id":"56a9f7f4f834950d0037b411"},{"name":"carrier","type":"string","default":"","desc":"The carrier (USPS, China EMS, etc) used to ship this order. The list of accepted carriers can be found [here](doc:carriers).","required":true,"in":"body","ref":"","_id":"56a9f7f4f834950d0037b410"},{"name":"tracking_number","type":"string","default":"","desc":"The tracking number provided by the carrier when this order was shipped.","required":true,"in":"body","ref":"","_id":"56a9f7f4f834950d0037b40f"},{"name":"service_type","type":"string","default":"Varies by carrier","desc":"The granularity of tracking updates the carrier will provide for this tracking number. The list of supported service types per carrier can be found [here](doc:carrier-service-types). The full set of service types can be found [here](doc:service-types).","required":false,"in":"body","ref":"","_id":"5f2dd424b1c330004e7b3040"}],"results":{"codes":[{"code":"{\n  \"order_id\": 1035509247,\n  \"status\": \"shipped\",\n  \"carrier\": \"usps\",\n  \"tracking_number\": \"9400111899562173406594\"\n  ...\n}","language":"json","status":200,"name":""}]},"settings":""},"next":{"description":"","pages":[]},"title":"Fulfill an Order","type":"endpoint","slug":"order-fulfill","excerpt":"","body":"","updates":["5b440ddf3d5b29000349859b"],"order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56a9926bf834950d0037b381","user":"567f0baca74a1c0d003e1fba","parentDoc":null,"__v":13,"createdAt":"2016-01-28T04:00:43.894Z","editedParams2":true,"githubsync":"","category":{"sync":{"isSync":false,"url":""},"pages":["56a99246318e6c1700a19d06","56a9924c257fbc0d00d4763a","56a9926bf834950d0037b381","56a99273257fbc0d00d4763c","56a992863b04f20d00ecca87","56a9928df834950d0037b383","56a992aff834950d0037b385","56a992d413a69a0d00a778de","56a9f82aca491e0d00eb8b12","56a9f959257fbc0d00d476c2"],"title":"Orders","slug":"orders","order":3,"from_sync":false,"reference":false,"_id":"56a9783b2d8fd90d0036eed6","version":"567f0c06143cc60d00c1fdc1","__v":10,"createdAt":"2016-01-28T02:08:59.138Z","project":"567f0c06143cc60d00c1fdbe"},"editedParams":true,"project":"567f0c06143cc60d00c1fdbe","version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["567f0c07143cc60d00c1fdc2","56a9783109cb9c0d00f0c7d3","56a97837f834950d0037b363","56a9783b2d8fd90d0036eed6","56a979912d8fd90d0036eed8","5834b5691a80690f00d31faf","5834b5e4f775120f00c45f9d","5bf1a1473031e4005075ae14","5c64c200244bda003204b97f"],"_id":"567f0c06143cc60d00c1fdc1","__v":9,"createdAt":"2015-12-26T21:52:06.734Z","releaseDate":"2015-12-26T21:52:06.734Z","project":"567f0c06143cc60d00c1fdbe"}}

postFulfill an Order


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

order_id:
required
integer
The order_id of the order you wish to fulfill.
carrier:
required
string
The carrier (USPS, China EMS, etc) used to ship this order. The list of accepted carriers can be found [here](doc:carriers).
tracking_number:
required
string
The tracking number provided by the carrier when this order was shipped.
service_type:
stringVaries by carrier
The granularity of tracking updates the carrier will provide for this tracking number. The list of supported service types per carrier can be found [here](doc:carrier-service-types). The full set of service types can be found [here](doc:service-types).

Examples


Result Format