Pickup Methods
This API endpoint enables you to manage pickup methods.
Get Pickup Methods
GET /stores/{store_hash}/v3/pickup/methods
Request
Retrieves a list of pickup methods.
Examples
You can filter this list to return pickup method objects specific to a list of requested pickup method IDs. This is achieved by appending the query string ?id:in=1,3,5
to the resource /pickup/methods
.
GET /pickup/methods?id:in=1,3,5
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequired
The MIME type of the response body.
- id:in in query - integer
Comma separated list of pickup method IDs.
- limit in query - integer
Maximum number of results per page.
- page in query - integer
The number of the page to be fetched.
- date_created in query - string
Filter pickup methods by the date created. Return methods created on the provided date.
For example,
date_created=2023-09-07T06:23:13Z
. - date_created:min in query - string
Filter pickup methods by minimum date created. Return methods created after the provided date.
For example,
date_created:min=2023-09-07T06:23:13Z
. - date_created:max in query - string
Filter pickup methods by maximum date created. Return methods created before the provided date.
For example,
date_created:max=2023-09-07T06:23:13Z
. - date_modified in query - string
Filter pickup methods by date modified. Return methods modified on the provided date.
For example,
date_modified=2023-09-07T06:23:13Z
. - date_modified:min in query - string
Filter pickup methods by minimum date modified. Return methods modified after the provided date.
For example,
date_modified:min=2023-09-07T06:23:13Z
. - date_modified:max in query - string
Filter pickup methods by maximum date modified. Return methods modified before the provided date.
For example,
date_modified:max=2023-09-07T06:23:13Z
. - sort in query - string
Sort pickup methods by date_modified:* or name:* ; for example,
sort=name:asc
.date_modified:asc
- sort by date modified in ascending orderdate_modified:desc
- sort by date modified in descending ordername:asc
- sort by name in ascending ordername:desc
- sort by name in descending order
Allowed values: date_modified:asc | date_modified:desc | name:asc | name:desc
example
Response
The request has been processed and a list of pickup methods has been returned successfully.
Body
dataarray[object]
metaobject
example
Create Pickup Methods
POST /stores/{store_hash}/v3/pickup/methods
Request
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-Token in headerrequired
Parameters
- store_hash in path - string
- Content-Type in header with default of application/json - stringrequired
The MIME type of the request body.
Body
location_idinteger
The ID of the location.
Example: 2
display_namestring
>= 0 characters<= 250 charactersTitle of the pickup method.
Example: Office Pickup!
collection_instructionsstring
>= 0 characters<= 250 charactersInstructions for picking up items.
Example: Bring your ID!
collection_time_descriptionstring
>= 0 characters<= 250 charactersThe description of collection time.
Example: Collect during our opening hours of 0900 - 1700
location_identityinteger
deprecatedExample: 2
example
Response
The request has been successfully processed.
Body
dataarray[object]
metaobject
example
Update Pickup Methods
PUT /stores/{store_hash}/v3/pickup/methods
Request
Update existing pickup methods.
This batch operation can update 10 pickup method objects in one request.
Only the id
property of the pickup method object is required as part of the request. Pickup method properties that are not provided will maintain their existing values.
Limits
- Limit of updating 10 pickup method objects per
PUT
request.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Content-Type in header with default of application/json - stringrequired
The MIME type of the request body.
Body
idinteger
The ID of the pickup method.
Example: 1
location_idinteger
The ID of the location.
Example: 2
display_namestring
>= 0 characters<= 250 charactersTitle of the pickup method.
Example: Office Pickup!
collection_instructionsstring
>= 0 characters<= 250 charactersInstructions for picking up items.
Example: Bring your ID!
collection_time_descriptionstring
>= 0 characters<= 250 charactersThe description of collection time.
Example: Collect during our opening hours of 0900 - 1700
location_identityinteger
deprecatedExample: 2
example
Response
The request has been successfully processed.
Body
dataarray[object]
metaobject
example
Delete Pickup Methods
DELETE /stores/{store_hash}/v3/pickup/methods
Request
Delete existing pickup methods.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequired
The MIME type of the response body.
- id:in in query - integerrequired
Comma separated list of pickup method IDs.
example
Response
No Content