Skip to content

Get Customer Shopping List

GET
/v3/{retailerBannerId}/customers/{retailerCustomerId}/shopping-lists/{retailerShoppingListId}

Returns a Customer Shopping List based on:

  • retailerShoppingListId
  • retailerBannerId
  • retailerCustomerId
retailerBannerId
required
string
/^[a-zA-Z0-9-_]+$/

The unique identifier for the retail banner.

retailerCustomerId
required
string
/^[a-zA-Z0-9-_]+$/

The unique identifier for the customer.

retailerShoppingListId
required
string
/^[a-zA-Z0-9-_]+$/

The unique identifier for the shopping list.

x-api-key
required
string

The API key for the environment. To obtain an API key, speak to your account contact.

RequestId
required
string
default: aa13e836-5c1a-4b05-b24d-d30571c49da8

Request id

Response Code 200 - success

object
name
required

The name of the shopping list.

string
""
retailerShoppingListId
required

The unique identifier for the shopping list.

string
/^[a-zA-Z0-9-_]+$/
products
required
Array<object>
object
retailerProductId
required

Your unique identifier for the product.

string
/^[a-zA-Z0-9-_]+$/
quantity
required

The number of products.

integer format: int32
>= 1
2
addedAt
required

The date and time the products were added.

string format: date-time
retailerCustomerId
required

The unique identifier for the customer.

string
/^[a-zA-Z0-9-_]+$/
createdAt
required

The date and time the shopping list was created.

string format: date-time
updatedAt
required

The date and time the shopping list was updated.

string format: date-time

CC-002 - Bad request exception

Error response schema. It provides further details when a request fails.

object
timestamp
required

Date and time the response was generated

string format: date-time
httpStatus
required

HTTP response status code

integer format: int32
400
message
required

Textual details about error, may contain parameters described in args

string
args

Optional values for parameters used in ‘message’

object
key
additional properties
any
code
required

Custom OSP error code

string
/[-A-Z0-9]+/
moreInfo
required

Link to troubleshooting page with information about the error

string

CC-090 - Unauthorized

Error response schema. It provides further details when a request fails.

object
timestamp
required

Date and time the response was generated

string format: date-time
httpStatus
required

HTTP response status code

integer format: int32
400
message
required

Textual details about error, may contain parameters described in args

string
args

Optional values for parameters used in ‘message’

object
key
additional properties
any
code
required

Custom OSP error code

string
/[-A-Z0-9]+/
moreInfo
required

Link to troubleshooting page with information about the error

string

CC-091 - Access is denied

Error response schema. It provides further details when a request fails.

object
timestamp
required

Date and time the response was generated

string format: date-time
httpStatus
required

HTTP response status code

integer format: int32
400
message
required

Textual details about error, may contain parameters described in args

string
args

Optional values for parameters used in ‘message’

object
key
additional properties
any
code
required

Custom OSP error code

string
/[-A-Z0-9]+/
moreInfo
required

Link to troubleshooting page with information about the error

string

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
timestamp
required

Date and time the response was generated

string format: date-time
httpStatus
required

HTTP response status code

integer format: int32
400
message
required

Textual details about error, may contain parameters described in args

string
args

Optional values for parameters used in ‘message’

object
key
additional properties
any
code
required

Custom OSP error code

string
/[-A-Z0-9]+/
moreInfo
required

Link to troubleshooting page with information about the error

string

CC-001 - Unhandled exception

Error response schema. It provides further details when a request fails.

object
timestamp
required

Date and time the response was generated

string format: date-time
httpStatus
required

HTTP response status code

integer format: int32
400
message
required

Textual details about error, may contain parameters described in args

string
args

Optional values for parameters used in ‘message’

object
key
additional properties
any
code
required

Custom OSP error code

string
/[-A-Z0-9]+/
moreInfo
required

Link to troubleshooting page with information about the error

string