diff --git a/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-shoppinglist.html b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-shoppinglist.html new file mode 100644 index 0000000000..3f3f2a2040 --- /dev/null +++ b/docs/api/php_api/php_api_reference/namespaces/ibexa-contracts-shoppinglist.html @@ -0,0 +1,46186 @@ + + + + + ShoppingList | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+
+
+ +
+
+
+ +
+
+
+
+
+
+ +
+ +
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/rest_api/rest_api_reference/rest_api_reference.html b/docs/api/rest_api/rest_api_reference/rest_api_reference.html index a8152b78d0..c36428709b 100644 --- a/docs/api/rest_api/rest_api_reference/rest_api_reference.html +++ b/docs/api/rest_api/rest_api_reference/rest_api_reference.html @@ -445,7 +445,7 @@ -
logo
API docs by Redocly
logo
API docs by Redocly

Error - a discount of the given ID is not found.

Response samples

Content type
application/vnd.ibexa.api.Discount+json
{
  • "Discount": {
    }
}
+
/api/ibexa/v2/discounts/{id}

Response samples

Content type
application/vnd.ibexa.api.Discount+json
{
  • "Discount": {
    }
}

Shopping Lists

List shopping lists

Returns a list of shopping lists owned by the current user.

+
query Parameters
limit
integer
Default: 25

The maximum number of shopping lists to return. Default is 25.

+
offset
integer
Default: 0

The offset for pagination. Default is 0.

+
name
string

Filter shopping lists by name (partial match).

+
createdFrom
string <date-time>

Filter shopping lists created on or after this date (ISO 8601 format).

+
createdTo
string <date-time>

Filter shopping lists created on or before this date (ISO 8601 format).

+
updatedFrom
string <date-time>

Filter shopping lists updated on or after this date (ISO 8601 format).

+
updatedTo
string <date-time>

Filter shopping lists updated on or before this date (ISO 8601 format).

+
isDefault
string
Enum: "true" "false"

Filter shopping lists by default flag. Use "true" for default lists only, "false" for non-default lists only.

+
sort
string
Enum: "name" "is_default" "created_at" "updated_at"

Sort shopping lists by field. Available fields: name, is_default, created_at, updated_at.

+
order
string
Default: "asc"
Enum: "asc" "desc"

Sort direction. Default is "asc".

+
header Parameters
Accept
required
string

If set, the shopping list collection is returned in XML or JSON format.

+

Responses

Response samples

Content type
{
  • "ShoppingListCollection": {
    }
}

Create shopping list

Creates a new shopping list for the current user. The list will be owned by the authenticated user.

+
header Parameters
Accept
required
string

If set, the new shopping list is returned in XML or JSON format.

+
Content-Type
required
string

The shopping list input schema encoded in XML or JSON format.

+
Request Body schema:
optional

The new ShoppingListCreateController resource

+
required
object (ShoppingListCreate)

Creates a new shopping list.

+

Responses

Request samples

Content type
{
  • "ShoppingListCreate": {
    }
}

Response samples

Content type
{
  • "ShoppingList": {
    }
}

Add entries to default shopping list

Adds one or more product entries to the default shopping list. If the default shopping list does not exist, it will be created automatically.

+
header Parameters
Accept
required
string

If set, the updated shopping list is returned in XML or JSON format.

+
Content-Type
required
string

The entries input schema encoded in XML or JSON format.

+
Request Body schema:
optional

The new ShoppingListAddToDefaultEntriesController resource

+
required
object (ShoppingListEntriesAdd)

Adds one or more product entries to an existing shopping list.

+

Responses

Request samples

Content type
{
  • "ShoppingListEntriesAdd": {
    }
}

Response samples

Content type
{
  • "ShoppingList": {
    }
}

Get shopping list

Gets a shopping list by its identifier.

+
path Parameters
identifier
required
string

The shopping list identifier (UUID)

+
header Parameters
Accept
required
string

The shopping list is returned in XML or JSON format.

+

Responses

Response samples

Content type
{
  • "ShoppingList": {
    }
}

Delete shopping list

Deletes a shopping list by its identifier. The default shopping list cannot be deleted.

+
path Parameters
identifier
required
string

The shopping list identifier (UUID).

+

Responses

Update shopping list

Updates an existing shopping list. Only the name can be updated.

+
path Parameters
identifier
required
string

The shopping list identifier (UUID).

+
header Parameters
Accept
string

If set, the updated shopping list is returned in XML or JSON format.

+
Content-Type
required
string

The shopping list update schema encoded in XML or JSON format.

+
Request Body schema:
optional

The updated ShoppingListUpdateController resource

+
required
object (ShoppingListUpdate)

Updates an existing shopping list.

+

Responses

Request samples

Content type
{
  • "ShoppingListUpdate": {
    }
}

Response samples

Content type
{
  • "ShoppingList": {
    }
}

Clear shopping list

Removes all entries from a shopping list while keeping the list itself.

+
path Parameters
identifier
required
string

The unique identifier (UUID) of the shopping list.

+
header Parameters
Accept
required
string

If set, the updated shopping list is returned in XML or JSON format.

+

Responses

Response samples

Content type
{
  • "ShoppingList": {
    }
}

Add entries to shopping list

Adds one or more product entries to an existing shopping list.

+
path Parameters
identifier
required
string

The unique identifier (UUID) of the shopping list.

+
header Parameters
Accept
required
string

If set, the updated shopping list is returned in XML or JSON format.

+
Content-Type
required
string

The entries input schema encoded in XML or JSON format.

+
Request Body schema:
optional

The new ShoppingListAddEntriesController resource

+
required
object (ShoppingListEntriesAdd)

Adds one or more product entries to an existing shopping list.

+

Responses

Request samples

Content type
{
  • "ShoppingListEntriesAdd": {
    }
}

Response samples

Content type
{
  • "ShoppingList": {
    }
}

Remove entries from shopping list

Removes one or more product entries from an existing shopping list by their identifiers.

+
path Parameters
identifier
required
string

The unique identifier (UUID) of the shopping list.

+
header Parameters
Accept
required
string

If set, the updated shopping list is returned in XML or JSON format.

+
Content-Type
required
string

The entries remove input schema encoded in XML or JSON format.

+
Request Body schema:
optional

The new ShoppingListRemoveEntriesController resource

+
required
object (ShoppingListEntriesRemove)

Removes one or more entries from a shopping list by their identifiers.

+

Responses

Request samples

Content type
{
  • "ShoppingListEntriesRemove": {
    }
}

Response samples

Content type
{
  • "ShoppingList": {
    }
}

Move or copy entries to shopping list

Moves or copies one or more product entries from their source shopping lists to the target shopping list. Use the "copy" parameter to control whether entries are copied (kept in source) or moved (removed from source).

+
path Parameters
targetIdentifier
required
string

The unique identifier (UUID) of the target shopping list where entries will be moved.

+
header Parameters
Accept
required
string

If set, the updated shopping list is returned in XML or JSON format.

+
Content-Type
required
string

The entries move input schema encoded in XML or JSON format.

+
Request Body schema:
optional

The new ShoppingListMoveEntriesController resource

+
required
object (ShoppingListEntriesMove)

Moves or copies one or more entries from their source shopping lists to a target shopping list.

+

Responses

Request samples

Content type
{
  • "ShoppingListEntriesMove": {
    }
}

Response samples

Content type
{
  • "ShoppingList": {
    }
}