Orders V3
- Host: api.bigcommerce.com/stores/store_hash/v3
- Protocols:
https - Accepts:
application/json - Responds With:
application/json
- Download Spec: BigCommerce_Order_Transactions_API.oas2.json
The V3 REST API’s Orders resource surfaces endpoints related to payment processing. The /orders/{id}/transactions endpoint returns transaction details for the specified order.
To programmatically create, update, and delete orders themselves, see Orders v2. To process payments, see Payment Processing.
OAuth Scopes
| UI Name | Permission | Parameter |
|---|---|---|
| Order Transactions | modify | store_v2_transactions |
| Order Transactions | read-only | store_v2_transactions_read_only |
| Orders | modify | store_v2_orders |
| Orders | read-only | store_v2_orders_read_only |
For more information on OAuth Scopes, see: Authentication.
Authentication
Requests can be authenticated by sending a client_id and access_token via X-Auth-Client and X-Auth-Token HTTP headers:
GET /stores/store_hash/v3/catalog/summary
host: api.bigcommerce.com
Accept: application/json
X-Auth-Client: {client_id}
X-Auth-Token: {access_token}
| Header | Parameter | Description |
|---|---|---|
X-Auth-Client |
client_id |
Obtained by creating an API account or installing an app in a BigCommerce control panel. |
X-Auth-Token |
access_token |
Obtained by creating an API account or installing an app in a BigCommerce control panel. |
For more information on Authenticating BigCommerce APIs, see: Authentication.
Available Endpoints
| Endpoint | Description |
|---|---|
/orders/{id}/transactions |
Get list of transaction data for an order |
Order Transactions
The /orders/{id}/transactions endpoint returns details about the payment instruments used to pay for an order. Depending on the payment method used, different details will be available. Not all credit card payment gateways will return full card details or all CVV/fraud response details. This is primarily used to get detailed gateway response information for credit card transactions, however it will also return any available information about digital wallet payments, as well as details about orders paid (partially or in full) via a gift certificate or store credit.
The test payment gateway available in the BigCommerce control panel does not return any payment information.