{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/orders/unconsolidate.json","auth":"required","results":{"codes":[{"status":200,"language":"json","code":"{  \n   \"order_id\": 40184783,\n   ...\n}","name":""}]},"method":"post","examples":{"codes":[{"code":"curl -X POST https://tophatter.com/merchant_api/v1/orders/unconsolidate.json \\\n-H 'X-ERP-Name: company_name' \\\n-H 'User-Agent: CompanyName/1.0.0' \\\n-d 'access_token=YOUR_ACCESS_TOKEN' \\\n-d 'order_id=40184783'","language":"curl"}]},"settings":"","params":[{"name":"order_id","type":"int","default":"","desc":"The order_id of the order you wish to no longer be consolidated.","required":true,"in":"body","ref":"","_id":"5771d33b92c56c0e00b38167"},{"name":"reason_code","type":"string","default":"","desc":"Optional. Supported values include: ['carrier_rejected_not_allowed', 'carrier_rejected_counterfeit_item', 'carrier_rejected_other', 'seller_request', 'other', 'unknown']","required":false,"in":"body","ref":"","_id":"6037ffa080bb7d003b417ab4"}]},"next":{"description":"","pages":[]},"title":"Unconsolidate an Order","type":"endpoint","slug":"unconsolidate-an-order","excerpt":"Requests an order to no longer be consolidated","body":"Order consolidation isn't generally available, at this time.","updates":[],"order":7,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"6036f26f59ba440057b37cc1","createdAt":"2021-02-25T00:42:23.990Z","user":"567f0baca74a1c0d003e1fba","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"},"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","6036b3ce32fcbe02eb8d7011"],"_id":"567f0c06143cc60d00c1fdc1","__v":10,"createdAt":"2015-12-26T21:52:06.734Z","releaseDate":"2015-12-26T21:52:06.734Z","project":"567f0c06143cc60d00c1fdbe"},"project":"567f0c06143cc60d00c1fdbe","__v":3,"parentDoc":null}

postUnconsolidate an Order

Requests an order to no longer be consolidated

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

order_id:
required
integer
The order_id of the order you wish to no longer be consolidated.
reason_code:
string
Optional. Supported values include: ['carrier_rejected_not_allowed', 'carrier_rejected_counterfeit_item', 'carrier_rejected_other', 'seller_request', 'other', 'unknown']

Examples


Result Format


Documentation

Order consolidation isn't generally available, at this time.