Skip to navigation
RESTAdminManagementPickupPickup Methods

Create Pickup Methods

Creates one or many pickup methods.

This is a batch operation that can create up to 100 pickup methods objects in one request.

Limits

  • Limit of creating 100 pickup method objects per POST request.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI NamePermissionParameter
Order Fulfillmentread-onlystore_order_fulfillment_read_only
Order Fulfillmentmodifystore_order_fulfillment_manage

Authentication header

HeaderArgumentDescription
X-Auth-Tokenaccess_tokenFor more about API accounts that generate access_tokens, see API Accounts and OAuth Scopes.

Further reading

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see API Accounts and OAuth Scopes.

For a list of API status codes, see API Status Codes.

Path parameters

store_hashstringRequired
Permanent ID of the BigCommerce store.

Headers

AcceptstringRequiredDefaults to application/json

The MIME type of the response body.

Request

This endpoint expects a list of objects.
location_idintegerOptional
The ID of the location.
display_namestringOptional0-250 characters
Title of the pickup method.
collection_instructionsstringOptional0-250 characters
Instructions for picking up items.
collection_time_descriptionstringOptional0-250 characters
The description of collection time.
location_identityintegerOptionalDeprecated

Response

The request has been successfully processed.
datalist of objectsOptional
metaobjectOptional