Get Customer Shopping Lists

GET

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

Returns a collection of Shopping Lists based on:

• retailerBannerId
• retailerCustomerId

Parameters

Path Parameters

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.

Header Parameters

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

Responses

200

Response Code 200 - Success : data returned

Array<object>

0

object

retailerShoppingListId

required

The unique identifier for the shopping list.

string

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

retailerCustomerId

required

The unique identifier for the customer.

string

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

name

required

The name of the shopping list.

string

""

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

400

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

401

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

403

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

404

CC-101 - Customer not found, CC-2600 - The retail banner cannot be found, or the service account used is not authorised

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

500

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