REST API - Orders, Invoices, and Payments
Orders
GET Orders
This API request allows you to get a list of orders placed in B2B Edition. There are many different parameters you can add to the request URL to filter the list of orders. The example below uses the companyId parameter, but see the B2B Edition List Orders API reference to see all the possible parameters.
Example Request:
The request above will return a list of orders for the specified company. Remove the {company_id}parameter to get a list of all B2B Edition orders.
GET an Order
This API request uses the BigCommerce order ID, not the B2B Edition order ID, to return order details.
Example Request:
The response will include all order details for the specified order.
GET Order Products
This request also uses the bcOrderId instead of the B2B Edition order ID to return product detail for the specified order.
Example Request:
Update an Order
Use this API request to update an order’s poNumber and extraFields. At least one of these fields must be passed in the request body.
Example Request:
Example Body:
Update a Customer’s BigCommerce Orders
The following API request will convert a BigCommerce customer’s individual order to a company-level order. This API is used when a customer places an order either as a guest or in an individual account. The order will need to be converted to a B2B Company-level order via the API.
Example Request:
You will need to include the customers BigCommerce customerId in the request URL.
Create an Order
A B2B order record will automatically be created for all orders placed in BigCommerce, so the explicit use of the Create an Order endpoint is not usually necessary. If, however, you have a need for populating extra information on the B2B record, you can preempt this automatic process with your own webhook and call this endpoint, as long as this is within 10 seconds of order creation.
Example Request:
The required fields for the request body include:
bcOrderId- the order ID in BigCommercecustomerId- the customer ID of the order creater
You can also include the poNumber and extra fields in the body request depending on the needs of your store. The example body below includes the two required fields plus the poNumber field.
Example Body:
Invoices
Create an Invoice from an Order
This API request will create an invoice from an order that has already been placed. The only requirement is the B2B Edition orderId.
Example Request:
Create an Invoice
This request URL will create an invoice in B2B Edition. This endpoint is useful to manually create full invoice details if they cannot be inferred from an order.
Example Request:
There are a few required fields that are needed in the request body in order to correctly create an invoice with the B2B Edition API. Those required fields include:
invoiceNumber- a string value that specifies the invoice numberoriginalBalance- the original balance of the invoice. There are two required sub-fields: code and valueopenBalance- the amount still owed on the invoice, when it is less than or equal to 0 the invoice status will be automatically set to completed. There are two required sub-fields: code and valuecustomerId- the B2B Edition company IDchannelId- the BigCommerce channel ID
For a full list of request body fields, see the Create an Invoice API reference. Note that externalID refers to an ERP Invoice ID that was created outside of B2B Edition and BigCommerce.
Example Body:
Get Invoices
This API request will return a list of invoices that have been created in B2B Edition.
Example Request:
For a full list of query parameters, see the Get Invoices API Reference. Note that customerId refers to the company ID, not a B2B Edition user ID.
Update an Invoice
This API request can be used to update information for an invoice. You will need to include the invoiceID as a parameter in the request as shown in the example below.
Example Request:
For a full list of fields you are able to update with this request, see the Update an invoice API reference. One thing to note is that the status can be updated with this API request even if the open balance does not reflect the updated status.
Export an Invoice as a PDF
Use the endpoint below to create a downloadable PDF that contains invoice details. The response will include a link, which will download a PDF when clicked.
Example Request:
Delete an Invoice
This API request will delete an invoice. You must include the invoiceId as a request parameter.
Example Request:
Payments
Get a List of Payments
This API request will return a list of invoice payments.
Example Request:
There are many query parameters that can be used with this type of request. The list below contains some commonly used parameters, but a full list can be found in the Get Payments API reference.
customerName- a B2B Edition company nameinvoiceId- payments are associated with an invoice bylineItems, one payment can be associated with multiple invoicesprocessingStatus- this is the payment processing status. 0 = Incomplete, 1 = Awaiting Processing, 2 = Processing, 3 = Completed, and 4 = Refunded
This query will return a list of all online and offline payments. Online payments are made through BigCommerce checkout, usually by providing credit card information and then processed online. Offline payments refer to check or money orders that have to be manually recorded.
Update Payment Processing Status
This API request will update a payment processing status for the provided paymentId. This is only relevant for offline payments.
Example Request:
The new processing status will be specified in the request body. Statuses can be updated to one of the following:
- 1 = Awaiting Processing
- 2 = Processing
- 3 = Completed
- 4 = Refunded
Example Body:
Payment Methods
GET Payment Methods
This API request will return a list of available payment methods based on the query parameters.
Example Request:
You can use filter and search parameters to filter by companyId or find specific company payment methods with pagination.
GET Company Payments
This API request will return a list of payment methods associated with the companyId that is specified in the request URL.
Example Request:
Update Company Payments
This API request is used to update a company’s payment methods. You can enable or disable payment methods for a company account in batch.
Example Request:
The request body will contain an array of payment methods that will be updated.
Example Body:
