Acknowledgement API Reference
When an order is completed with being processed on the Commerce Platform (fraud checks, remorse period, ...), its state is automatically changed to CREATED. Acknowledging an order confirms that you have moved the order into your Order Management System and are ready to fulfill it. Acknowledging an order changes its state to IN_PROGRESS.
By default, your shop is configured to automatically move orders to the IN_PROGRESS state when finalized. To enable order acknowledgement, you must first associate your shop with your app. This one-time operation is recommended if you are planning to fulfill orders using the API, and will leave finalized orders in the CREATED state until you acknowledge them.
Associate Commerce Seller Settings with Your App
To manage orders via API, an app must first be associated with the commerce seller settings representing your shop. This action only needs to be performed once, and instructs the Commerce Platform to leave finalized orders in the CREATED state for you to acknowledge.
curl -X POST \
-F 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/{cms-id}/order_management_appsPOST /{cms-id}/order_management_apps HTTP/1.1
Host: graph.facebook.com/* PHP SDK v5.0.0 */
/* make the API call */
try {
// Returns a `Facebook\FacebookResponse` object
$response = $fb->post(
'/{cms-id}/order_management_apps',
array (),
'{access-token}'
);
} catch(Facebook\Exceptions\FacebookResponseException $e) {
echo 'Graph returned an error: ' . $e->getMessage();
exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
echo 'Facebook SDK returned an error: ' . $e->getMessage();
exit;
}
$graphNode = $response->getGraphNode();
/* handle the result *//* make the API call */
FB.api(
"/{cms-id}/order_management_apps",
"POST",
function (response) {
if (response && !response.error) {
/* handle the result */
}
}
);The token here is PAGE_ACCESS_TOKEN
Request
| Attribute | Description |
|---|---|
Type: string | Commerce seller settings ID for the page that you want to extract orders. You can find |
Sample Response
{
"success": true
}Acknowledge One Order
Acknowledge one specific order that was retrieved using the List Orders API. This action marks the order as IN_PROGRESS, and can be filtered out from future pulls.
Be sure to capture errors, take action according to the error messages, and retry accordingly. Do not start processing orders in your systems that have not been successfully acknowledged.
curl -X POST \
-F 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/{order-id}/acknowledge_orderPOST /{order-id}/acknowledge_order HTTP/1.1
Host: graph.facebook.com/* PHP SDK v5.0.0 */
/* make the API call */
try {
// Returns a `Facebook\FacebookResponse` object
$response = $fb->post(
'/{order-id}/acknowledge_order',
array (),
'{access-token}'
);
} catch(Facebook\Exceptions\FacebookResponseException $e) {
echo 'Graph returned an error: ' . $e->getMessage();
exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
echo 'Facebook SDK returned an error: ' . $e->getMessage();
exit;
}
$graphNode = $response->getGraphNode();
/* handle the result *//* make the API call */
FB.api(
"/{order-id}/acknowledge_order",
"POST",
function (response) {
if (response && !response.error) {
/* handle the result */
}
}
);The token here is PAGE_ACCESS_TOKEN
Request
| Attribute | Description |
|---|---|
Type: string | Optional ID representing the order in your order management system. |
Type: string | Required Unique key per request |
Sample Request
{
"idempotency_key": "cb090e84-e75a-9a34-45d3-5163bec88b65",
"merchant_order_reference": "external_order-id-1"
}Sample Response
{
"id": "64000841784004",
"state": "IN_PROGRESS"
}Acknowledge Multiple Orders
Acknowledge order batches have a maximum of 100 orders per batch.
Acknowledge orders that were received by the List Orders API, in a batch. This action marks orders as IN_PROGRESS, and can be filtered out from future pulls.
curl -X POST \
-F 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/{page-id}/acknowledge_ordersPOST /{page-id}/acknowledge_orders HTTP/1.1
Host: graph.facebook.com/* PHP SDK v5.0.0 */
/* make the API call */
try {
// Returns a `Facebook\FacebookResponse` object
$response = $fb->post(
'/{page-id}/acknowledge_orders',
array (),
'{access-token}'
);
} catch(Facebook\Exceptions\FacebookResponseException $e) {
echo 'Graph returned an error: ' . $e->getMessage();
exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
echo 'Facebook SDK returned an error: ' . $e->getMessage();
exit;
}
$graphNode = $response->getGraphNode();
/* handle the result *//* make the API call */
FB.api(
"/{page-id}/acknowledge_orders",
"POST",
function (response) {
if (response && !response.error) {
/* handle the result */
}
}
);The token here is PAGE_ACCESS_TOKEN
Request
| Attribute | Description |
|---|---|
| Required Array of 100 or less order IDs. |
Type: string | Required Unique key per request |
order_id object
| Attribute | Description |
|---|---|
Type: string | Required ID of the order. |
Type: string | Optional ID representing the order in your order management system |
You can Acknowledge multiple orders in one request. If few orders were in FB_PROCESSING state, then you cannot ACK them and receive a coded exception. Retrying these requests with same idempotency key returns the same result. When you get a coded exception, please use new idempotency key and retry.
Sample Request
{
"idempotency_key": "cb090e84-e75a-9a34-45d3-5163bec88b65",
"orders": [
{
"id": "64000841790004"
},
{
"id": "10100677592885259"
}
]
}Response
| Attribute | Description |
|---|---|
Type: | Array of order ID and order state. |
order_id_and_state object
| Attribute | Description |
|---|---|
Type: string | ID of the order. |
Type: | Order state. |
Sample Response
{
"orders": [
{
"id": "64000841790004",
"state": "IN_PROGRESS"
},
{
"id": "10100677592885259",
"error": {
"error_code": 2361003,
"error_message": "Invalid Order ID"
}
}
]
}