PickupConsignments

Returns consignments and their corresponding pickups.

Table Specific Information

The add-in uses the BigCommerce API to process WHERE clause conditions built with the OrderId column, which supports the = comparison.

For example, the following queries are processed server-side:

SELECT * FROM PickupConsignments WHERE OrderId = 123


Name	Type	Description
Id	Integer	The ID of the pickup consignment to update.
OrderId	Integer	Identifier for the BigCommerce Order with which this transaction is associated.
PickupMethodId	Integer	The ID of the pickup consignment to update.
PickupMethodDisplayName	String	A name for the pickup method that can be displayed to shoppers.
CollectionInstructions	String	A message for shoppers explaining how to collect their pickup order.
CollectionTimeDescription	String	A message for shoppers indicating the estimated time their pickup order will be ready for collection.
LocationId	Integer	ID of the location.
LocationName	String	The name of the pickup location.
LocationCode	String	The code of the pickup location.
LocationAddressLine1	String	Pickup location's Street address (first line)
LocationAddressLine2	String	Pickup location's Street address (second line).
LocationCity	String	Pickup location's city.
LocationState	String	Pickup location's state.
LocationPostalCode	String	Pickup location's postal code.
LocationCountryAlpha2	String	2-letter ISO Alpha-2 code for the country.
LocationEmail	String	Pickup location's email address
LocationPhone	String	Pickup location's phone number.
PickupsLineItemResources	String	URL where you can use a GET request to get the pickups line items for the order consignment.
PickupsLineItemUrl	String	Path where you can use a GET request to get the pickups line items for the order consignment.