Get Customer Shopping List
Returns a Customer Shopping List based on:
- retailerShoppingListId
- retailerBannerId
- retailerCustomerId
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The unique identifier for the retail banner.
The unique identifier for the customer.
The unique identifier for the shopping list.
Header Parameters
Section titled “Header Parameters ”The API key for the environment. To obtain an API key, speak to your account contact.
Request id
Responses
Section titled “ Responses ”Response Code 200 - success
object
The name of the shopping list.
The unique identifier for the shopping list.
object
Your unique identifier for the product.
The number of products.
2
The date and time the products were added.
The unique identifier for the customer.
The date and time the shopping list was created.
The date and time the shopping list was updated.
CC-002 - Bad request exception
Error response schema. It provides further details when a request fails.
object
Date and time the response was generated
HTTP response status code
400
Textual details about error, may contain parameters described in args
Optional values for parameters used in ‘message’
object
Custom OSP error code
Link to troubleshooting page with information about the error
CC-090 - Unauthorized
Error response schema. It provides further details when a request fails.
object
Date and time the response was generated
HTTP response status code
400
Textual details about error, may contain parameters described in args
Optional values for parameters used in ‘message’
object
Custom OSP error code
Link to troubleshooting page with information about the error
CC-091 - Access is denied
Error response schema. It provides further details when a request fails.
object
Date and time the response was generated
HTTP response status code
400
Textual details about error, may contain parameters described in args
Optional values for parameters used in ‘message’
object
Custom OSP error code
Link to troubleshooting page with information about the error
CC-2600 - The retail banner cannot be found, or the service account used is not authorised, SL-0004 - Shopping list not found, CC-101 - Customer not found
Error response schema. It provides further details when a request fails.
object
Date and time the response was generated
HTTP response status code
400
Textual details about error, may contain parameters described in args
Optional values for parameters used in ‘message’
object
Custom OSP error code
Link to troubleshooting page with information about the error
CC-001 - Unhandled exception
Error response schema. It provides further details when a request fails.
object
Date and time the response was generated
HTTP response status code
400
Textual details about error, may contain parameters described in args
Optional values for parameters used in ‘message’
object
Custom OSP error code
Link to troubleshooting page with information about the error