Create a Shopping List With Products

POST

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

Add a shopping list containing products 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

Request Body ^required

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

Responses

201

Response Code: 201 - 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

400

SL-0003 - The retailer product id in the shopping list appears more than once, 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

409

SL-0001 - The maximum number of shopping lists per customer has been reached, SL-0005 - The retailerShoppingListsId already exists in the banner, SL-0002 - The maximum number of products per list has been reached

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

415

CC-012 - Unsupported media type

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