Data API — Carts

20 min

cart_add_resource

sync(id: UUID, resource_id: UUID, client: AuthenticatedClient | Client) -> CartResponse | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
id	UUID	required
resource_id	UUID	required
client	AuthenticatedClient \| Client	required

Returns: CartResponse | ProblemDetails | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

cart_by_id

sync(id: UUID, client: AuthenticatedClient | Client) -> CartResponse | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
id	UUID	required
client	AuthenticatedClient \| Client	required

Returns: CartResponse | ProblemDetails | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

cart_delete

sync(id: UUID, client: AuthenticatedClient | Client) -> Any | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
id	UUID	required
client	AuthenticatedClient \| Client	required

Returns: Any | ProblemDetails | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

cart_list

sync(client: AuthenticatedClient | Client, name: str | Unset = UNSET, location_id: UUID | Unset = UNSET, cellario_system_id: UUID | Unset = UNSET, is_flex_cart: bool | Unset = UNSET, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[CartResponse] | list[ErrorResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
name	str \| Unset	UNSET
location_id	UUID \| Unset	UNSET
cellario_system_id	UUID \| Unset	UNSET
is_flex_cart	bool \| Unset	UNSET
page	int \| Unset	UNSET
page_size	int \| Unset	UNSET

Returns: ProblemDetails | list[CartResponse] | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

cart_remove_resource

sync(id: UUID, resource_id: UUID, client: AuthenticatedClient | Client) -> CartResponse | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
id	UUID	required
resource_id	UUID	required
client	AuthenticatedClient \| Client	required

Returns: CartResponse | ProblemDetails | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

cart_remove_system

sync(id: UUID, system_id: UUID, client: AuthenticatedClient | Client) -> CartResponse | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
id	UUID	required
system_id	UUID	required
client	AuthenticatedClient \| Client	required

Returns: CartResponse | ProblemDetails | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

cart_update

sync(id: UUID, client: AuthenticatedClient | Client, body: UpdateCartRequest | Unset = UNSET) -> CartResponse | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
id	UUID	required
client	AuthenticatedClient \| Client	required
body	UpdateCartRequest \| Unset	UNSET

body — Update details on the cart

Returns: CartResponse | ProblemDetails | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

cart_update_location

sync(id: UUID, location_id: UUID, client: AuthenticatedClient | Client) -> CartResponse | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
id	UUID	required
location_id	UUID	required
client	AuthenticatedClient \| Client	required

Returns: CartResponse | ProblemDetails | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

cart_update_system

sync(id: UUID, system_id: UUID, client: AuthenticatedClient | Client) -> CartResponse | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
id	UUID	required
system_id	UUID	required
client	AuthenticatedClient \| Client	required

Returns: CartResponse | ProblemDetails | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

post_v1_carts

sync(client: AuthenticatedClient | Client, body: CreateCartRequest | Unset = UNSET) -> CartResponse | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
body	CreateCartRequest \| Unset	UNSET

body — Information used to create a plate

Returns: CartResponse | ProblemDetails | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.