For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
  • Overview
    • Quick Start
    • Sandboxes
    • Tools & SDKs
    • Support
  • Docs
      • Getting Started
      • Becoming a Partner
      • Metafields
      • Scripts
      • Shipping Providers
      • Tax Providers
          • Overview
            • Overview
            • Merchant configuration
            • Browse and discover as a shopper
            • Manage checkout as a shopper
            • Manage order as a merchant
            • Fulfill order as a merchant
            • Retire merchant configuration
          • Frequently asked questions
          • Glossary
          • Inventory adjustments
          • Locations
          • Webhooks
        • Analytics with BODL
        • Staging with Staging Pro
    • Archive
    • Closed Beta Programs
Dev Portal
LogoLogo
On this page
  • 5.0 Manage order as a merchant
  • 5.1 View the newly-created order’s pickup consignment
  • 5.2 View the newly-created order’s products
  • 5.3 Update pickup consignment
DocsIntegrationsPlatform SolutionsBuy online, pick up in storeEnd-to-end guide

Manage order as a merchant

Was this page helpful?
Previous

Manage checkout as a shopper

Next

Fulfill order as a merchant

Built with

5.0 Manage order as a merchant

When building a Buy Online, Pick up in Store solution, you can allow merchants to manage orders that have pickup consignments. They can view and update the pickup consignment for an order.

5.1 View the newly-created order’s pickup consignment

To view the pickup consignment for the newly-created order, send a request to the Get consignments endpoint.

Request
Response
Example request: Get consignments
1GET https://api.bigcommerce.com/stores/{{store_hash}}/v2/orders/{{order_id}}/consignments
2X-Auth-Token: {{access_token}}
3Accept: application/json

The order’s pickup consignment is 13.

5.2 View the newly-created order’s products

To view the products for a newly-created order, send a request to the Get order products endpoint. The response returns products that were assigned to a pickup consignment.

Request
Response
Example request: Get order products
1GET https://api.bigcommerce.com/stores/{{store_hash}}/v2/orders/{{order_id}}/products
2X-Auth-Token: {{access_token}}
3Accept: application/json

The order_pickup_method_id field is 13 (same value as the pickup consignment ID).

5.3 Update pickup consignment

If you need to update the original pickup consignment details, you have the ability to do so using the Orders API. You can update the:

  • pickup_method_id
  • pickup_method_display_name
  • collection_instructions
  • collection_time_description
  • location attributes (except for the location_id)

To update a pickup consignment, send a request to the Update an order endpoint.

Request
Response
Example request: Update an order
1PUT https://api.bigcommerce.com/stores/{{store_hash}}/v2/orders/{{order_id}}
2X-Auth-Token: {{access_token}}
3Content-Type: application/json
4Accept: application/json
5
6{
7 "consignments": {
8 "pickups": [
9 {
10 "id": 13,
11 "pickup_method_id": 1,
12 "pickup_method_display_name": "Pickup Method 1 name - override",
13 "collection_instructions": "Pickup Method 1 instructions - override",
14 "collection_time_description": "Pickup Method 1 time - override",
15 "location": {
16 "name": "Location 1 - override",
17 "code": "LOCATION-1 - override",
18 "address_line_1": "123 Main Street - override",
19 "address_line_2": "Suite 101 - override",
20 "city": "Austin - override",
21 "state": "Texas - override",
22 "postal_code": "78726 - override",
23 "country_alpha2": "US",
24 "email": "location1_override@example.com",
25 "phone": "+1 111-111-1111 - override"
26 }
27 }
28 ]
29 }
30}