Shopping List Service

Download OpenAPI specification:Download

Emporix: documentation@emporix.com URL: https://emporix.com

Manage shopping lists

Shopping Lists

Creating a shopping list

Creates a shopping list.

Required scopes

shoppinglist.shoppinglist_manage - required for the employee to create a shopping list for a provided customer. If scope is not present, then the customerId is resolved from the token.

SecurityCustomerAccessToken or OAuth2

Request

path Parameters

tenant

required

string

Your Emporix tenant's name.

Note: The tenant name should always be written in lowercase.

Example: saasdev2

Request Body schema: application/json

One of:

name required	string
	Array of objects (ShoppinglistItem)
	object Map of custom shopping lists attributes.
	object

Responses

201

The shopping list resource has been successfully created.

400

Request syntactically incorrect. Any details will be provided within the response payload.

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

409

Creation failed because there was a conflict with another resource. Any details will be provided within the response payload.

500

Some server side error occurred.

post/{tenant}/shopping-lists

Request samples

application/json

{"customerId": "C120043",
"name": "default",
"items": [{"id": 1,
"productId": "55cdcd91a88ed11babd7ca7e",
"quantity": 7.1,
"cuttingOption": "small",
"servicePackagingOption": "paper",
"comment": "fragile"
}
]
}

Response samples

application/json

{"id": "C120043"
}

Retrieving a shopping list

Gets shopping list by name or defaults to all shopping lists if name is not provided. When scope is provided then all shopping lists are returned. If scope is not provided, then only own shopping list is returned.

Required scopes

shoppinglist.shoppinglist_read - required for the employee to read shopping lists. If scope is not present, then the customerId is resolved from the token.

SecurityCustomerAccessToken or OAuth2

Request

path Parameters

tenant

required

string

Your Emporix tenant's name.

Note: The tenant name should always be written in lowercase.

Example: saasdev2

query Parameters

name	string Name of the shopping list. If missing all shopping lists are provided. This query param has no effect when it's used by employee.

Responses

200

Resource successfully retrieved.

400

Request syntactically incorrect. Any details will be provided within the response payload.

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

500

Some server side error occurred.

get/{tenant}/shopping-lists

Request samples

Response samples

application/json

[{"customerId": "C120046",
"default": {"name": "default",
"items": [{"id": 1,
"productId": "55cdcd91a88ed11babd7ca7e",
"quantity": 7.1,
"cuttingOption": "small",
"servicePackagingOption": "paper",
"comment": "fragile"
},
{"id": 2,
"productId": "75cdcd91a88ed11babd7ca9i",
"quantity": 1.5,
"cuttingOption": "small",
"servicePackagingOption": "paper",
"comment": "fragile"
}
]
}
}
]

Updating a customer shopping list

Updates a shopping list.

Required scopes

shoppinglist.shoppinglist_manage - required for the employee to update a shopping list. If scope is not present, then the operation is allowed for customer to update his own shopping list.

SecurityCustomerAccessToken or OAuth2

Request

path Parameters

tenant required	string Your Emporix tenant's name. Note: The tenant name should always be written in lowercase. Example: saasdev2
customerId required	string Unique identifier of the customer. Example: C120053

Request Body schema: application/json

name required	string
	Array of objects (ShoppinglistItem)
	object Map of custom shopping lists attributes.
	object

Responses

204

The resource has been successfully updated.

400

Request syntactically incorrect. Any details will be provided within the response payload.

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

404

The requested resource does not exist.

409

Creation failed because there was a conflict with another resource. Any details will be provided within the response payload.

500

Some server side error occurred.

put/{tenant}/shopping-lists/{customerId}

Request samples

application/json

{"name": "default",
"items": [{"id": 3,
"productId": "23cdcd91a88ed11babd7ca7y",
"quantity": 2.4,
"cuttingOption": "small",
"servicePackagingOption": "paper",
"comment": "fragile"
}
]
}

Response samples

application/json

{"status": 400,
"message": "There are validation problems, see details section for more information",
"moreInfo": "https://pattern.yaas.io/errortypes.html",
"type": "validation_violation",
"details": [{"field": "hybris-tenant",
"message": "size must be between 1 and 36",
"type": "invalid_header"
}
]
}

Retrieving a customer shopping list

Retrieves a shopping list based on the customer number. This endpoint is valid only for the employee.

Required scopes

shoppinglist.shoppinglist_read

SecurityCustomerAccessToken

Request

path Parameters

tenant required	string Your Emporix tenant's name. Note: The tenant name should always be written in lowercase. Example: saasdev2
customerId required	string Unique identifier of the customer. Example: C120053

query Parameters

name	string Name of the shopping list

Responses

200

shopping list successfully retrieved.

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

403

Given authorization scopes are not sufficient and do not match required scopes.

404

The requested resource does not exist.

500

Some server side error occurred.

get/{tenant}/shopping-lists/{customerId}

Request samples

Response samples

application/json

{"customerId": "C120048",
"default": {"name": "default",
"items": [{"id": 1,
"productId": "55cdcd91a88ed11babd7ca7e",
"quantity": 7.1,
"cuttingOption": "small",
"servicePackagingOption": "paper",
"comment": "fragile"
},
{"id": 2,
"productId": "75cdcd91a88ed11babd7ca9i",
"quantity": 1.5,
"cuttingOption": "small",
"servicePackagingOption": "paper",
"comment": "fragile"
}
]
}
}

Removing a customer shopping list

Deletes a shopping list.

Required scopes

shoppinglist.shoppinglist_manage - required for the employee to delete a shopping list. If scope is not present, then the operation is allowed for customer to delete his own shopping list.

SecurityOAuth2

Request

path Parameters

tenant required	string Your Emporix tenant's name. Note: The tenant name should always be written in lowercase. Example: saasdev2
customerId required	string Unique identifier of the customer. Example: C120053

query Parameters

name	string Name of the shopping list. If no `name` is provided, then all shopping lists of given customer are removed.

Responses

204

The resource has been successfully deleted.

400

Request syntactically incorrect. Any details will be provided within the response payload.

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

403

Given authorization scopes are not sufficient and do not match required scopes.

404

The requested resource does not exist.

500

Some server side error occurred.

delete/{tenant}/shopping-lists/{customerId}

Request samples

Response samples

application/json

{"status": 400,
"message": "There are validation problems, see details section for more information",
"moreInfo": "https://pattern.yaas.io/errortypes.html",
"type": "validation_violation",
"details": [{"field": "hybris-tenant",
"message": "size must be between 1 and 36",
"type": "invalid_header"
}
]
}