Order API Reference

Use this API to list orders, retrieve details about an order or products. In this section:

• List Orders
• Get Order Details
• List Order Items
• Get Product Details

List Orders

List all the commerce orders associated with a Shop. By default this endpoint returns orders in CREATED state unless state parameter is specified. The response only returns default fields, unless you request additional fields explicitly. Refer to the samples for more information.

curl -X GET -G \
  -d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v25.0/<CMS_ID>/commerce_orders

Request

order_state

order_filter

Response

order object

order_status object

selected_shipping_option object

shipping_address object

estimated_payment_details object

subtotal_details object

currency_amount object

estimated_shipping_time object

buyer_details object

Sample Request (default fields)

• Get Orders with status CREATED and filters with no shipments AND no cancellations with default fields in the response.

curl -X GET -G \
  -d 'fields="estimated_payment_details"' \
  -d 'updated_after=1529718360' \
  -d 'state="CREATED"' \
  -d 'filters="no_shipments,no_cancellations"' \
  -d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v25.0/<CMS_ID>/commerce_orders

Sample Response (default fields)

{
  "data": [
    {
      "id": "335211597203390",
      "order_status": {
        "state": "CREATED"
      },
      "created": "2019-01-14T19:17:31+00:00",
      "last_updated": "2019-01-14T19:47:35+00:00"
    },
    {
      "id": "2247696628885631",
      "order_status": {
        "state": "CREATED"
      },
      "created": "2019-01-11T22:56:04+00:00",
      "last_updated": "2019-01-11T23:26:18+00:00"
    },
    {
      "id": "64000005580968",
      "order_status": {
        "state": "CREATED"
      },
      "created": "2018-09-27T04:25:57+00:00",
      "last_updated": "2018-09-27T04:26:14+00:00"
    },
    // ... 25 more orders if present
  ],
  "paging": {
    "cursors": {
      "before": "--sanitized_key--",
      "after": "--sanitized_key--"
    },
    "next": "https://graph.facebook.com/vX.X/<cms-id>/commerce_orders?access_token=--sanitized_key--&pretty=0&limit=25&after=--sanitized_key--"
  }
}

Sample Request to fetch orders between two dates (default fields)

• Get Orders between dates by using updated_after and updated_before

curl -X GET -G \
  -d 'updated_before=1565728779' \
  -d 'updated_after=1565555979' \
  -d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v25.0/<CMS_ID>/commerce_orders

Sample Response

 {
  "data": [
    {
      "id": "1299096923600598",
      "order_status": {
        "state": "CREATED"
      },
      "created": "2019-08-12T20:45:32+00:00",
      "last_updated": "2019-08-12T20:45:42+00:00"
    },
    {
      "id": "388309381882686",
      "order_status": {
        "state": "CREATED"
      },
      "created": "2019-08-12T19:52:46+00:00",
      "last_updated": "2019-08-12T19:52:56+00:00"
    },
    {
      "id": "366654374253443",
      "order_status": {
        "state": "CREATED"
      },
      "created": "2019-08-12T19:52:09+00:00",
      "last_updated": "2019-08-12T19:52:19+00:00"
    }
  ],
  "paging": {
    "cursors": {
      "before": "--sanitized_key--",
      "after": "--sanitized_key--"
    }
  }
}

Sample Request (multi-item order)

• Get multi-item Orders with additional fields and filters

curl -X GET -G \
  -d 'fields="id,order_status,items,channel"' \
  -d 'limit=1' \
  -d 'state="CREATED"' \
  -d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v25.0/<CMS_ID>/commerce_orders

Sample Response (multi-item order)

{
  "data": [
    {
      "id": "372892946712291",
      "order_status": {
        "state": "CREATED"
      },
      "items": {
        "data": [
          {
            "id": "372892953378957",
            "product_id": "2416339625125194",
            "retailer_id": "FB_product_1237",
            "quantity": 1,
            "price_per_unit": {
              "amount": "0.99",
              "currency": "USD"
            }
          },
          {
            "id": "372892943378958",
            "product_id": "2654057021279988",
            "retailer_id": "FB_product_1238",
            "quantity": 1,
            "price_per_unit": {
              "amount": "0.99",
              "currency": "USD"
            }
          }
        ],
        "paging": {
          "cursors": {
            "before": "--sanitized_key--",
            "after": "--sanitized_key--"
          }
        }
      },
      "channel": "instagram"
    }
  ],
  "paging": {
    "cursors": {
      "before": "--sanitized_key--",
      "after": "--sanitized_key--"
    }
  }
}

Get Order Details

Fetch order details for a given Facebook Order ID. The response only returns default fields, unless you request additional fields explicitly.

curl -X GET -G \
  -d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v25.0/<ORDER_ID>

Response

• order object with default fields

Sample Request

• Get Order details with additional fields

curl -X GET -G \
  -d 'fields="estimated_payment_details"' \
  -d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v25.0/<ORDER_ID>

Sample Response

{
  "estimated_payment_details": {
    "subtotal": {
      "items": {
        "amount": "2.00",
        "currency": "USD"
      },
      "shipping": {
        "amount": "0.00",
        "currency": "USD"
      }
    },
    "tax": {
      "amount": "0.19",
      "currency": "USD"
    },
    "total_amount": {
      "amount": "2.19",
      "currency": "USD"
    },
    "tax_remitted": true
  },
  "id": "412336950726541"
}

List Order Items

Fetch line items for a given Facebook Order ID. The response only returns default fields, unless you request additional fields explicitly.

curl -X GET -G \
  -d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v25.0/<ORDER_ID>/items

Response

item object

item_tax_details Object

total_tax Object

Sample Request

curl -X GET -G \
  -d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v25.0/<ORDER_ID>/items

Sample Response

{
  "data": [
    {
      "id": "2082596341811586",
      "product_id": "1213131231",
      "retailer_id": "external_product_1234",
      "quantity": 2,
      "price_per_unit": {
        "amount": "20.00",
        "currency": "USD"
      }
     
     "tax_details": {
                "estimated_tax": {
                  "amount": "0.30",
                  "currency": "USD"
                },
                "captured_tax": {
                  "total_tax": {
                    "amount": "0.30",
                    "currency": "USD"
                  }
               }
           }
    }
  ],
  "paging": {
    "cursors": {
      "before": "--sanitized_key--",
      "after": "--sanitized_key--"
    }
  }
}

Get Product Details

You can fetch additional details about a given product by making the following Graph API call:

curl -X GET -G \
  -d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v25.0/<PRODUCT_ID>

Response