Graph API Version

Commerce Order

Reading

Represents an order placed directly on Facebook or Instagram

New Page Experience

This endpoint is supported for New Page Experience.

Parameters

This endpoint doesn't have any parameters.

Fields

FieldDescription
id
numeric string

Unique ID representing the order. Although numerical, treat Order IDs as strings, as Order ID length and structure is subject to change.

buyer_details

Buyer details for the order

channel
string

Channel through which the order was placed. Possible values are Facebook or Instagram.

created
string

Order's creation datetime in ISO 8601 format.

estimated_payment_details
CommerceOrderPaymentDetails

Estimated payment details when order was placed. Actual captured payment is determined when order is fulfilled. See payment_details.

is_group_buy
bool

If this order is a Group Purchase Promotion

is_test_order
bool

If this order is a test order placed in a test commerce account

items

List of items purchased in this order

last_updated
string

Order's latest update datetime in ISO 8601 format.

merchant_order_id
string

Unique ID representing the order in merchant's Order Management System. This is set when the order is acknowledged.

order_status

Status of the order

selected_shipping_option
CommerceOrderShippingOption

This field is available for backward compatibility. You should read the selected_shipping_option on each item in the order

ship_by_date
string

The expected date the order is to be shipped by. Date format is 'Y-m-d'

shipping_address

Shipping address for the order

Edges

EdgeDescription

Cancellations on the order

Payments on the order

A list of promotions applied on the order

Refunds on the order

Error Codes

ErrorDescription
100Invalid parameter

Creating

You can't perform this operation on this endpoint.

Updating

You can update a CommerceOrder by making a POST request to /{page_id}/acknowledge_orders.

Parameters

ParameterDescription
idempotency_key
string

Idempotency key for the request

Required
orders
array<JSON object>

Array of CommerceOrder IDs to be acknowledged. Maximum 100 orders can be acknowledge in one call.

Required
id
string

id

Required
merchant_order_reference
string

merchant_order_reference

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
orders: List [
Struct {
id: string,
error: Struct {
error_code: int32,
error_message: string,
},
state: enum,
}
],
}

Error Codes

ErrorDescription
100Invalid parameter

Deleting

You can't perform this operation on this endpoint.