Pickup
Retrieves and updates in-store order pickups.
Table Specific Information
Select
The driver uses the BigCommerce API to process WHERE clause conditions built with the following columns and operators:
- Id supports the = and IN comparisons.
- OrderId supports the = and IN comparisons.
The rest of the filter is executed client-side within the driver.
For example, the following queries are processed server-side:
SELECT * FROM Pickup WHERE Id = 5
SELECT * FROM Pickup WHERE OrderId = 100
Insert
To insert a pickup, specify at least the PickupMethodId, OrderId, ReadyAt, and PickupItems columns. CollectedAt is optional.
INSERT INTO Pickup(PickupMethodId, OrderId, ReadyAt, CollectedAt, PickupItems) VALUES(2, 100, '2026-07-29T10:00:00Z', '2026-07-29T10:00:00Z', '[{"order_product_id": 77,"quantity": 5}]')
Update
UPDATE Pickup SET CollectedAt = '2024-01-05T10:00:00Z' WHERE Id = 5
Delete
DELETE FROM Pickup WHERE Id = 5
DELETE FROM Pickup WHERE Id IN (5,6)
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | Integer | True |
The unique identifier of the pickup. |
| OrderId | Integer | False |
The Id of the order this pickup belongs to. |
| PickupMethodId | Integer | False |
The Id of the pickup method used for this pickup. |
| ReadyAt | Datetime | False |
Date and time the order became ready for pickup. |
| CreatedAt | Datetime | True |
Date and time the pickup was created. |
| UpdatedAt | Datetime | True |
Date and time the pickup was last updated. |
| PickupItems | String | False |
A JSON-formatted array of the items included in this pickup, with their collection status. |
Pseudocolumns
Pseudo column fields are used to enable the user to INSERT Fields that are non-readable but required during creation of new records.
| Name | Type | Description |
| CollectedAt | Datetime |
Date and time the order was collected. Setting this value marks the pickup items as collected. This column is only used for INSERT and UPDATE operations. |