@shopware/api-client

{ "openapi": "3.1.0", "info": { "title": "Shopware Store API", "description": "This endpoint reference contains an overview of all endpoints comprising the Shopware Store API", "license": { "name": "MIT", "url": "https://github.com/shopware/shopware/blob/trunk/LICENSE" }, "version": "6.7.1.0" }, "servers": [{ "url": "https://demo-frontends.shopware.store/store-api" }], "components": { "schemas": { "success": { "required": ["data"], "properties": { "meta": { "$ref": "#/components/schemas/meta" }, "links": { "description": "Link members related to the primary data.", "allOf": [ { "$ref": "#/components/schemas/links" }, { "$ref": "#/components/schemas/pagination" } ] }, "data": { "$ref": "#/components/schemas/data" }, "included": { "description": "To reduce the number of HTTP requests, servers **MAY** allow responses that include related resources along with the requested primary resources. Such responses are called \"compound documents\".", "type": "array", "items": { "$ref": "#/components/schemas/resource" }, "uniqueItems": true } }, "type": "object", "additionalProperties": false }, "failure": { "required": ["errors"], "properties": { "meta": { "$ref": "#/components/schemas/meta" }, "links": { "$ref": "#/components/schemas/links" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/error" }, "uniqueItems": true } }, "type": "object", "additionalProperties": false }, "info": { "required": ["meta"], "properties": { "meta": { "$ref": "#/components/schemas/meta" }, "links": { "$ref": "#/components/schemas/links" }, "jsonapi": { "$ref": "#/components/schemas/jsonapi" } }, "type": "object" }, "meta": { "description": "Non-standard meta-information that can not be represented as an attribute or relationship.", "type": "object", "additionalProperties": true }, "data": { "description": "The document's \"primary data\" is a representation of the resource or collection of resources targeted by a request.", "oneOf": [ { "$ref": "#/components/schemas/resource" }, { "description": "An array of resource objects, an array of resource identifier objects, or an empty array ([]), for requests that target resource collections.", "type": "array", "items": { "$ref": "#/components/schemas/resource" }, "uniqueItems": true } ] }, "resource": { "description": "\"Resource objects\" appear in a JSON API document to represent resources.", "required": ["type", "id"], "properties": { "type": { "type": "string" }, "id": { "type": "string" }, "attributes": { "$ref": "#/components/schemas/attributes" }, "relationships": { "$ref": "#/components/schemas/relationships" }, "links": { "$ref": "#/components/schemas/links" }, "meta": { "$ref": "#/components/schemas/meta" } }, "type": "object" }, "relationshipLinks": { "description": "A resource object **MAY** contain references to other resource objects (\"relationships\"). Relationships may be to-one or to-many. Relationships can be specified by including a member in a resource's links object.", "properties": { "self": { "allOf": [ { "description": "A `self` member, whose value is a URL for the relationship itself (a \"relationship URL\"). This URL allows the client to directly manipulate the relationship. For example, it would allow a client to remove an `author` from an `article` without deleting the people resource itself.", "type": "array", "items": { "type": "object" } }, { "$ref": "#/components/schemas/link" } ] }, "related": { "$ref": "#/components/schemas/link" } }, "type": "object", "additionalProperties": true }, "links": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/link" } }, "link": { "description": "A link **MUST** be represented as either: a string containing the link's URL or a link object.", "oneOf": [ { "description": "A string containing the link's URL.", "type": "string", "format": "uri-reference" }, { "type": "object", "required": ["href"], "properties": { "href": { "description": "A string containing the link's URL.", "type": "string", "format": "uri-reference" }, "meta": { "$ref": "#/components/schemas/meta" } } } ] }, "attributes": { "description": "Members of the attributes object (\"attributes\") represent information about the resource object in which it's defined.", "type": "object", "additionalProperties": true }, "relationships": { "description": "Members of the relationships object (\"relationships\") represent references from the resource object in which it's defined to other resource objects.", "type": "object", "anyOf": [ { "required": ["data"] }, { "required": ["meta"] }, { "required": ["links"] }, { "type": "object", "properties": { "links": { "$ref": "#/components/schemas/relationshipLinks" }, "data": { "description": "Member, whose value represents \"resource linkage\".", "oneOf": [ { "$ref": "#/components/schemas/relationshipToOne" }, { "$ref": "#/components/schemas/relationshipToMany" } ] } } } ], "additionalProperties": false }, "relationshipToOne": { "allOf": [ { "description": "References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object." }, { "$ref": "#/components/schemas/linkage" } ] }, "relationshipToMany": { "description": "An array of objects each containing \\\"type\\\" and \\\"id\\\" members for to-many relationships.", "type": "array", "items": { "$ref": "#/components/schemas/linkage" }, "uniqueItems": true }, "linkage": { "description": "The \"type\" and \"id\" to non-empty members.", "required": ["type", "id"], "properties": { "type": { "type": "string" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "meta": { "$ref": "#/components/schemas/meta" } }, "type": "object", "additionalProperties": false }, "pagination": { "properties": { "first": { "description": "The first page of data", "type": "string", "format": "uri-reference" }, "last": { "description": "The last page of data", "type": "string", "format": "uri-reference" }, "prev": { "description": "The previous page of data", "type": "string", "format": "uri-reference" }, "next": { "description": "The next page of data", "type": "string", "format": "uri-reference" } }, "type": "object" }, "jsonapi": { "description": "An object describing the server's implementation", "properties": { "version": { "type": "string" }, "meta": { "$ref": "#/components/schemas/meta" } }, "type": "object", "additionalProperties": false }, "error": { "properties": { "id": { "type": "string", "description": "A unique identifier for this particular occurrence of the problem." }, "links": { "$ref": "#/components/schemas/links" }, "status": { "type": "string", "description": "The HTTP status code applicable to this problem, expressed as a string value." }, "code": { "type": "string", "description": "An application-specific error code, expressed as a string value." }, "title": { "type": "string", "description": "A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization." }, "detail": { "type": "string", "description": "A human-readable explanation specific to this occurrence of the problem." }, "description": { "type": "string", "description": "A human-readable description of the problem." }, "source": { "type": "object", "properties": { "pointer": { "type": "string", "description": "A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. \"/data\" for a primary data object, or \"/data/attributes/title\" for a specific attribute]." }, "parameter": { "type": "string", "description": "A string indicating which query parameter caused the error." } } }, "meta": { "$ref": "#/components/schemas/meta" } }, "type": "object", "additionalProperties": false }, "AclRole": { "description": "Added since version: 6.0.0.0", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" }, "AdvancedSearchAction": { "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" }, "AdvancedSearchActionSearchTerm": { "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" }, "AdvancedSearchBoosting": { "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" }, "AdvancedSearchConfig": { "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "hitCount": { "properties": { "product": { "properties": { "maxSuggestCount": { "type": "integer", "format": "int64" }, "maxSearchCount": { "type": "integer", "format": "int64" } }, "type": "object" }, "product_manufacturer": { "properties": { "maxSuggestCount": { "type": "integer", "format": "int64" }, "maxSearchCount": { "type": "integer", "format": "int64" } }, "type": "object" }, "category": { "properties": { "maxSuggestCount": { "type": "integer", "format": "int64" }, "maxSearchCount": { "type": "integer", "format": "int64" } }, "type": "object" } }, "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" }, "AdvancedSearchConfigField": { "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" }, "AdvancedSearchEntityStream": { "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" }, "AdvancedSearchEntityStreamFilter": { "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" }, "AdvancedSearchSynonym": { "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" }, "App": { "description": "Added since version: 6.3.1.0", "required": ["label"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" } }, "type": "object" }, "AppActionButton": { "description": "Added since version: 6.3.1.0", "required": ["label"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" } }, "type": "object" }, "AppAdministrationSnippet": { "description": "Added since version: 6.4.15.0", "required": ["value", "appId", "localeId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "value": { "type": "string" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "localeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" }, "AppCmsBlock": { "description": "Added since version: 6.4.2.0", "required": ["label"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" } }, "type": "object" }, "AppFlowAction": { "description": "Added since version: 6.4.10.0", "required": ["label"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" } }, "type": "object" }, "AppFlowEvent": { "description": "Added since version: 6.5.2.0", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" }, "AppPaymentMethod": { "description": "Added since version: 6.4.1.0", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" }, "AppScriptCondition": { "description": "Added since version: 6.4.10.3", "required": ["name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" } }, "type": "object" }, "AppShippingMethod": { "description": "Added since version: 6.5.7.0", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" }, "AppTemplate": { "description": "Added since version: 6.3.1.0", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" }, "B2bBusinessPartner": { "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" }, "B2bComponentsAdvancedProductCatalogs": { "description": "Added since version: 6.7.1.0", "required": ["id", "organizationId", "salesChannelId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "autoAddNewCategories": { "type": "boolean" }, "organizationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } } }, "type": "object" }, "B2bComponentsApprovalRule": { "description": "Added since version: 6.6.0.0", "required": ["id", "name", "priority", "active", "conditions"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "description": { "type": "string" }, "priority": { "type": "integer", "format": "int64" }, "active": { "type": "boolean" }, "conditions": { "type": "object" }, "reviewerRoleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "affectedRoleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "reviewerRole": { "$ref": "#/components/schemas/B2bComponentsRole" }, "affectedRole": { "$ref": "#/components/schemas/B2bComponentsRole" } }, "type": "object" }, "B2bComponentsApprovalRuleAppScriptCondition": { "description": "Added since version: 6.6.3.0", "required": ["name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" } }, "type": "object" }, "B2bComponentsOrganization": { "required": [ "id", "name", "customerId", "defaultShippingAddressId", "defaultBillingAddressId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "defaultShippingAddressId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "defaultBillingAddressId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "updatedById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "customer": { "$ref": "#/components/schemas/Customer" }, "employees": { "type": "array", "items": { "$ref": "#/components/schemas/B2bEmployee" } }, "organizationCustomerAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } }, "paymentMethods": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethod" } }, "shippingMethods": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingMethod" } }, "defaultShippingAddress": { "$ref": "#/components/schemas/CustomerAddress" }, "defaultBillingAddress": { "$ref": "#/components/schemas/CustomerAddress" }, "createdBy": { "$ref": "#/components/schemas/User" }, "updatedBy": { "$ref": "#/components/schemas/User" } }, "type": "object" }, "B2bComponentsOrganizationCustomerAddress": { "required": ["id", "organizationId", "customerAddressId", "type"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "organizationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerAddressId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "type": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "customerAddress": { "$ref": "#/components/schemas/CustomerAddress" } }, "type": "object" }, "B2bComponentsPendingOrder": { "description": "Added since version: 6.6.0.0", "required": [ "id", "billingAddressId", "customerId", "employeeId", "stateId", "currencyId", "countryId", "salesChannelId", "shippingMethodId", "paymentMethodId", "languageId", "cartPayload" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "billingAddressId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "employeeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "decidedById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "approvalRuleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "cartPayload": { "type": "string" }, "price": { "required": [ "netPrice", "totalPrice", "positionPrice", "rawTotal", "taxStatus" ], "properties": { "netPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "positionPrice": { "type": "number", "format": "float" }, "rawTotal": { "type": "number", "format": "float" }, "taxStatus": { "type": "string" } }, "type": "object" }, "originalPrice": { "type": "number", "format": "float" }, "taxStatus": { "type": "string", "readOnly": true }, "amountTotal": { "type": "number", "format": "float", "readOnly": true }, "amountNet": { "type": "number", "format": "float", "readOnly": true }, "reason": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "order": { "$ref": "#/components/schemas/Order" }, "billingAddress": { "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" }, "customer": { "$ref": "#/components/schemas/Customer" }, "employee": { "$ref": "#/components/schemas/B2bEmployee" }, "decidedBy": { "$ref": "#/components/schemas/B2bEmployee" }, "approvalRule": { "$ref": "#/components/schemas/B2bComponentsApprovalRule" }, "stateMachineState": { "$ref": "#/components/schemas/StateMachineState" }, "currency": { "$ref": "#/components/schemas/Currency" }, "country": { "$ref": "#/components/schemas/Country" }, "language": { "$ref": "#/components/schemas/Language" }, "paymentMethod": { "$ref": "#/components/schemas/PaymentMethod" }, "shippingMethod": { "$ref": "#/components/schemas/ShippingMethod" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } }, "type": "object" }, "B2bComponentsPendingOrderAddress": { "description": "Added since version: 6.6.0.0", "required": [ "id", "countryId", "firstName", "lastName", "street", "city" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryStateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "street": { "type": "string" }, "zipcode": { "type": "string" }, "city": { "type": "string" }, "company": { "type": "string" }, "department": { "type": "string" }, "title": { "type": "string" }, "vatId": { "type": "string" }, "phoneNumber": { "type": "string" }, "additionalAddressLine1": { "type": "string" }, "additionalAddressLine2": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "country": { "$ref": "#/components/schemas/Country" }, "countryState": { "$ref": "#/components/schemas/CountryState" }, "pendingOrder": { "$ref": "#/components/schemas/B2bComponentsPendingOrder" }, "salutation": { "$ref": "#/components/schemas/Salutation" } }, "type": "object" }, "B2bComponentsRole": { "required": ["id", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "object", "additionalProperties": false } }, "customFields": { "type": "object" }, "default": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" }, "B2bComponentsShoppingListJsonApi": { "description": "Added since version: 6.6.2.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "salesChannelId", "customerId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "updatedById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "employeeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "price": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "organization": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/organization" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_organization" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "b4c1948c087fafc89a88450fcbb64c77" } } } }, "type": "object" } }, "type": "object" }, "relationships": { "properties": { "customer": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/customer" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, "employee": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/employee" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_employee" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "fa5473530e4d1a5a1e1eb53d2fedb10c" } } } }, "type": "object" }, "lineItems": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/lineItems" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_shopping_list_line_item" }, "id": { "type": "string", "example": "a042af1aa9f3853fe3cd7dabc065568f" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "B2bComponentsShoppingList": { "description": "Added since version: 6.6.2.0", "required": ["id", "salesChannelId", "customerId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "updatedById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "employeeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "price": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "organization": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/organization" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_organization" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "b4c1948c087fafc89a88450fcbb64c77" } } } }, "type": "object" } }, "type": "object" }, "customer": { "$ref": "#/components/schemas/Customer" }, "employee": { "$ref": "#/components/schemas/B2bEmployee" }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } }, "type": "object" }, "B2bComponentsShoppingListLineItemJsonApi": { "description": "Added since version: 6.6.2.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "quantity"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "quantity": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "product": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-shopping-list-line-item/30d48c8d92682de24e11d3f72c5dd1ea/product" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "B2bComponentsShoppingListLineItem": { "description": "Added since version: 6.6.2.0", "required": ["id", "quantity"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "quantity": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "product": { "$ref": "#/components/schemas/Product" } }, "type": "object" }, "B2bEmployee": { "required": ["id", "languageId", "firstName", "lastName", "email"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "customFields": { "type": "object" }, "status": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "role": { "$ref": "#/components/schemas/B2bComponentsRole" }, "language": { "$ref": "#/components/schemas/Language" } }, "type": "object" }, "B2bOrderEmployee": { "required": ["firstName", "lastName"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" }, "B2bPermission": { "required": ["id", "name", "group"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "group": { "type": "string" }, "dependencies": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" }, "CategoryJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "afterCategoryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "afterCategoryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "displayNestedProducts": { "type": "boolean" }, "breadcrumb": { "type": "array", "items": { "type": "object", "additionalProperties": false }, "readOnly": true }, "level": { "type": "integer", "format": "int64", "readOnly": true }, "path": { "type": "string", "readOnly": true }, "childCount": { "type": "integer", "format": "int64", "readOnly": true }, "type": { "type": "string" }, "productAssignmentType": { "type": "string" }, "visible": { "type": "boolean" }, "active": { "type": "boolean" }, "cmsPageIdSwitched": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "boolean" },