From 46310e32d001815554e7f248850175399ef0c658 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Sun, 18 Aug 2024 16:55:04 +0200 Subject: [PATCH] chore(docs): Generated API Reference (v2) (#8643) Co-authored-by: kodiakhq --- .../Shell/admin_payment-collections/post.sh | 6 + .../code_samples/Shell/admin_users/post.sh | 5 - .../AdminPaymentCollectionResponse.yaml | 8 + .../schemas/CreateCartWorkflowInput.yaml | 60 + .../admin/components/schemas/CreateUser.yaml | 26 - .../components/schemas/UpdateCartData.yaml | 44 + .../specs/admin/openapi.full.yaml | 8167 ++++------------- .../api-reference/specs/admin/openapi.yaml | 5 + .../specs/admin/paths/admin_campaigns.yaml | 127 +- .../admin/paths/admin_campaigns_{id}.yaml | 106 +- .../specs/admin/paths/admin_customers.yaml | 69 +- .../admin/paths/admin_customers_{id}.yaml | 69 +- .../paths/admin_customers_{id}_addresses.yaml | 137 +- ...customers_{id}_addresses_{address_id}.yaml | 137 +- .../specs/admin/paths/admin_draft-orders.yaml | 564 +- .../admin/paths/admin_exchanges_{id}.yaml | 16 +- .../specs/admin/paths/admin_order-edits.yaml | 16 +- .../admin/paths/admin_order-edits_{id}.yaml | 16 +- .../paths/admin_order-edits_{id}_confirm.yaml | 20 +- .../paths/admin_order-edits_{id}_items.yaml | 16 +- ...in_order-edits_{id}_items_{action_id}.yaml | 32 +- ...dmin_order-edits_{id}_shipping-method.yaml | 16 +- ...dits_{id}_shipping-method_{action_id}.yaml | 32 +- .../paths/admin_orders_{id}_complete.yaml | 24 +- .../paths/admin_orders_{id}_fulfillments.yaml | 76 +- ..._fulfillments_{fulfillment_id}_cancel.yaml | 22 +- ...lfillments_{fulfillment_id}_shipments.yaml | 113 +- .../paths/admin_payment-collections.yaml | 107 + .../specs/admin/paths/admin_products.yaml | 3966 +------- .../admin/paths/admin_products_{id}.yaml | 154 +- .../paths/admin_products_{id}_options.yaml | 987 +- ...min_products_{id}_options_{option_id}.yaml | 23 +- .../paths/admin_products_{id}_variants.yaml | 87 +- ...n_products_{id}_variants_{variant_id}.yaml | 87 +- .../specs/admin/paths/admin_promotions.yaml | 523 +- .../admin/paths/admin_promotions_{id}.yaml | 516 +- .../specs/admin/paths/admin_users.yaml | 93 - .../AdminPaymentCollectionResponse.yaml | 8 + .../schemas/CreateCartWorkflowInput.yaml | 60 + .../store/components/schemas/CreateUser.yaml | 26 - .../components/schemas/UpdateCartData.yaml | 44 + .../specs/store/openapi.full.yaml | 256 +- .../specs/store/paths/store_carts.yaml | 68 +- .../specs/store/paths/store_carts_{id}.yaml | 52 +- .../oas-output/base/admin.oas.base.yaml | 3 + .../admin/delete_admin_order-edits_[id].ts | 16 +- ...dmin_order-edits_[id]_items_[action_id].ts | 16 +- ...-edits_[id]_shipping-method_[action_id].ts | 16 +- .../admin/get_admin_exchanges_[id].ts | 16 +- .../operations/admin/get_admin_products.ts | 3814 +------- .../admin/get_admin_products_[id]_options.ts | 964 +- .../operations/admin/post_admin_campaigns.ts | 126 +- .../admin/post_admin_campaigns_[id].ts | 105 +- .../operations/admin/post_admin_customers.ts | 68 +- .../admin/post_admin_customers_[id].ts | 68 +- .../post_admin_customers_[id]_addresses.ts | 136 +- ...n_customers_[id]_addresses_[address_id].ts | 136 +- .../admin/post_admin_draft-orders.ts | 563 +- .../admin/post_admin_order-edits.ts | 16 +- .../post_admin_order-edits_[id]_confirm.ts | 20 +- .../post_admin_order-edits_[id]_items.ts | 16 +- ...dmin_order-edits_[id]_items_[action_id].ts | 16 +- ..._admin_order-edits_[id]_shipping-method.ts | 16 +- ...-edits_[id]_shipping-method_[action_id].ts | 16 +- .../admin/post_admin_orders_[id]_complete.ts | 23 +- .../post_admin_orders_[id]_fulfillments.ts | 75 +- ...d]_fulfillments_[fulfillment_id]_cancel.ts | 21 +- ...fulfillments_[fulfillment_id]_shipments.ts | 112 +- ...s.ts => post_admin_payment-collections.ts} | 55 +- .../operations/admin/post_admin_products.ts | 151 +- .../admin/post_admin_products_[id].ts | 153 +- .../admin/post_admin_products_[id]_options.ts | 22 +- ...admin_products_[id]_options_[option_id].ts | 22 +- .../post_admin_products_[id]_variants.ts | 86 +- ...min_products_[id]_variants_[variant_id].ts | 86 +- .../operations/admin/post_admin_promotions.ts | 522 +- .../admin/post_admin_promotions_[id].ts | 515 +- .../operations/store/post_store_carts.ts | 67 +- .../operations/store/post_store_carts_[id].ts | 51 +- .../schemas/AdminPaymentCollectionResponse.ts | 13 + .../schemas/CreateCartWorkflowInput.ts | 65 + .../oas-output/schemas/CreateUser.ts | 31 - .../oas-output/schemas/UpdateCartData.ts | 49 + 83 files changed, 5312 insertions(+), 19940 deletions(-) create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_payment-collections/post.sh delete mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_users/post.sh create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollectionResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/CreateCartWorkflowInput.yaml delete mode 100644 www/apps/api-reference/specs/admin/components/schemas/CreateUser.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/UpdateCartData.yaml create mode 100644 www/apps/api-reference/specs/admin/paths/admin_payment-collections.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminPaymentCollectionResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/CreateCartWorkflowInput.yaml delete mode 100644 www/apps/api-reference/specs/store/components/schemas/CreateUser.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/UpdateCartData.yaml rename www/utils/generated/oas-output/operations/admin/{post_admin_users.ts => post_admin_payment-collections.ts} (57%) create mode 100644 www/utils/generated/oas-output/schemas/AdminPaymentCollectionResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/CreateCartWorkflowInput.ts delete mode 100644 www/utils/generated/oas-output/schemas/CreateUser.ts create mode 100644 www/utils/generated/oas-output/schemas/UpdateCartData.ts diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payment-collections/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payment-collections/post.sh new file mode 100644 index 0000000000..875f6770ff --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payment-collections/post.sh @@ -0,0 +1,6 @@ +curl -X POST '{backend_url}/admin/payment-collections' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "order_id": "{value}" +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_users/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_users/post.sh deleted file mode 100644 index 086927eca5..0000000000 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_users/post.sh +++ /dev/null @@ -1,5 +0,0 @@ -curl -X POST '{backend_url}/admin/users' \ --H 'Content-Type: application/json' \ ---data-raw '{ - "email": "Janie42@hotmail.com" -}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollectionResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollectionResponse.yaml new file mode 100644 index 0000000000..ccbf99b8f1 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollectionResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminPaymentCollectionResponse +required: + - payment_collection +properties: + payment_collection: + $ref: ./AdminPaymentCollection.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/CreateCartWorkflowInput.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateCartWorkflowInput.yaml new file mode 100644 index 0000000000..369ef9b3a1 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/CreateCartWorkflowInput.yaml @@ -0,0 +1,60 @@ +type: object +description: SUMMARY +x-schemaName: CreateCartWorkflowInput +properties: + region_id: + type: string + title: region_id + description: The cart's region id. + customer_id: + type: string + title: customer_id + description: The cart's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The cart's sales channel id. + email: + type: string + title: email + description: The cart's email. + format: email + currency_code: + type: string + title: currency_code + description: The cart's currency code. + shipping_address_id: + type: string + title: shipping_address_id + description: The cart's shipping address id. + billing_address_id: + type: string + title: billing_address_id + description: The cart's billing address id. + shipping_address: + oneOf: + - type: string + title: shipping_address + description: The cart's shipping address. + - $ref: ./CreateCartAddress.yaml + billing_address: + oneOf: + - type: string + title: billing_address + description: The cart's billing address. + - $ref: ./CreateCartAddress.yaml + metadata: + type: object + description: The cart's metadata. + items: + type: array + description: The cart's items. + items: + $ref: ./CreateCartCreateLineItem.yaml + promo_codes: + type: array + description: The cart's promo codes. + items: + type: string + title: promo_codes + description: The promo code's promo codes. diff --git a/www/apps/api-reference/specs/admin/components/schemas/CreateUser.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateUser.yaml deleted file mode 100644 index 3dfd4dcddb..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/CreateUser.yaml +++ /dev/null @@ -1,26 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: CreateUser -required: - - email -properties: - email: - type: string - title: email - description: The user's email. - format: email - first_name: - type: string - title: first_name - description: The user's first name. - last_name: - type: string - title: last_name - description: The user's last name. - avatar_url: - type: string - title: avatar_url - description: The user's avatar url. - metadata: - type: object - description: The user's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/UpdateCartData.yaml b/www/apps/api-reference/specs/admin/components/schemas/UpdateCartData.yaml new file mode 100644 index 0000000000..0b29d94268 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/UpdateCartData.yaml @@ -0,0 +1,44 @@ +type: object +description: SUMMARY +x-schemaName: UpdateCartData +properties: + region_id: + type: string + title: region_id + description: The cart's region id. + customer_id: + type: string + title: customer_id + description: The cart's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The cart's sales channel id. + email: + type: string + title: email + description: The cart's email. + format: email + currency_code: + type: string + title: currency_code + description: The cart's currency code. + shipping_address_id: + type: string + title: shipping_address_id + description: The cart's shipping address id. + billing_address_id: + type: string + title: billing_address_id + description: The cart's billing address id. + billing_address: + oneOf: + - $ref: ./CreateAddress.yaml + - $ref: ./UpdateAddress.yaml + shipping_address: + oneOf: + - $ref: ./CreateAddress.yaml + - $ref: ./UpdateAddress.yaml + metadata: + type: object + description: The cart's metadata. diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml index 1945be146d..0ca753645b 100644 --- a/www/apps/api-reference/specs/admin/openapi.full.yaml +++ b/www/apps/api-reference/specs/admin/openapi.full.yaml @@ -68,6 +68,9 @@ tags: - name: Orders x-associatedSchema: $ref: '#/components/schemas/AdminOrder' + - name: Payment Collections + x-associatedSchema: + $ref: '#/components/schemas/AdminPaymentCollection' - name: Payments x-associatedSchema: $ref: '#/components/schemas/AdminPayment' @@ -975,64 +978,80 @@ paths: content: application/json: schema: - description: SUMMARY - properties: - name: - type: string - title: name - description: The campaign's name. - campaign_identifier: - type: string - title: campaign_identifier - description: The campaign's campaign identifier. - description: - type: string - title: description - description: The campaign's description. - budget: - type: object - description: The campaign's budget. + allOf: + - type: object + description: SUMMARY required: - - type - - limit - - currency_code + - name + - campaign_identifier + - description + - budget + - starts_at + - ends_at properties: - type: + name: type: string - enum: - - spend - - usage - limit: - type: number - title: limit - description: The budget's limit. - currency_code: + title: name + description: The campaign's name. + campaign_identifier: type: string - title: currency_code - description: The budget's currency code. - starts_at: - type: string - title: starts_at - description: The campaign's starts at. - format: date-time - ends_at: - type: string - title: ends_at - description: The campaign's ends at. - format: date-time - promotions: - type: array - description: The campaign's promotions. - items: - type: object - description: The promotion's promotions. - required: - - id - properties: - id: - type: string - title: id - description: The promotion's ID. + title: campaign_identifier + description: The campaign's campaign identifier. + description: + type: string + title: description + description: The campaign's description. + budget: + type: object + description: The campaign's budget. + required: + - type + - limit + - currency_code + properties: + type: + type: string + enum: + - spend + - usage + limit: + type: number + title: limit + description: The budget's limit. + currency_code: + type: string + title: currency_code + description: The budget's currency code. + starts_at: + type: string + title: starts_at + description: The campaign's starts at. + format: date-time + ends_at: + type: string + title: ends_at + description: The campaign's ends at. + format: date-time + promotions: + type: array + description: The campaign's promotions. + items: + type: object + description: The promotion's promotions. + required: + - id + properties: + id: + type: string + title: id + description: The promotion's ID. + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. + description: SUMMARY x-codeSamples: - lang: Shell label: cURL @@ -1212,53 +1231,66 @@ paths: content: application/json: schema: - description: SUMMARY - properties: - name: - type: string - title: name - description: The campaign's name. - campaign_identifier: - type: string - title: campaign_identifier - description: The campaign's campaign identifier. - description: - type: string - title: description - description: The campaign's description. - budget: - type: object - description: The campaign's budget. + allOf: + - type: object + description: SUMMARY required: - - limit + - description + - starts_at + - ends_at properties: - limit: - type: number - title: limit - description: The budget's limit. - starts_at: - type: string - title: starts_at - description: The campaign's starts at. - format: date-time - ends_at: - type: string - title: ends_at - description: The campaign's ends at. - format: date-time - promotions: - type: array - description: The campaign's promotions. - items: - type: object - description: The promotion's promotions. - required: - - id - properties: - id: - type: string - title: id - description: The promotion's ID. + name: + type: string + title: name + description: The campaign's name. + campaign_identifier: + type: string + title: campaign_identifier + description: The campaign's campaign identifier. + description: + type: string + title: description + description: The campaign's description. + budget: + type: object + description: The campaign's budget. + required: + - limit + properties: + limit: + type: number + title: limit + description: The budget's limit. + starts_at: + type: string + title: starts_at + description: The campaign's starts at. + format: date-time + ends_at: + type: string + title: ends_at + description: The campaign's ends at. + format: date-time + promotions: + type: array + description: The campaign's promotions. + items: + type: object + description: The promotion's promotions. + required: + - id + properties: + id: + type: string + title: id + description: The promotion's ID. + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. + description: SUMMARY x-codeSamples: - lang: Shell label: cURL @@ -4830,32 +4862,48 @@ paths: content: application/json: schema: + allOf: + - type: object + description: SUMMARY + required: + - email + - company_name + - first_name + - last_name + - phone + - metadata + properties: + email: + type: string + title: email + description: The customer's email. + format: email + company_name: + type: string + title: company_name + description: The customer's company name. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + phone: + type: string + title: phone + description: The customer's phone. + metadata: + type: object + description: The customer's metadata. + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. description: SUMMARY - properties: - email: - type: string - title: email - description: The customer's email. - format: email - company_name: - type: string - title: company_name - description: The customer's company name. - first_name: - type: string - title: first_name - description: The customer's first name. - last_name: - type: string - title: last_name - description: The customer's last name. - phone: - type: string - title: phone - description: The customer's phone. - metadata: - type: object - description: The customer's metadata. x-codeSamples: - lang: Shell label: cURL @@ -5036,32 +5084,48 @@ paths: content: application/json: schema: + allOf: + - type: object + description: SUMMARY + required: + - email + - company_name + - first_name + - last_name + - phone + - metadata + properties: + email: + type: string + title: email + description: The customer's email. + format: email + company_name: + type: string + title: company_name + description: The customer's company name. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + phone: + type: string + title: phone + description: The customer's phone. + metadata: + type: object + description: The customer's metadata. + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. description: SUMMARY - properties: - email: - type: string - title: email - description: The customer's email. - format: email - company_name: - type: string - title: company_name - description: The customer's company name. - first_name: - type: string - title: first_name - description: The customer's first name. - last_name: - type: string - title: last_name - description: The customer's last name. - phone: - type: string - title: phone - description: The customer's phone. - metadata: - type: object - description: The customer's metadata. x-codeSamples: - lang: Shell label: cURL @@ -5375,63 +5439,85 @@ paths: content: application/json: schema: + allOf: + - type: object + description: SUMMARY + required: + - address_name + - company + - first_name + - last_name + - address_1 + - address_2 + - city + - country_code + - province + - postal_code + - phone + - metadata + properties: + address_name: + type: string + title: address_name + description: The customer's address name. + is_default_shipping: + type: boolean + title: is_default_shipping + description: The customer's is default shipping. + is_default_billing: + type: boolean + title: is_default_billing + description: The customer's is default billing. + company: + type: string + title: company + description: The customer's company. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + address_1: + type: string + title: address_1 + description: The customer's address 1. + address_2: + type: string + title: address_2 + description: The customer's address 2. + city: + type: string + title: city + description: The customer's city. + country_code: + type: string + title: country_code + description: The customer's country code. + province: + type: string + title: province + description: The customer's province. + postal_code: + type: string + title: postal_code + description: The customer's postal code. + phone: + type: string + title: phone + description: The customer's phone. + metadata: + type: object + description: The customer's metadata. + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. description: SUMMARY - properties: - address_name: - type: string - title: address_name - description: The customer's address name. - is_default_shipping: - type: boolean - title: is_default_shipping - description: The customer's is default shipping. - is_default_billing: - type: boolean - title: is_default_billing - description: The customer's is default billing. - company: - type: string - title: company - description: The customer's company. - first_name: - type: string - title: first_name - description: The customer's first name. - last_name: - type: string - title: last_name - description: The customer's last name. - address_1: - type: string - title: address_1 - description: The customer's address 1. - address_2: - type: string - title: address_2 - description: The customer's address 2. - city: - type: string - title: city - description: The customer's city. - country_code: - type: string - title: country_code - description: The customer's country code. - province: - type: string - title: province - description: The customer's province. - postal_code: - type: string - title: postal_code - description: The customer's postal code. - phone: - type: string - title: phone - description: The customer's phone. - metadata: - type: object - description: The customer's metadata. x-codeSamples: - lang: Shell label: cURL @@ -5630,63 +5716,85 @@ paths: content: application/json: schema: + allOf: + - type: object + description: SUMMARY + required: + - address_name + - company + - first_name + - last_name + - address_1 + - address_2 + - city + - country_code + - province + - postal_code + - phone + - metadata + properties: + address_name: + type: string + title: address_name + description: The customer's address name. + is_default_shipping: + type: boolean + title: is_default_shipping + description: The customer's is default shipping. + is_default_billing: + type: boolean + title: is_default_billing + description: The customer's is default billing. + company: + type: string + title: company + description: The customer's company. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + address_1: + type: string + title: address_1 + description: The customer's address 1. + address_2: + type: string + title: address_2 + description: The customer's address 2. + city: + type: string + title: city + description: The customer's city. + country_code: + type: string + title: country_code + description: The customer's country code. + province: + type: string + title: province + description: The customer's province. + postal_code: + type: string + title: postal_code + description: The customer's postal code. + phone: + type: string + title: phone + description: The customer's phone. + metadata: + type: object + description: The customer's metadata. + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. description: SUMMARY - properties: - address_name: - type: string - title: address_name - description: The customer's address name. - is_default_shipping: - type: boolean - title: is_default_shipping - description: The customer's is default shipping. - is_default_billing: - type: boolean - title: is_default_billing - description: The customer's is default billing. - company: - type: string - title: company - description: The customer's company. - first_name: - type: string - title: first_name - description: The customer's first name. - last_name: - type: string - title: last_name - description: The customer's last name. - address_1: - type: string - title: address_1 - description: The customer's address 1. - address_2: - type: string - title: address_2 - description: The customer's address 2. - city: - type: string - title: city - description: The customer's city. - country_code: - type: string - title: country_code - description: The customer's country code. - province: - type: string - title: province - description: The customer's province. - postal_code: - type: string - title: postal_code - description: The customer's postal code. - phone: - type: string - title: phone - description: The customer's phone. - metadata: - type: object - description: The customer's metadata. x-codeSamples: - lang: Shell label: cURL @@ -5997,279 +6105,296 @@ paths: content: application/json: schema: + allOf: + - type: object + description: SUMMARY + required: + - sales_channel_id + - email + - customer_id + - region_id + - currency_code + - shipping_methods + - metadata + properties: + status: + type: boolean + title: status + description: The draft order's status. + sales_channel_id: + type: string + title: sales_channel_id + description: The draft order's sales channel id. + email: + type: string + title: email + description: The draft order's email. + format: email + customer_id: + type: string + title: customer_id + description: The draft order's customer id. + billing_address: + type: object + description: The draft order's billing address. + required: + - first_name + - last_name + - phone + - company + - address_1 + - address_2 + - city + - country_code + - province + - postal_code + - metadata + properties: + first_name: + type: string + title: first_name + description: The billing address's first name. + last_name: + type: string + title: last_name + description: The billing address's last name. + phone: + type: string + title: phone + description: The billing address's phone. + company: + type: string + title: company + description: The billing address's company. + address_1: + type: string + title: address_1 + description: The billing address's address 1. + address_2: + type: string + title: address_2 + description: The billing address's address 2. + city: + type: string + title: city + description: The billing address's city. + country_code: + type: string + title: country_code + description: The billing address's country code. + province: + type: string + title: province + description: The billing address's province. + postal_code: + type: string + title: postal_code + description: The billing address's postal code. + metadata: + type: object + description: The billing address's metadata. + shipping_address: + type: object + description: The draft order's shipping address. + required: + - first_name + - last_name + - phone + - company + - address_1 + - address_2 + - city + - country_code + - province + - postal_code + - metadata + properties: + first_name: + type: string + title: first_name + description: The shipping address's first name. + last_name: + type: string + title: last_name + description: The shipping address's last name. + phone: + type: string + title: phone + description: The shipping address's phone. + company: + type: string + title: company + description: The shipping address's company. + address_1: + type: string + title: address_1 + description: The shipping address's address 1. + address_2: + type: string + title: address_2 + description: The shipping address's address 2. + city: + type: string + title: city + description: The shipping address's city. + country_code: + type: string + title: country_code + description: The shipping address's country code. + province: + type: string + title: province + description: The shipping address's province. + postal_code: + type: string + title: postal_code + description: The shipping address's postal code. + metadata: + type: object + description: The shipping address's metadata. + items: + type: array + description: The draft order's items. + items: + type: object + description: The item's items. + required: + - title + - sku + - barcode + - variant_id + - unit_price + - quantity + - metadata + properties: + title: + type: string + title: title + description: The item's title. + sku: + type: string + title: sku + description: The item's sku. + barcode: + type: string + title: barcode + description: The item's barcode. + variant_id: + type: string + title: variant_id + description: The item's variant id. + unit_price: + oneOf: + - type: string + title: unit_price + description: The item's unit price. + - type: number + title: unit_price + description: The item's unit price. + - type: object + description: The item's unit price. + required: + - value + - precision + properties: + value: + type: string + title: value + description: The unit price's value. + precision: + type: number + title: precision + description: The unit price's precision. + quantity: + type: number + title: quantity + description: The item's quantity. + metadata: + type: object + description: The item's metadata. + region_id: + type: string + title: region_id + description: The draft order's region id. + promo_codes: + type: array + description: The draft order's promo codes. + items: + type: string + title: promo_codes + description: The promo code's promo codes. + currency_code: + type: string + title: currency_code + description: The draft order's currency code. + no_notification_order: + type: boolean + title: no_notification_order + description: The draft order's no notification order. + shipping_methods: + type: array + description: The draft order's shipping methods. + items: + type: object + description: The shipping method's shipping methods. + required: + - shipping_method_id + - order_id + - name + - option_id + - amount + properties: + shipping_method_id: + type: string + title: shipping_method_id + description: The shipping method's shipping method id. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + option_id: + type: string + title: option_id + description: The shipping method's option id. + data: + type: object + description: The shipping method's data. + amount: + oneOf: + - type: string + title: amount + description: The shipping method's amount. + - type: number + title: amount + description: The shipping method's amount. + - type: object + description: The shipping method's amount. + required: + - value + - precision + properties: + value: + type: string + title: value + description: The amount's value. + precision: + type: number + title: precision + description: The amount's precision. + metadata: + type: object + description: The draft order's metadata. + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. description: SUMMARY - properties: - status: - type: boolean - title: status - description: The draft order's status. - sales_channel_id: - type: string - title: sales_channel_id - description: The draft order's sales channel id. - email: - type: string - title: email - description: The draft order's email. - format: email - customer_id: - type: string - title: customer_id - description: The draft order's customer id. - billing_address: - type: object - description: The draft order's billing address. - required: - - first_name - - last_name - - phone - - company - - address_1 - - address_2 - - city - - country_code - - province - - postal_code - - metadata - properties: - first_name: - type: string - title: first_name - description: The billing address's first name. - last_name: - type: string - title: last_name - description: The billing address's last name. - phone: - type: string - title: phone - description: The billing address's phone. - company: - type: string - title: company - description: The billing address's company. - address_1: - type: string - title: address_1 - description: The billing address's address 1. - address_2: - type: string - title: address_2 - description: The billing address's address 2. - city: - type: string - title: city - description: The billing address's city. - country_code: - type: string - title: country_code - description: The billing address's country code. - province: - type: string - title: province - description: The billing address's province. - postal_code: - type: string - title: postal_code - description: The billing address's postal code. - metadata: - type: object - description: The billing address's metadata. - shipping_address: - type: object - description: The draft order's shipping address. - required: - - first_name - - last_name - - phone - - company - - address_1 - - address_2 - - city - - country_code - - province - - postal_code - - metadata - properties: - first_name: - type: string - title: first_name - description: The shipping address's first name. - last_name: - type: string - title: last_name - description: The shipping address's last name. - phone: - type: string - title: phone - description: The shipping address's phone. - company: - type: string - title: company - description: The shipping address's company. - address_1: - type: string - title: address_1 - description: The shipping address's address 1. - address_2: - type: string - title: address_2 - description: The shipping address's address 2. - city: - type: string - title: city - description: The shipping address's city. - country_code: - type: string - title: country_code - description: The shipping address's country code. - province: - type: string - title: province - description: The shipping address's province. - postal_code: - type: string - title: postal_code - description: The shipping address's postal code. - metadata: - type: object - description: The shipping address's metadata. - items: - type: array - description: The draft order's items. - items: - type: object - description: The item's items. - required: - - title - - sku - - barcode - - variant_id - - unit_price - - quantity - - metadata - properties: - title: - type: string - title: title - description: The item's title. - sku: - type: string - title: sku - description: The item's sku. - barcode: - type: string - title: barcode - description: The item's barcode. - variant_id: - type: string - title: variant_id - description: The item's variant id. - unit_price: - oneOf: - - type: string - title: unit_price - description: The item's unit price. - - type: number - title: unit_price - description: The item's unit price. - - type: object - description: The item's unit price. - required: - - value - - precision - properties: - value: - type: string - title: value - description: The unit price's value. - precision: - type: number - title: precision - description: The unit price's precision. - quantity: - type: number - title: quantity - description: The item's quantity. - metadata: - type: object - description: The item's metadata. - region_id: - type: string - title: region_id - description: The draft order's region id. - promo_codes: - type: array - description: The draft order's promo codes. - items: - type: string - title: promo_codes - description: The promo code's promo codes. - currency_code: - type: string - title: currency_code - description: The draft order's currency code. - no_notification_order: - type: boolean - title: no_notification_order - description: The draft order's no notification order. - shipping_methods: - type: array - description: The draft order's shipping methods. - items: - type: object - description: The shipping method's shipping methods. - required: - - shipping_method_id - - order_id - - name - - option_id - - amount - properties: - shipping_method_id: - type: string - title: shipping_method_id - description: The shipping method's shipping method id. - order_id: - type: string - title: order_id - description: The shipping method's order id. - name: - type: string - title: name - description: The shipping method's name. - option_id: - type: string - title: option_id - description: The shipping method's option id. - data: - type: object - description: The shipping method's data. - amount: - oneOf: - - type: string - title: amount - description: The shipping method's amount. - - type: number - title: amount - description: The shipping method's amount. - - type: object - description: The shipping method's amount. - required: - - value - - precision - properties: - value: - type: string - title: value - description: The amount's value. - precision: - type: number - title: precision - description: The amount's precision. - metadata: - type: object - description: The draft order's metadata. x-codeSamples: - lang: Shell label: cURL @@ -6613,18 +6738,12 @@ paths: description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. required: false schema: type: string title: fields - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -11725,18 +11844,12 @@ paths: description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. required: false schema: type: string title: fields - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -11825,18 +11938,12 @@ paths: description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. required: false schema: type: string title: fields - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -11936,18 +12043,12 @@ paths: description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. required: false schema: type: string title: fields - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -12004,6 +12105,10 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: confirmOrderEditRequestWorkflow + requestBody: + content: + application/json: + schema: {} /admin/order-edits/{id}/items: post: operationId: PostOrderEditsIdItems @@ -12027,18 +12132,12 @@ paths: description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. required: false schema: type: string title: fields - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -12129,18 +12228,12 @@ paths: description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. required: false schema: type: string title: fields - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -12230,18 +12323,12 @@ paths: description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. required: false schema: type: string title: fields - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -12321,18 +12408,12 @@ paths: description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. required: false schema: type: string title: fields - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -12427,18 +12508,12 @@ paths: description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. required: false schema: type: string title: fields - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -12528,18 +12603,12 @@ paths: description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. required: false schema: type: string title: fields - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -13116,12 +13185,23 @@ paths: content: application/json: schema: + allOf: + - type: object + description: SUMMARY + required: + - order_id + properties: + order_id: + type: string + title: order_id + description: The order's order id. + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. description: SUMMARY - properties: - order_id: - type: string - title: order_id - description: The order's order id. x-codeSamples: - lang: Shell label: cURL @@ -13214,37 +13294,50 @@ paths: content: application/json: schema: + allOf: + - type: object + description: SUMMARY + required: + - items + - location_id + - metadata + properties: + items: + type: array + description: The order's items. + items: + type: object + description: The item's items. + required: + - id + - quantity + properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + location_id: + type: string + title: location_id + description: The order's location id. + no_notification: + type: boolean + title: no_notification + description: The order's no notification. + metadata: + type: object + description: The order's metadata. + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. description: SUMMARY - properties: - items: - type: array - description: The order's items. - items: - type: object - description: The item's items. - required: - - id - - quantity - properties: - id: - type: string - title: id - description: The item's ID. - quantity: - type: number - title: quantity - description: The item's quantity. - location_id: - type: string - title: location_id - description: The order's location id. - no_notification: - type: boolean - title: no_notification - description: The order's no notification. - metadata: - type: object - description: The order's metadata. x-codeSamples: - lang: Shell label: cURL @@ -13350,12 +13443,21 @@ paths: content: application/json: schema: + allOf: + - type: object + description: SUMMARY + properties: + no_notification: + type: boolean + title: no_notification + description: The order's no notification. + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. description: SUMMARY - properties: - no_notification: - type: boolean - title: no_notification - description: The order's no notification. x-codeSamples: - lang: Shell label: cURL @@ -13450,56 +13552,68 @@ paths: content: application/json: schema: + allOf: + - type: object + description: SUMMARY + required: + - items + - metadata + properties: + items: + type: array + description: The order's items. + items: + type: object + description: The item's items. + required: + - id + - quantity + properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + labels: + type: array + description: The order's labels. + items: + type: object + description: The label's labels. + required: + - tracking_number + - tracking_url + - label_url + properties: + tracking_number: + type: string + title: tracking_number + description: The label's tracking number. + tracking_url: + type: string + title: tracking_url + description: The label's tracking url. + label_url: + type: string + title: label_url + description: The label's label url. + no_notification: + type: boolean + title: no_notification + description: The order's no notification. + metadata: + type: object + description: The order's metadata. + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. description: SUMMARY - properties: - items: - type: array - description: The order's items. - items: - type: object - description: The item's items. - required: - - id - - quantity - properties: - id: - type: string - title: id - description: The item's ID. - quantity: - type: number - title: quantity - description: The item's quantity. - labels: - type: array - description: The order's labels. - items: - type: object - description: The label's labels. - required: - - tracking_number - - tracking_url - - label_url - properties: - tracking_number: - type: string - title: tracking_number - description: The label's tracking number. - tracking_url: - type: string - title: tracking_url - description: The label's tracking url. - label_url: - type: string - title: label_url - description: The label's label url. - no_notification: - type: boolean - title: no_notification - description: The order's no notification. - metadata: - type: object - description: The order's metadata. x-codeSamples: - lang: Shell label: cURL @@ -13621,6 +13735,112 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /admin/payment-collections: + post: + operationId: PostPaymentCollections + summary: Create Payment Collection + description: Create a payment collection. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - order_id + properties: + order_id: + type: string + title: order_id + description: The payment collection's order id. + amount: + type: number + title: amount + description: The payment collection's amount. + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/payment-collections' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "order_id": "{value}" + }' + tags: + - Payment Collections + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPaymentCollectionResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + x-workflow: createOrderPaymentCollectionWorkflow /admin/payments: get: operationId: GetPayments @@ -27730,1915 +27950,10 @@ paths: type: array description: The product's $and. items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - properties: - q: - type: string - title: q - description: The $and's q. - status: - oneOf: - - type: string - title: status - description: The $and's status. - - type: string - title: status - description: The $and's status. - - type: string - title: status - description: The $and's status. - - type: string - title: status - description: The $and's status. - - type: array - description: The $and's status. - items: - type: string - enum: - - draft - - proposed - - published - - rejected - sales_channel_id: - oneOf: - - type: string - title: sales_channel_id - description: The $and's sales channel id. - - type: array - description: The $and's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - title: - oneOf: - - type: string - title: title - description: The $and's title. - - type: array - description: The $and's title. - items: - type: string - title: title - description: The title's details. - handle: - oneOf: - - type: string - title: handle - description: The $and's handle. - - type: array - description: The $and's handle. - items: - type: string - title: handle - description: The handle's details. - id: - oneOf: - - type: string - title: id - description: The $and's ID. - - type: array - description: The $and's ID. - items: - type: string - title: id - description: The id's ID. - is_giftcard: - type: boolean - title: is_giftcard - description: The $and's is giftcard. - tags: - type: object - description: The $and's tags. - properties: - value: - type: array - description: The tag's value. - items: - type: string - title: value - description: The value's details. - type_id: - oneOf: - - type: string - title: type_id - description: The $and's type id. - - type: array - description: The $and's type id. - items: - type: string - title: type_id - description: The type id's details. - category_id: - oneOf: - - type: string - title: category_id - description: The $and's category id. - - type: array - description: The $and's category id. - items: - type: string - title: category_id - description: The category id's details. - - type: object - description: The $and's category id. - properties: - $and: - type: array - description: The category id's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The category id's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The category id's $eq. - - type: object - description: The category id's $eq. - x-schemaName: RegExp - - type: array - description: The category id's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The category id's $ne. - - type: object - description: The category id's $ne. - x-schemaName: RegExp - $in: - type: array - description: The category id's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The category id's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The category id's $not. - - type: object - description: The category id's $not. - x-schemaName: RegExp - - type: object - description: The category id's $not. - - type: array - description: The category id's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The category id's $gt. - - type: object - description: The category id's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The category id's $gte. - - type: object - description: The category id's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The category id's $lt. - - type: object - description: The category id's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The category id's $lte. - - type: object - description: The category id's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The category id's $like. - $re: - type: string - title: $re - description: The category id's $re. - $ilike: - type: string - title: $ilike - description: The category id's $ilike. - $fulltext: - type: string - title: $fulltext - description: The category id's $fulltext. - $overlap: - type: array - description: The category id's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The category id's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The category id's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The category id's $exists. - categories: - oneOf: - - type: object - description: The $and's categories. - required: - - id - properties: - id: - type: object - description: The category's ID. - - type: object - description: The $and's categories. - required: - - id - properties: - id: - type: object - description: The category's ID. - collection_id: - oneOf: - - type: string - title: collection_id - description: The $and's collection id. - - type: array - description: The $and's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - - type: object - description: The $and's collection id. - properties: - $and: - type: array - description: The collection id's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The collection id's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The collection id's $eq. - - type: object - description: The collection id's $eq. - x-schemaName: RegExp - - type: array - description: The collection id's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The collection id's $ne. - - type: object - description: The collection id's $ne. - x-schemaName: RegExp - $in: - type: array - description: The collection id's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The collection id's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The collection id's $not. - - type: object - description: The collection id's $not. - x-schemaName: RegExp - - type: object - description: The collection id's $not. - - type: array - description: The collection id's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The collection id's $gt. - - type: object - description: The collection id's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The collection id's $gte. - - type: object - description: The collection id's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The collection id's $lt. - - type: object - description: The collection id's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The collection id's $lte. - - type: object - description: The collection id's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The collection id's $like. - $re: - type: string - title: $re - description: The collection id's $re. - $ilike: - type: string - title: $ilike - description: The collection id's $ilike. - $fulltext: - type: string - title: $fulltext - description: The collection id's $fulltext. - $overlap: - type: array - description: The collection id's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The collection id's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The collection id's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The collection id's $exists. - created_at: - type: object - description: The $and's created at. - properties: - $and: - type: array - description: The created at's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The created at's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The created at's $eq. - - type: object - description: The created at's $eq. - x-schemaName: RegExp - - type: array - description: The created at's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The created at's $ne. - - type: object - description: The created at's $ne. - x-schemaName: RegExp - $in: - type: array - description: The created at's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The created at's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The created at's $not. - - type: object - description: The created at's $not. - x-schemaName: RegExp - - type: object - description: The created at's $not. - - type: array - description: The created at's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The created at's $gt. - - type: object - description: The created at's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The created at's $gte. - - type: object - description: The created at's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The created at's $lt. - - type: object - description: The created at's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The created at's $lte. - - type: object - description: The created at's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The created at's $like. - $re: - type: string - title: $re - description: The created at's $re. - $ilike: - type: string - title: $ilike - description: The created at's $ilike. - $fulltext: - type: string - title: $fulltext - description: The created at's $fulltext. - $overlap: - type: array - description: The created at's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The created at's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The created at's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The created at's $exists. - updated_at: - type: object - description: The $and's updated at. - properties: - $and: - type: array - description: The updated at's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The updated at's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The updated at's $eq. - - type: object - description: The updated at's $eq. - x-schemaName: RegExp - - type: array - description: The updated at's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The updated at's $ne. - - type: object - description: The updated at's $ne. - x-schemaName: RegExp - $in: - type: array - description: The updated at's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The updated at's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The updated at's $not. - - type: object - description: The updated at's $not. - x-schemaName: RegExp - - type: object - description: The updated at's $not. - - type: array - description: The updated at's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The updated at's $gt. - - type: object - description: The updated at's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The updated at's $gte. - - type: object - description: The updated at's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The updated at's $lt. - - type: object - description: The updated at's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The updated at's $lte. - - type: object - description: The updated at's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The updated at's $like. - $re: - type: string - title: $re - description: The updated at's $re. - $ilike: - type: string - title: $ilike - description: The updated at's $ilike. - $fulltext: - type: string - title: $fulltext - description: The updated at's $fulltext. - $overlap: - type: array - description: The updated at's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The updated at's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The updated at's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The updated at's $exists. - deleted_at: - type: object - description: The $and's deleted at. - properties: - $and: - type: array - description: The deleted at's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The deleted at's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The deleted at's $eq. - - type: object - description: The deleted at's $eq. - x-schemaName: RegExp - - type: array - description: The deleted at's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The deleted at's $ne. - - type: object - description: The deleted at's $ne. - x-schemaName: RegExp - $in: - type: array - description: The deleted at's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The deleted at's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The deleted at's $not. - - type: object - description: The deleted at's $not. - x-schemaName: RegExp - - type: object - description: The deleted at's $not. - - type: array - description: The deleted at's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The deleted at's $gt. - - type: object - description: The deleted at's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The deleted at's $gte. - - type: object - description: The deleted at's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The deleted at's $lt. - - type: object - description: The deleted at's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The deleted at's $lte. - - type: object - description: The deleted at's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The deleted at's $like. - $re: - type: string - title: $re - description: The deleted at's $re. - $ilike: - type: string - title: $ilike - description: The deleted at's $ilike. - $fulltext: - type: string - title: $fulltext - description: The deleted at's $fulltext. - $overlap: - type: array - description: The deleted at's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The deleted at's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The deleted at's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The deleted at's $exists. - limit: - type: number - title: limit - description: The $and's limit. - offset: - type: number - title: offset - description: The $and's offset. - order: - type: string - title: order - description: The $and's order. - fields: - type: string - title: fields - description: The $and's fields. - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - properties: - q: - type: string - title: q - description: The $and's q. - status: - oneOf: - - type: string - title: status - description: The $and's status. - - type: string - title: status - description: The $and's status. - - type: string - title: status - description: The $and's status. - - type: string - title: status - description: The $and's status. - - type: array - description: The $and's status. - items: - type: string - enum: - - draft - - proposed - - published - - rejected - sales_channel_id: - oneOf: - - type: string - title: sales_channel_id - description: The $and's sales channel id. - - type: array - description: The $and's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - title: - oneOf: - - type: string - title: title - description: The $and's title. - - type: array - description: The $and's title. - items: - type: string - title: title - description: The title's details. - handle: - oneOf: - - type: string - title: handle - description: The $and's handle. - - type: array - description: The $and's handle. - items: - type: string - title: handle - description: The handle's details. - id: - oneOf: - - type: string - title: id - description: The $and's ID. - - type: array - description: The $and's ID. - items: - type: string - title: id - description: The id's ID. - is_giftcard: - type: boolean - title: is_giftcard - description: The $and's is giftcard. - tags: - type: object - description: The $and's tags. - type_id: - oneOf: - - type: string - title: type_id - description: The $and's type id. - - type: array - description: The $and's type id. - items: - type: string - title: type_id - description: The type id's details. - category_id: - oneOf: - - type: string - title: category_id - description: The $and's category id. - - type: array - description: The $and's category id. - items: - type: string - title: category_id - description: The category id's details. - - type: object - description: The $and's category id. - categories: - oneOf: - - type: object - description: The $and's categories. - - type: object - description: The $and's categories. - collection_id: - oneOf: - - type: string - title: collection_id - description: The $and's collection id. - - type: array - description: The $and's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - - type: object - description: The $and's collection id. - created_at: - type: object - description: The $and's created at. - updated_at: - type: object - description: The $and's updated at. - deleted_at: - type: object - description: The $and's deleted at. - limit: - type: number - title: limit - description: The $and's limit. - offset: - type: number - title: offset - description: The $and's offset. - order: - type: string - title: order - description: The $and's order. - fields: - type: string - title: fields - description: The $and's fields. - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - - type: object - description: The $or's details. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - - type: object - description: The $or's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - properties: - q: - type: string - title: q - description: The $or's q. - status: - oneOf: - - type: string - title: status - description: The $or's status. - - type: string - title: status - description: The $or's status. - - type: string - title: status - description: The $or's status. - - type: string - title: status - description: The $or's status. - - type: array - description: The $or's status. - items: - type: string - enum: - - draft - - proposed - - published - - rejected - sales_channel_id: - oneOf: - - type: string - title: sales_channel_id - description: The $or's sales channel id. - - type: array - description: The $or's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - title: - oneOf: - - type: string - title: title - description: The $or's title. - - type: array - description: The $or's title. - items: - type: string - title: title - description: The title's details. - handle: - oneOf: - - type: string - title: handle - description: The $or's handle. - - type: array - description: The $or's handle. - items: - type: string - title: handle - description: The handle's details. - id: - oneOf: - - type: string - title: id - description: The $or's ID. - - type: array - description: The $or's ID. - items: - type: string - title: id - description: The id's ID. - is_giftcard: - type: boolean - title: is_giftcard - description: The $or's is giftcard. - tags: - type: object - description: The $or's tags. - type_id: - oneOf: - - type: string - title: type_id - description: The $or's type id. - - type: array - description: The $or's type id. - items: - type: string - title: type_id - description: The type id's details. - category_id: - oneOf: - - type: string - title: category_id - description: The $or's category id. - - type: array - description: The $or's category id. - items: - type: string - title: category_id - description: The category id's details. - - type: object - description: The $or's category id. - categories: - oneOf: - - type: object - description: The $or's categories. - - type: object - description: The $or's categories. - collection_id: - oneOf: - - type: string - title: collection_id - description: The $or's collection id. - - type: array - description: The $or's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - - type: object - description: The $or's collection id. - created_at: - type: object - description: The $or's created at. - updated_at: - type: object - description: The $or's updated at. - deleted_at: - type: object - description: The $or's deleted at. - limit: - type: number - title: limit - description: The $or's limit. - offset: - type: number - title: offset - description: The $or's offset. - order: - type: string - title: order - description: The $or's order. - fields: - type: string - title: fields - description: The $or's fields. - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - - type: object - description: The $or's details. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - - type: object - description: The $or's details. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - properties: - q: - type: string - title: q - description: The $and's q. - status: - oneOf: - - type: string - title: status - description: The $and's status. - - type: string - title: status - description: The $and's status. - - type: string - title: status - description: The $and's status. - - type: string - title: status - description: The $and's status. - - type: array - description: The $and's status. - items: - type: string - enum: - - draft - - proposed - - published - - rejected - sales_channel_id: - oneOf: - - type: string - title: sales_channel_id - description: The $and's sales channel id. - - type: array - description: The $and's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - title: - oneOf: - - type: string - title: title - description: The $and's title. - - type: array - description: The $and's title. - items: - type: string - title: title - description: The title's details. - handle: - oneOf: - - type: string - title: handle - description: The $and's handle. - - type: array - description: The $and's handle. - items: - type: string - title: handle - description: The handle's details. - id: - oneOf: - - type: string - title: id - description: The $and's ID. - - type: array - description: The $and's ID. - items: - type: string - title: id - description: The id's ID. - is_giftcard: - type: boolean - title: is_giftcard - description: The $and's is giftcard. - tags: - type: object - description: The $and's tags. - type_id: - oneOf: - - type: string - title: type_id - description: The $and's type id. - - type: array - description: The $and's type id. - items: - type: string - title: type_id - description: The type id's details. - category_id: - oneOf: - - type: string - title: category_id - description: The $and's category id. - - type: array - description: The $and's category id. - items: - type: string - title: category_id - description: The category id's details. - - type: object - description: The $and's category id. - categories: - oneOf: - - type: object - description: The $and's categories. - - type: object - description: The $and's categories. - collection_id: - oneOf: - - type: string - title: collection_id - description: The $and's collection id. - - type: array - description: The $and's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - - type: object - description: The $and's collection id. - created_at: - type: object - description: The $and's created at. - updated_at: - type: object - description: The $and's updated at. - deleted_at: - type: object - description: The $and's deleted at. - limit: - type: number - title: limit - description: The $and's limit. - offset: - type: number - title: offset - description: The $and's offset. - order: - type: string - title: order - description: The $and's order. - fields: - type: string - title: fields - description: The $and's fields. - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - - type: object - description: The $or's details. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - - type: object - description: The $or's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - properties: - q: - type: string - title: q - description: The $or's q. - status: - oneOf: - - type: string - title: status - description: The $or's status. - - type: string - title: status - description: The $or's status. - - type: string - title: status - description: The $or's status. - - type: string - title: status - description: The $or's status. - - type: array - description: The $or's status. - items: - type: string - enum: - - draft - - proposed - - published - - rejected - sales_channel_id: - oneOf: - - type: string - title: sales_channel_id - description: The $or's sales channel id. - - type: array - description: The $or's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - title: - oneOf: - - type: string - title: title - description: The $or's title. - - type: array - description: The $or's title. - items: - type: string - title: title - description: The title's details. - handle: - oneOf: - - type: string - title: handle - description: The $or's handle. - - type: array - description: The $or's handle. - items: - type: string - title: handle - description: The handle's details. - id: - oneOf: - - type: string - title: id - description: The $or's ID. - - type: array - description: The $or's ID. - items: - type: string - title: id - description: The id's ID. - is_giftcard: - type: boolean - title: is_giftcard - description: The $or's is giftcard. - tags: - type: object - description: The $or's tags. - type_id: - oneOf: - - type: string - title: type_id - description: The $or's type id. - - type: array - description: The $or's type id. - items: - type: string - title: type_id - description: The type id's details. - category_id: - oneOf: - - type: string - title: category_id - description: The $or's category id. - - type: array - description: The $or's category id. - items: - type: string - title: category_id - description: The category id's details. - - type: object - description: The $or's category id. - categories: - oneOf: - - type: object - description: The $or's categories. - - type: object - description: The $or's categories. - collection_id: - oneOf: - - type: string - title: collection_id - description: The $or's collection id. - - type: array - description: The $or's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - - type: object - description: The $or's collection id. - created_at: - type: object - description: The $or's created at. - updated_at: - type: object - description: The $or's updated at. - deleted_at: - type: object - description: The $or's deleted at. - limit: - type: number - title: limit - description: The $or's limit. - offset: - type: number - title: offset - description: The $or's offset. - order: - type: string - title: order - description: The $or's order. - fields: - type: string - title: fields - description: The $or's fields. - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - - type: object - description: The $or's details. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - - type: object - description: The $or's details. type: array items: type: object + title: $and - name: $or in: query description: The product's $or. @@ -29647,1915 +27962,10 @@ paths: type: array description: The product's $or. items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - properties: - q: - type: string - title: q - description: The $or's q. - status: - oneOf: - - type: string - title: status - description: The $or's status. - - type: string - title: status - description: The $or's status. - - type: string - title: status - description: The $or's status. - - type: string - title: status - description: The $or's status. - - type: array - description: The $or's status. - items: - type: string - enum: - - draft - - proposed - - published - - rejected - sales_channel_id: - oneOf: - - type: string - title: sales_channel_id - description: The $or's sales channel id. - - type: array - description: The $or's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - title: - oneOf: - - type: string - title: title - description: The $or's title. - - type: array - description: The $or's title. - items: - type: string - title: title - description: The title's details. - handle: - oneOf: - - type: string - title: handle - description: The $or's handle. - - type: array - description: The $or's handle. - items: - type: string - title: handle - description: The handle's details. - id: - oneOf: - - type: string - title: id - description: The $or's ID. - - type: array - description: The $or's ID. - items: - type: string - title: id - description: The id's ID. - is_giftcard: - type: boolean - title: is_giftcard - description: The $or's is giftcard. - tags: - type: object - description: The $or's tags. - properties: - value: - type: array - description: The tag's value. - items: - type: string - title: value - description: The value's details. - type_id: - oneOf: - - type: string - title: type_id - description: The $or's type id. - - type: array - description: The $or's type id. - items: - type: string - title: type_id - description: The type id's details. - category_id: - oneOf: - - type: string - title: category_id - description: The $or's category id. - - type: array - description: The $or's category id. - items: - type: string - title: category_id - description: The category id's details. - - type: object - description: The $or's category id. - properties: - $and: - type: array - description: The category id's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The category id's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The category id's $eq. - - type: object - description: The category id's $eq. - x-schemaName: RegExp - - type: array - description: The category id's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The category id's $ne. - - type: object - description: The category id's $ne. - x-schemaName: RegExp - $in: - type: array - description: The category id's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The category id's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The category id's $not. - - type: object - description: The category id's $not. - x-schemaName: RegExp - - type: object - description: The category id's $not. - - type: array - description: The category id's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The category id's $gt. - - type: object - description: The category id's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The category id's $gte. - - type: object - description: The category id's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The category id's $lt. - - type: object - description: The category id's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The category id's $lte. - - type: object - description: The category id's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The category id's $like. - $re: - type: string - title: $re - description: The category id's $re. - $ilike: - type: string - title: $ilike - description: The category id's $ilike. - $fulltext: - type: string - title: $fulltext - description: The category id's $fulltext. - $overlap: - type: array - description: The category id's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The category id's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The category id's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The category id's $exists. - categories: - oneOf: - - type: object - description: The $or's categories. - required: - - id - properties: - id: - type: object - description: The category's ID. - - type: object - description: The $or's categories. - required: - - id - properties: - id: - type: object - description: The category's ID. - collection_id: - oneOf: - - type: string - title: collection_id - description: The $or's collection id. - - type: array - description: The $or's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - - type: object - description: The $or's collection id. - properties: - $and: - type: array - description: The collection id's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The collection id's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The collection id's $eq. - - type: object - description: The collection id's $eq. - x-schemaName: RegExp - - type: array - description: The collection id's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The collection id's $ne. - - type: object - description: The collection id's $ne. - x-schemaName: RegExp - $in: - type: array - description: The collection id's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The collection id's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The collection id's $not. - - type: object - description: The collection id's $not. - x-schemaName: RegExp - - type: object - description: The collection id's $not. - - type: array - description: The collection id's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The collection id's $gt. - - type: object - description: The collection id's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The collection id's $gte. - - type: object - description: The collection id's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The collection id's $lt. - - type: object - description: The collection id's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The collection id's $lte. - - type: object - description: The collection id's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The collection id's $like. - $re: - type: string - title: $re - description: The collection id's $re. - $ilike: - type: string - title: $ilike - description: The collection id's $ilike. - $fulltext: - type: string - title: $fulltext - description: The collection id's $fulltext. - $overlap: - type: array - description: The collection id's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The collection id's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The collection id's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The collection id's $exists. - created_at: - type: object - description: The $or's created at. - properties: - $and: - type: array - description: The created at's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The created at's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The created at's $eq. - - type: object - description: The created at's $eq. - x-schemaName: RegExp - - type: array - description: The created at's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The created at's $ne. - - type: object - description: The created at's $ne. - x-schemaName: RegExp - $in: - type: array - description: The created at's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The created at's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The created at's $not. - - type: object - description: The created at's $not. - x-schemaName: RegExp - - type: object - description: The created at's $not. - - type: array - description: The created at's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The created at's $gt. - - type: object - description: The created at's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The created at's $gte. - - type: object - description: The created at's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The created at's $lt. - - type: object - description: The created at's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The created at's $lte. - - type: object - description: The created at's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The created at's $like. - $re: - type: string - title: $re - description: The created at's $re. - $ilike: - type: string - title: $ilike - description: The created at's $ilike. - $fulltext: - type: string - title: $fulltext - description: The created at's $fulltext. - $overlap: - type: array - description: The created at's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The created at's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The created at's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The created at's $exists. - updated_at: - type: object - description: The $or's updated at. - properties: - $and: - type: array - description: The updated at's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The updated at's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The updated at's $eq. - - type: object - description: The updated at's $eq. - x-schemaName: RegExp - - type: array - description: The updated at's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The updated at's $ne. - - type: object - description: The updated at's $ne. - x-schemaName: RegExp - $in: - type: array - description: The updated at's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The updated at's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The updated at's $not. - - type: object - description: The updated at's $not. - x-schemaName: RegExp - - type: object - description: The updated at's $not. - - type: array - description: The updated at's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The updated at's $gt. - - type: object - description: The updated at's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The updated at's $gte. - - type: object - description: The updated at's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The updated at's $lt. - - type: object - description: The updated at's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The updated at's $lte. - - type: object - description: The updated at's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The updated at's $like. - $re: - type: string - title: $re - description: The updated at's $re. - $ilike: - type: string - title: $ilike - description: The updated at's $ilike. - $fulltext: - type: string - title: $fulltext - description: The updated at's $fulltext. - $overlap: - type: array - description: The updated at's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The updated at's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The updated at's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The updated at's $exists. - deleted_at: - type: object - description: The $or's deleted at. - properties: - $and: - type: array - description: The deleted at's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The deleted at's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The deleted at's $eq. - - type: object - description: The deleted at's $eq. - x-schemaName: RegExp - - type: array - description: The deleted at's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The deleted at's $ne. - - type: object - description: The deleted at's $ne. - x-schemaName: RegExp - $in: - type: array - description: The deleted at's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The deleted at's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The deleted at's $not. - - type: object - description: The deleted at's $not. - x-schemaName: RegExp - - type: object - description: The deleted at's $not. - - type: array - description: The deleted at's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The deleted at's $gt. - - type: object - description: The deleted at's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The deleted at's $gte. - - type: object - description: The deleted at's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The deleted at's $lt. - - type: object - description: The deleted at's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The deleted at's $lte. - - type: object - description: The deleted at's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The deleted at's $like. - $re: - type: string - title: $re - description: The deleted at's $re. - $ilike: - type: string - title: $ilike - description: The deleted at's $ilike. - $fulltext: - type: string - title: $fulltext - description: The deleted at's $fulltext. - $overlap: - type: array - description: The deleted at's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The deleted at's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The deleted at's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The deleted at's $exists. - limit: - type: number - title: limit - description: The $or's limit. - offset: - type: number - title: offset - description: The $or's offset. - order: - type: string - title: order - description: The $or's order. - fields: - type: string - title: fields - description: The $or's fields. - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - properties: - q: - type: string - title: q - description: The $and's q. - status: - oneOf: - - type: string - title: status - description: The $and's status. - - type: string - title: status - description: The $and's status. - - type: string - title: status - description: The $and's status. - - type: string - title: status - description: The $and's status. - - type: array - description: The $and's status. - items: - type: string - enum: - - draft - - proposed - - published - - rejected - sales_channel_id: - oneOf: - - type: string - title: sales_channel_id - description: The $and's sales channel id. - - type: array - description: The $and's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - title: - oneOf: - - type: string - title: title - description: The $and's title. - - type: array - description: The $and's title. - items: - type: string - title: title - description: The title's details. - handle: - oneOf: - - type: string - title: handle - description: The $and's handle. - - type: array - description: The $and's handle. - items: - type: string - title: handle - description: The handle's details. - id: - oneOf: - - type: string - title: id - description: The $and's ID. - - type: array - description: The $and's ID. - items: - type: string - title: id - description: The id's ID. - is_giftcard: - type: boolean - title: is_giftcard - description: The $and's is giftcard. - tags: - type: object - description: The $and's tags. - type_id: - oneOf: - - type: string - title: type_id - description: The $and's type id. - - type: array - description: The $and's type id. - items: - type: string - title: type_id - description: The type id's details. - category_id: - oneOf: - - type: string - title: category_id - description: The $and's category id. - - type: array - description: The $and's category id. - items: - type: string - title: category_id - description: The category id's details. - - type: object - description: The $and's category id. - categories: - oneOf: - - type: object - description: The $and's categories. - - type: object - description: The $and's categories. - collection_id: - oneOf: - - type: string - title: collection_id - description: The $and's collection id. - - type: array - description: The $and's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - - type: object - description: The $and's collection id. - created_at: - type: object - description: The $and's created at. - updated_at: - type: object - description: The $and's updated at. - deleted_at: - type: object - description: The $and's deleted at. - limit: - type: number - title: limit - description: The $and's limit. - offset: - type: number - title: offset - description: The $and's offset. - order: - type: string - title: order - description: The $and's order. - fields: - type: string - title: fields - description: The $and's fields. - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - - type: object - description: The $or's details. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - - type: object - description: The $or's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - properties: - q: - type: string - title: q - description: The $or's q. - status: - oneOf: - - type: string - title: status - description: The $or's status. - - type: string - title: status - description: The $or's status. - - type: string - title: status - description: The $or's status. - - type: string - title: status - description: The $or's status. - - type: array - description: The $or's status. - items: - type: string - enum: - - draft - - proposed - - published - - rejected - sales_channel_id: - oneOf: - - type: string - title: sales_channel_id - description: The $or's sales channel id. - - type: array - description: The $or's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - title: - oneOf: - - type: string - title: title - description: The $or's title. - - type: array - description: The $or's title. - items: - type: string - title: title - description: The title's details. - handle: - oneOf: - - type: string - title: handle - description: The $or's handle. - - type: array - description: The $or's handle. - items: - type: string - title: handle - description: The handle's details. - id: - oneOf: - - type: string - title: id - description: The $or's ID. - - type: array - description: The $or's ID. - items: - type: string - title: id - description: The id's ID. - is_giftcard: - type: boolean - title: is_giftcard - description: The $or's is giftcard. - tags: - type: object - description: The $or's tags. - type_id: - oneOf: - - type: string - title: type_id - description: The $or's type id. - - type: array - description: The $or's type id. - items: - type: string - title: type_id - description: The type id's details. - category_id: - oneOf: - - type: string - title: category_id - description: The $or's category id. - - type: array - description: The $or's category id. - items: - type: string - title: category_id - description: The category id's details. - - type: object - description: The $or's category id. - categories: - oneOf: - - type: object - description: The $or's categories. - - type: object - description: The $or's categories. - collection_id: - oneOf: - - type: string - title: collection_id - description: The $or's collection id. - - type: array - description: The $or's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - - type: object - description: The $or's collection id. - created_at: - type: object - description: The $or's created at. - updated_at: - type: object - description: The $or's updated at. - deleted_at: - type: object - description: The $or's deleted at. - limit: - type: number - title: limit - description: The $or's limit. - offset: - type: number - title: offset - description: The $or's offset. - order: - type: string - title: order - description: The $or's order. - fields: - type: string - title: fields - description: The $or's fields. - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - - type: object - description: The $or's details. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - - type: object - description: The $or's details. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - properties: - q: - type: string - title: q - description: The $and's q. - status: - oneOf: - - type: string - title: status - description: The $and's status. - - type: string - title: status - description: The $and's status. - - type: string - title: status - description: The $and's status. - - type: string - title: status - description: The $and's status. - - type: array - description: The $and's status. - items: - type: string - enum: - - draft - - proposed - - published - - rejected - sales_channel_id: - oneOf: - - type: string - title: sales_channel_id - description: The $and's sales channel id. - - type: array - description: The $and's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - title: - oneOf: - - type: string - title: title - description: The $and's title. - - type: array - description: The $and's title. - items: - type: string - title: title - description: The title's details. - handle: - oneOf: - - type: string - title: handle - description: The $and's handle. - - type: array - description: The $and's handle. - items: - type: string - title: handle - description: The handle's details. - id: - oneOf: - - type: string - title: id - description: The $and's ID. - - type: array - description: The $and's ID. - items: - type: string - title: id - description: The id's ID. - is_giftcard: - type: boolean - title: is_giftcard - description: The $and's is giftcard. - tags: - type: object - description: The $and's tags. - type_id: - oneOf: - - type: string - title: type_id - description: The $and's type id. - - type: array - description: The $and's type id. - items: - type: string - title: type_id - description: The type id's details. - category_id: - oneOf: - - type: string - title: category_id - description: The $and's category id. - - type: array - description: The $and's category id. - items: - type: string - title: category_id - description: The category id's details. - - type: object - description: The $and's category id. - categories: - oneOf: - - type: object - description: The $and's categories. - - type: object - description: The $and's categories. - collection_id: - oneOf: - - type: string - title: collection_id - description: The $and's collection id. - - type: array - description: The $and's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - - type: object - description: The $and's collection id. - created_at: - type: object - description: The $and's created at. - updated_at: - type: object - description: The $and's updated at. - deleted_at: - type: object - description: The $and's deleted at. - limit: - type: number - title: limit - description: The $and's limit. - offset: - type: number - title: offset - description: The $and's offset. - order: - type: string - title: order - description: The $and's order. - fields: - type: string - title: fields - description: The $and's fields. - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - - type: object - description: The $or's details. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - - type: object - description: The $or's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - properties: - q: - type: string - title: q - description: The $or's q. - status: - oneOf: - - type: string - title: status - description: The $or's status. - - type: string - title: status - description: The $or's status. - - type: string - title: status - description: The $or's status. - - type: string - title: status - description: The $or's status. - - type: array - description: The $or's status. - items: - type: string - enum: - - draft - - proposed - - published - - rejected - sales_channel_id: - oneOf: - - type: string - title: sales_channel_id - description: The $or's sales channel id. - - type: array - description: The $or's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - title: - oneOf: - - type: string - title: title - description: The $or's title. - - type: array - description: The $or's title. - items: - type: string - title: title - description: The title's details. - handle: - oneOf: - - type: string - title: handle - description: The $or's handle. - - type: array - description: The $or's handle. - items: - type: string - title: handle - description: The handle's details. - id: - oneOf: - - type: string - title: id - description: The $or's ID. - - type: array - description: The $or's ID. - items: - type: string - title: id - description: The id's ID. - is_giftcard: - type: boolean - title: is_giftcard - description: The $or's is giftcard. - tags: - type: object - description: The $or's tags. - type_id: - oneOf: - - type: string - title: type_id - description: The $or's type id. - - type: array - description: The $or's type id. - items: - type: string - title: type_id - description: The type id's details. - category_id: - oneOf: - - type: string - title: category_id - description: The $or's category id. - - type: array - description: The $or's category id. - items: - type: string - title: category_id - description: The category id's details. - - type: object - description: The $or's category id. - categories: - oneOf: - - type: object - description: The $or's categories. - - type: object - description: The $or's categories. - collection_id: - oneOf: - - type: string - title: collection_id - description: The $or's collection id. - - type: array - description: The $or's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - - type: object - description: The $or's collection id. - created_at: - type: object - description: The $or's created at. - updated_at: - type: object - description: The $or's updated at. - deleted_at: - type: object - description: The $or's deleted at. - limit: - type: number - title: limit - description: The $or's limit. - offset: - type: number - title: offset - description: The $or's offset. - order: - type: string - title: order - description: The $or's order. - fields: - type: string - title: fields - description: The $or's fields. - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - - type: object - description: The $or's details. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - - type: object - description: The $or's details. type: array items: type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -31670,148 +28080,15 @@ paths: content: application/json: schema: + allOf: + - $ref: '#/components/schemas/AdminCreateProduct' + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. description: SUMMARY - properties: - title: - type: string - title: title - description: The product's title. - subtitle: - type: string - title: subtitle - description: The product's subtitle. - description: - type: string - title: description - description: The product's description. - is_giftcard: - type: boolean - title: is_giftcard - description: The product's is giftcard. - discountable: - type: boolean - title: discountable - description: The product's discountable. - images: - type: array - description: The product's images. - items: - type: object - description: The image's images. - required: - - url - properties: - url: - type: string - title: url - description: The image's url. - thumbnail: - type: string - title: thumbnail - description: The product's thumbnail. - handle: - type: string - title: handle - description: The product's handle. - status: - type: string - enum: - - draft - - proposed - - published - - rejected - type_id: - type: string - title: type_id - description: The product's type id. - collection_id: - type: string - title: collection_id - description: The product's collection id. - categories: - type: array - description: The product's categories. - items: - type: object - description: The category's categories. - required: - - id - properties: - id: - type: string - title: id - description: The category's ID. - tags: - type: array - description: The product's tags. - items: - type: object - description: The tag's tags. - required: - - id - properties: - id: - type: string - title: id - description: The tag's ID. - options: - type: array - description: The product's options. - items: - $ref: '#/components/schemas/AdminCreateProductOption' - variants: - type: array - description: The product's variants. - items: - $ref: '#/components/schemas/AdminCreateProductVariant' - sales_channels: - type: array - description: The product's sales channels. - items: - type: object - description: The sales channel's sales channels. - required: - - id - properties: - id: - type: string - title: id - description: The sales channel's ID. - weight: - type: number - title: weight - description: The product's weight. - length: - type: number - title: length - description: The product's length. - height: - type: number - title: height - description: The product's height. - width: - type: number - title: width - description: The product's width. - hs_code: - type: string - title: hs_code - description: The product's hs code. - mid_code: - type: string - title: mid_code - description: The product's mid code. - origin_country: - type: string - title: origin_country - description: The product's origin country. - material: - type: string - title: material - description: The product's material. - metadata: - type: object - description: The product's metadata. x-codeSamples: - lang: Shell label: cURL @@ -32322,150 +28599,15 @@ paths: content: application/json: schema: + allOf: + - $ref: '#/components/schemas/AdminUpdateProduct' + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. description: SUMMARY - properties: - title: - type: string - title: title - description: The product's title. - subtitle: - type: string - title: subtitle - description: The product's subtitle. - description: - type: string - title: description - description: The product's description. - is_giftcard: - type: boolean - title: is_giftcard - description: The product's is giftcard. - discountable: - type: boolean - title: discountable - description: The product's discountable. - images: - type: array - description: The product's images. - items: - type: object - description: The image's images. - required: - - url - properties: - url: - type: string - title: url - description: The image's url. - thumbnail: - type: string - title: thumbnail - description: The product's thumbnail. - handle: - type: string - title: handle - description: The product's handle. - status: - type: string - enum: - - draft - - proposed - - published - - rejected - type_id: - type: string - title: type_id - description: The product's type id. - collection_id: - type: string - title: collection_id - description: The product's collection id. - categories: - type: array - description: The product's categories. - items: - type: object - description: The category's categories. - required: - - id - properties: - id: - type: string - title: id - description: The category's ID. - tags: - type: array - description: The product's tags. - items: - type: object - description: The tag's tags. - required: - - id - properties: - id: - type: string - title: id - description: The tag's ID. - options: - type: array - description: The product's options. - items: - $ref: '#/components/schemas/AdminUpdateProductOption' - variants: - type: array - description: The product's variants. - items: - oneOf: - - $ref: '#/components/schemas/AdminCreateProductVariant' - - $ref: '#/components/schemas/AdminUpdateProductVariant' - sales_channels: - type: array - description: The product's sales channels. - items: - type: object - description: The sales channel's sales channels. - required: - - id - properties: - id: - type: string - title: id - description: The sales channel's ID. - weight: - type: number - title: weight - description: The product's weight. - length: - type: number - title: length - description: The product's length. - height: - type: number - title: height - description: The product's height. - width: - type: number - title: width - description: The product's width. - hs_code: - type: string - title: hs_code - description: The product's hs code. - mid_code: - type: string - title: mid_code - description: The product's mid code. - origin_country: - type: string - title: origin_country - description: The product's origin country. - material: - type: string - title: material - description: The product's material. - metadata: - type: object - description: The product's metadata. x-codeSamples: - lang: Shell label: cURL @@ -32688,490 +28830,10 @@ paths: type: array description: The product's $and. items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - properties: - q: - type: string - title: q - description: The $and's q. - id: - oneOf: - - type: string - title: id - description: The $and's ID. - - type: array - description: The $and's ID. - items: - type: string - title: id - description: The id's ID. - title: - oneOf: - - type: string - title: title - description: The $and's title. - - type: array - description: The $and's title. - items: - type: string - title: title - description: The title's details. - product_id: - oneOf: - - type: string - title: product_id - description: The $and's product id. - - type: array - description: The $and's product id. - items: - type: string - title: product_id - description: The product id's details. - limit: - type: number - title: limit - description: The $and's limit. - offset: - type: number - title: offset - description: The $and's offset. - order: - type: string - title: order - description: The $and's order. - fields: - type: string - title: fields - description: The $and's fields. - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - properties: - q: - type: string - title: q - description: The $and's q. - id: - oneOf: - - type: string - title: id - description: The $and's ID. - - type: array - description: The $and's ID. - items: - type: string - title: id - description: The id's ID. - title: - oneOf: - - type: string - title: title - description: The $and's title. - - type: array - description: The $and's title. - items: - type: string - title: title - description: The title's details. - product_id: - oneOf: - - type: string - title: product_id - description: The $and's product id. - - type: array - description: The $and's product id. - items: - type: string - title: product_id - description: The product id's details. - limit: - type: number - title: limit - description: The $and's limit. - offset: - type: number - title: offset - description: The $and's offset. - order: - type: string - title: order - description: The $and's order. - fields: - type: string - title: fields - description: The $and's fields. - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $or's details. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $or's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - properties: - q: - type: string - title: q - description: The $or's q. - id: - oneOf: - - type: string - title: id - description: The $or's ID. - - type: array - description: The $or's ID. - items: - type: string - title: id - description: The id's ID. - title: - oneOf: - - type: string - title: title - description: The $or's title. - - type: array - description: The $or's title. - items: - type: string - title: title - description: The title's details. - product_id: - oneOf: - - type: string - title: product_id - description: The $or's product id. - - type: array - description: The $or's product id. - items: - type: string - title: product_id - description: The product id's details. - limit: - type: number - title: limit - description: The $or's limit. - offset: - type: number - title: offset - description: The $or's offset. - order: - type: string - title: order - description: The $or's order. - fields: - type: string - title: fields - description: The $or's fields. - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $or's details. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $or's details. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - properties: - q: - type: string - title: q - description: The $and's q. - id: - oneOf: - - type: string - title: id - description: The $and's ID. - - type: array - description: The $and's ID. - items: - type: string - title: id - description: The id's ID. - title: - oneOf: - - type: string - title: title - description: The $and's title. - - type: array - description: The $and's title. - items: - type: string - title: title - description: The title's details. - product_id: - oneOf: - - type: string - title: product_id - description: The $and's product id. - - type: array - description: The $and's product id. - items: - type: string - title: product_id - description: The product id's details. - limit: - type: number - title: limit - description: The $and's limit. - offset: - type: number - title: offset - description: The $and's offset. - order: - type: string - title: order - description: The $and's order. - fields: - type: string - title: fields - description: The $and's fields. - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $or's details. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $or's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - properties: - q: - type: string - title: q - description: The $or's q. - id: - oneOf: - - type: string - title: id - description: The $or's ID. - - type: array - description: The $or's ID. - items: - type: string - title: id - description: The id's ID. - title: - oneOf: - - type: string - title: title - description: The $or's title. - - type: array - description: The $or's title. - items: - type: string - title: title - description: The title's details. - product_id: - oneOf: - - type: string - title: product_id - description: The $or's product id. - - type: array - description: The $or's product id. - items: - type: string - title: product_id - description: The product id's details. - limit: - type: number - title: limit - description: The $or's limit. - offset: - type: number - title: offset - description: The $or's offset. - order: - type: string - title: order - description: The $or's order. - fields: - type: string - title: fields - description: The $or's fields. - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $or's details. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $or's details. type: array items: type: object + title: $and - name: $or in: query description: The product's $or. @@ -33180,490 +28842,10 @@ paths: type: array description: The product's $or. items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - properties: - q: - type: string - title: q - description: The $or's q. - id: - oneOf: - - type: string - title: id - description: The $or's ID. - - type: array - description: The $or's ID. - items: - type: string - title: id - description: The id's ID. - title: - oneOf: - - type: string - title: title - description: The $or's title. - - type: array - description: The $or's title. - items: - type: string - title: title - description: The title's details. - product_id: - oneOf: - - type: string - title: product_id - description: The $or's product id. - - type: array - description: The $or's product id. - items: - type: string - title: product_id - description: The product id's details. - limit: - type: number - title: limit - description: The $or's limit. - offset: - type: number - title: offset - description: The $or's offset. - order: - type: string - title: order - description: The $or's order. - fields: - type: string - title: fields - description: The $or's fields. - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - properties: - q: - type: string - title: q - description: The $and's q. - id: - oneOf: - - type: string - title: id - description: The $and's ID. - - type: array - description: The $and's ID. - items: - type: string - title: id - description: The id's ID. - title: - oneOf: - - type: string - title: title - description: The $and's title. - - type: array - description: The $and's title. - items: - type: string - title: title - description: The title's details. - product_id: - oneOf: - - type: string - title: product_id - description: The $and's product id. - - type: array - description: The $and's product id. - items: - type: string - title: product_id - description: The product id's details. - limit: - type: number - title: limit - description: The $and's limit. - offset: - type: number - title: offset - description: The $and's offset. - order: - type: string - title: order - description: The $and's order. - fields: - type: string - title: fields - description: The $and's fields. - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $or's details. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $or's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - properties: - q: - type: string - title: q - description: The $or's q. - id: - oneOf: - - type: string - title: id - description: The $or's ID. - - type: array - description: The $or's ID. - items: - type: string - title: id - description: The id's ID. - title: - oneOf: - - type: string - title: title - description: The $or's title. - - type: array - description: The $or's title. - items: - type: string - title: title - description: The title's details. - product_id: - oneOf: - - type: string - title: product_id - description: The $or's product id. - - type: array - description: The $or's product id. - items: - type: string - title: product_id - description: The product id's details. - limit: - type: number - title: limit - description: The $or's limit. - offset: - type: number - title: offset - description: The $or's offset. - order: - type: string - title: order - description: The $or's order. - fields: - type: string - title: fields - description: The $or's fields. - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $or's details. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $or's details. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - properties: - q: - type: string - title: q - description: The $and's q. - id: - oneOf: - - type: string - title: id - description: The $and's ID. - - type: array - description: The $and's ID. - items: - type: string - title: id - description: The id's ID. - title: - oneOf: - - type: string - title: title - description: The $and's title. - - type: array - description: The $and's title. - items: - type: string - title: title - description: The title's details. - product_id: - oneOf: - - type: string - title: product_id - description: The $and's product id. - - type: array - description: The $and's product id. - items: - type: string - title: product_id - description: The product id's details. - limit: - type: number - title: limit - description: The $and's limit. - offset: - type: number - title: offset - description: The $and's offset. - order: - type: string - title: order - description: The $and's order. - fields: - type: string - title: fields - description: The $and's fields. - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $or's details. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $or's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - properties: - q: - type: string - title: q - description: The $or's q. - id: - oneOf: - - type: string - title: id - description: The $or's ID. - - type: array - description: The $or's ID. - items: - type: string - title: id - description: The id's ID. - title: - oneOf: - - type: string - title: title - description: The $or's title. - - type: array - description: The $or's title. - items: - type: string - title: title - description: The title's details. - product_id: - oneOf: - - type: string - title: product_id - description: The $or's product id. - - type: array - description: The $or's product id. - items: - type: string - title: product_id - description: The product id's details. - limit: - type: number - title: limit - description: The $or's limit. - offset: - type: number - title: offset - description: The $or's offset. - order: - type: string - title: order - description: The $or's order. - fields: - type: string - title: fields - description: The $or's fields. - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $or's details. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $or's details. type: array items: type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -33784,19 +28966,15 @@ paths: content: application/json: schema: + allOf: + - $ref: '#/components/schemas/AdminCreateProductOption' + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. description: SUMMARY - properties: - title: - type: string - title: title - description: The product's title. - values: - type: array - description: The product's values. - items: - type: string - title: values - description: The value's values. x-codeSamples: - lang: Shell label: cURL @@ -33987,19 +29165,15 @@ paths: content: application/json: schema: + allOf: + - $ref: '#/components/schemas/AdminUpdateProductOption' + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. description: SUMMARY - properties: - title: - type: string - title: title - description: The product's title. - values: - type: array - description: The product's values. - items: - type: string - title: values - description: The value's values. x-codeSamples: - lang: Shell label: cURL @@ -34289,83 +29463,15 @@ paths: content: application/json: schema: + allOf: + - $ref: '#/components/schemas/AdminCreateProductVariant' + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. description: SUMMARY - properties: - title: - type: string - title: title - description: The product's title. - sku: - type: string - title: sku - description: The product's sku. - ean: - type: string - title: ean - description: The product's ean. - upc: - type: string - title: upc - description: The product's upc. - barcode: - type: string - title: barcode - description: The product's barcode. - hs_code: - type: string - title: hs_code - description: The product's hs code. - mid_code: - type: string - title: mid_code - description: The product's mid code. - allow_backorder: - type: boolean - title: allow_backorder - description: The product's allow backorder. - manage_inventory: - type: boolean - title: manage_inventory - description: The product's manage inventory. - variant_rank: - type: number - title: variant_rank - description: The product's variant rank. - weight: - type: number - title: weight - description: The product's weight. - length: - type: number - title: length - description: The product's length. - height: - type: number - title: height - description: The product's height. - width: - type: number - title: width - description: The product's width. - origin_country: - type: string - title: origin_country - description: The product's origin country. - material: - type: string - title: material - description: The product's material. - metadata: - type: object - description: The product's metadata. - prices: - type: array - description: The product's prices. - items: - $ref: '#/components/schemas/AdminCreateProductVariantPrice' - options: - type: object - description: The product's options. x-codeSamples: - lang: Shell label: cURL @@ -34800,83 +29906,15 @@ paths: content: application/json: schema: + allOf: + - $ref: '#/components/schemas/AdminUpdateProductVariant' + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. description: SUMMARY - properties: - title: - type: string - title: title - description: The product's title. - sku: - type: string - title: sku - description: The product's sku. - ean: - type: string - title: ean - description: The product's ean. - upc: - type: string - title: upc - description: The product's upc. - barcode: - type: string - title: barcode - description: The product's barcode. - hs_code: - type: string - title: hs_code - description: The product's hs code. - mid_code: - type: string - title: mid_code - description: The product's mid code. - allow_backorder: - type: boolean - title: allow_backorder - description: The product's allow backorder. - manage_inventory: - type: boolean - title: manage_inventory - description: The product's manage inventory. - variant_rank: - type: number - title: variant_rank - description: The product's variant rank. - weight: - type: number - title: weight - description: The product's weight. - length: - type: number - title: length - description: The product's length. - height: - type: number - title: height - description: The product's height. - width: - type: number - title: width - description: The product's width. - origin_country: - type: string - title: origin_country - description: The product's origin country. - material: - type: string - title: material - description: The product's material. - metadata: - type: object - description: The product's metadata. - prices: - type: array - description: The product's prices. - items: - $ref: '#/components/schemas/AdminCreateProductVariantPrice' - options: - type: object - description: The product's options. x-codeSamples: - lang: Shell label: cURL @@ -35630,268 +30668,282 @@ paths: content: application/json: schema: - description: SUMMARY - properties: - code: - type: string - title: code - description: The promotion's code. - is_automatic: - type: boolean - title: is_automatic - description: The promotion's is automatic. - type: - type: string - enum: - - standard - - buyget - campaign_id: - type: string - title: campaign_id - description: The promotion's campaign id. - campaign: - type: object - description: The promotion's campaign. + allOf: + - type: object + description: SUMMARY required: - - name - - campaign_identifier - - description - - budget - - starts_at - - ends_at - properties: - name: - type: string - title: name - description: The campaign's name. - campaign_identifier: - type: string - title: campaign_identifier - description: The campaign's campaign identifier. - description: - type: string - title: description - description: The campaign's description. - budget: - type: object - description: The campaign's budget. - required: - - type - - limit - - currency_code - properties: - type: - type: string - enum: - - spend - - usage - limit: - type: number - title: limit - description: The budget's limit. - currency_code: - type: string - title: currency_code - description: The budget's currency code. - starts_at: - type: string - title: starts_at - description: The campaign's starts at. - format: date-time - ends_at: - type: string - title: ends_at - description: The campaign's ends at. - format: date-time - promotions: - type: array - description: The campaign's promotions. - items: - type: object - description: The promotion's promotions. - required: - - id - properties: - id: - type: string - title: id - description: The promotion's ID. - application_method: - type: object - description: The promotion's application method. - required: - - description - - value - - currency_code - - max_quantity + - code - type - - target_type - - apply_to_quantity - - buy_rules_min_quantity + - campaign_id + - application_method properties: - description: + code: type: string - title: description - description: The application method's description. - value: - type: number - title: value - description: The application method's value. - currency_code: - type: string - title: currency_code - description: The application method's currency code. - max_quantity: - type: number - title: max_quantity - description: The application method's max quantity. + title: code + description: The promotion's code. + is_automatic: + type: boolean + title: is_automatic + description: The promotion's is automatic. type: type: string enum: - - fixed - - percentage - target_type: + - standard + - buyget + campaign_id: type: string - enum: - - order - - shipping_methods - - items - allocation: - type: string - enum: - - each - - across - target_rules: - type: array - description: The application method's target rules. - items: - type: object - description: The target rule's target rules. - required: - - operator - - description - - attribute - - values - properties: - operator: - type: string - enum: - - gte - - lte - - gt - - lt - - eq - - ne - - in - description: - type: string - title: description - description: The target rule's description. - attribute: - type: string - title: attribute - description: The target rule's attribute. - values: - oneOf: - - type: string - title: values - description: The target rule's values. - - type: array - description: The target rule's values. - items: - type: string - title: values - description: The value's values. - buy_rules: - type: array - description: The application method's buy rules. - items: - type: object - description: The buy rule's buy rules. - required: - - operator - - description - - attribute - - values - properties: - operator: - type: string - enum: - - gte - - lte - - gt - - lt - - eq - - ne - - in - description: - type: string - title: description - description: The buy rule's description. - attribute: - type: string - title: attribute - description: The buy rule's attribute. - values: - oneOf: - - type: string - title: values - description: The buy rule's values. - - type: array - description: The buy rule's values. - items: - type: string - title: values - description: The value's values. - apply_to_quantity: - type: number - title: apply_to_quantity - description: The application method's apply to quantity. - buy_rules_min_quantity: - type: number - title: buy_rules_min_quantity - description: The application method's buy rules min quantity. - rules: - type: array - description: The promotion's rules. - items: - type: object - description: The rule's rules. - required: - - operator - - description - - attribute - - values - properties: - operator: - type: string - enum: - - gte - - lte - - gt - - lt - - eq - - ne - - in - description: - type: string - title: description - description: The rule's description. - attribute: - type: string - title: attribute - description: The rule's attribute. - values: - oneOf: - - type: string - title: values - description: The rule's values. - - type: array - description: The rule's values. - items: + title: campaign_id + description: The promotion's campaign id. + campaign: + type: object + description: The promotion's campaign. + required: + - name + - campaign_identifier + - description + - budget + - starts_at + - ends_at + properties: + name: + type: string + title: name + description: The campaign's name. + campaign_identifier: + type: string + title: campaign_identifier + description: The campaign's campaign identifier. + description: + type: string + title: description + description: The campaign's description. + budget: + type: object + description: The campaign's budget. + required: + - type + - limit + - currency_code + properties: + type: type: string - title: values - description: The value's values. + enum: + - spend + - usage + limit: + type: number + title: limit + description: The budget's limit. + currency_code: + type: string + title: currency_code + description: The budget's currency code. + starts_at: + type: string + title: starts_at + description: The campaign's starts at. + format: date-time + ends_at: + type: string + title: ends_at + description: The campaign's ends at. + format: date-time + promotions: + type: array + description: The campaign's promotions. + items: + type: object + description: The promotion's promotions. + required: + - id + properties: + id: + type: string + title: id + description: The promotion's ID. + application_method: + type: object + description: The promotion's application method. + required: + - description + - value + - currency_code + - max_quantity + - type + - target_type + - apply_to_quantity + - buy_rules_min_quantity + properties: + description: + type: string + title: description + description: The application method's description. + value: + type: number + title: value + description: The application method's value. + currency_code: + type: string + title: currency_code + description: The application method's currency code. + max_quantity: + type: number + title: max_quantity + description: The application method's max quantity. + type: + type: string + enum: + - fixed + - percentage + target_type: + type: string + enum: + - order + - shipping_methods + - items + allocation: + type: string + enum: + - each + - across + target_rules: + type: array + description: The application method's target rules. + items: + type: object + description: The target rule's target rules. + required: + - operator + - description + - attribute + - values + properties: + operator: + type: string + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The target rule's description. + attribute: + type: string + title: attribute + description: The target rule's attribute. + values: + oneOf: + - type: string + title: values + description: The target rule's values. + - type: array + description: The target rule's values. + items: + type: string + title: values + description: The value's values. + buy_rules: + type: array + description: The application method's buy rules. + items: + type: object + description: The buy rule's buy rules. + required: + - operator + - description + - attribute + - values + properties: + operator: + type: string + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The buy rule's description. + attribute: + type: string + title: attribute + description: The buy rule's attribute. + values: + oneOf: + - type: string + title: values + description: The buy rule's values. + - type: array + description: The buy rule's values. + items: + type: string + title: values + description: The value's values. + apply_to_quantity: + type: number + title: apply_to_quantity + description: The application method's apply to quantity. + buy_rules_min_quantity: + type: number + title: buy_rules_min_quantity + description: The application method's buy rules min quantity. + rules: + type: array + description: The promotion's rules. + items: + type: object + description: The rule's rules. + required: + - operator + - description + - attribute + - values + properties: + operator: + type: string + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The rule's description. + attribute: + type: string + title: attribute + description: The rule's attribute. + values: + oneOf: + - type: string + title: values + description: The rule's values. + - type: array + description: The rule's values. + items: + type: string + title: values + description: The value's values. + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. + description: SUMMARY x-codeSamples: - lang: Shell label: cURL @@ -36306,265 +31358,276 @@ paths: content: application/json: schema: - description: SUMMARY - properties: - code: - type: string - title: code - description: The promotion's code. - is_automatic: - type: boolean - title: is_automatic - description: The promotion's is automatic. - type: - type: string - enum: - - standard - - buyget - campaign_id: - type: string - title: campaign_id - description: The promotion's campaign id. - campaign: - type: object - description: The promotion's campaign. + allOf: + - type: object + description: SUMMARY required: - - name - - campaign_identifier - - description - - budget - - starts_at - - ends_at + - campaign_id properties: - name: + code: type: string - title: name - description: The campaign's name. - campaign_identifier: - type: string - title: campaign_identifier - description: The campaign's campaign identifier. - description: - type: string - title: description - description: The campaign's description. - budget: - type: object - description: The campaign's budget. - required: - - type - - limit - - currency_code - properties: - type: - type: string - enum: - - spend - - usage - limit: - type: number - title: limit - description: The budget's limit. - currency_code: - type: string - title: currency_code - description: The budget's currency code. - starts_at: - type: string - title: starts_at - description: The campaign's starts at. - format: date-time - ends_at: - type: string - title: ends_at - description: The campaign's ends at. - format: date-time - promotions: - type: array - description: The campaign's promotions. - items: - type: object - description: The promotion's promotions. - required: - - id - properties: - id: - type: string - title: id - description: The promotion's ID. - application_method: - type: object - description: The promotion's application method. - required: - - description - - max_quantity - - currency_code - - apply_to_quantity - - buy_rules_min_quantity - properties: - description: - type: string - title: description - description: The application method's description. - value: - type: number - title: value - description: The application method's value. - max_quantity: - type: number - title: max_quantity - description: The application method's max quantity. - currency_code: - type: string - title: currency_code - description: The application method's currency code. + title: code + description: The promotion's code. + is_automatic: + type: boolean + title: is_automatic + description: The promotion's is automatic. type: type: string enum: - - fixed - - percentage - target_type: + - standard + - buyget + campaign_id: type: string - enum: - - order - - shipping_methods - - items - allocation: - type: string - enum: - - each - - across - target_rules: - type: array - description: The application method's target rules. - items: - type: object - description: The target rule's target rules. - required: - - operator - - description - - attribute - - values - properties: - operator: - type: string - enum: - - gte - - lte - - gt - - lt - - eq - - ne - - in - description: - type: string - title: description - description: The target rule's description. - attribute: - type: string - title: attribute - description: The target rule's attribute. - values: - oneOf: - - type: string - title: values - description: The target rule's values. - - type: array - description: The target rule's values. - items: - type: string - title: values - description: The value's values. - buy_rules: - type: array - description: The application method's buy rules. - items: - type: object - description: The buy rule's buy rules. - required: - - operator - - description - - attribute - - values - properties: - operator: - type: string - enum: - - gte - - lte - - gt - - lt - - eq - - ne - - in - description: - type: string - title: description - description: The buy rule's description. - attribute: - type: string - title: attribute - description: The buy rule's attribute. - values: - oneOf: - - type: string - title: values - description: The buy rule's values. - - type: array - description: The buy rule's values. - items: - type: string - title: values - description: The value's values. - apply_to_quantity: - type: number - title: apply_to_quantity - description: The application method's apply to quantity. - buy_rules_min_quantity: - type: number - title: buy_rules_min_quantity - description: The application method's buy rules min quantity. - rules: - type: array - description: The promotion's rules. - items: - type: object - description: The rule's rules. - required: - - operator - - description - - attribute - - values - properties: - operator: - type: string - enum: - - gte - - lte - - gt - - lt - - eq - - ne - - in - description: - type: string - title: description - description: The rule's description. - attribute: - type: string - title: attribute - description: The rule's attribute. - values: - oneOf: - - type: string - title: values - description: The rule's values. - - type: array - description: The rule's values. - items: + title: campaign_id + description: The promotion's campaign id. + campaign: + type: object + description: The promotion's campaign. + required: + - name + - campaign_identifier + - description + - budget + - starts_at + - ends_at + properties: + name: + type: string + title: name + description: The campaign's name. + campaign_identifier: + type: string + title: campaign_identifier + description: The campaign's campaign identifier. + description: + type: string + title: description + description: The campaign's description. + budget: + type: object + description: The campaign's budget. + required: + - type + - limit + - currency_code + properties: + type: type: string - title: values - description: The value's values. + enum: + - spend + - usage + limit: + type: number + title: limit + description: The budget's limit. + currency_code: + type: string + title: currency_code + description: The budget's currency code. + starts_at: + type: string + title: starts_at + description: The campaign's starts at. + format: date-time + ends_at: + type: string + title: ends_at + description: The campaign's ends at. + format: date-time + promotions: + type: array + description: The campaign's promotions. + items: + type: object + description: The promotion's promotions. + required: + - id + properties: + id: + type: string + title: id + description: The promotion's ID. + application_method: + type: object + description: The promotion's application method. + required: + - description + - max_quantity + - currency_code + - apply_to_quantity + - buy_rules_min_quantity + properties: + description: + type: string + title: description + description: The application method's description. + value: + type: number + title: value + description: The application method's value. + max_quantity: + type: number + title: max_quantity + description: The application method's max quantity. + currency_code: + type: string + title: currency_code + description: The application method's currency code. + type: + type: string + enum: + - fixed + - percentage + target_type: + type: string + enum: + - order + - shipping_methods + - items + allocation: + type: string + enum: + - each + - across + target_rules: + type: array + description: The application method's target rules. + items: + type: object + description: The target rule's target rules. + required: + - operator + - description + - attribute + - values + properties: + operator: + type: string + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The target rule's description. + attribute: + type: string + title: attribute + description: The target rule's attribute. + values: + oneOf: + - type: string + title: values + description: The target rule's values. + - type: array + description: The target rule's values. + items: + type: string + title: values + description: The value's values. + buy_rules: + type: array + description: The application method's buy rules. + items: + type: object + description: The buy rule's buy rules. + required: + - operator + - description + - attribute + - values + properties: + operator: + type: string + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The buy rule's description. + attribute: + type: string + title: attribute + description: The buy rule's attribute. + values: + oneOf: + - type: string + title: values + description: The buy rule's values. + - type: array + description: The buy rule's values. + items: + type: string + title: values + description: The value's values. + apply_to_quantity: + type: number + title: apply_to_quantity + description: The application method's apply to quantity. + buy_rules_min_quantity: + type: number + title: buy_rules_min_quantity + description: The application method's buy rules min quantity. + rules: + type: array + description: The promotion's rules. + items: + type: object + description: The rule's rules. + required: + - operator + - description + - attribute + - values + properties: + operator: + type: string + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The rule's description. + attribute: + type: string + title: attribute + description: The rule's attribute. + values: + oneOf: + - type: string + title: values + description: The rule's values. + - type: array + description: The rule's values. + items: + type: string + title: values + description: The value's values. + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. + description: SUMMARY x-codeSamples: - lang: Shell label: cURL @@ -47624,88 +42687,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - post: - operationId: PostUsers - summary: Create User - description: Create a user. - x-authenticated: false - parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CreateUser' - x-codeSamples: - - lang: Shell - label: cURL - source: |- - curl -X POST '{backend_url}/admin/users' \ - -H 'Content-Type: application/json' \ - --data-raw '{ - "email": "Janie42@hotmail.com" - }' - tags: - - Users - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminUserResponse' - '400': - $ref: '#/components/responses/400_error' - '401': - $ref: '#/components/responses/unauthorized' - '404': - $ref: '#/components/responses/not_found_error' - '409': - $ref: '#/components/responses/invalid_state_error' - '422': - $ref: '#/components/responses/invalid_request_error' - '500': - $ref: '#/components/responses/500_error' - x-workflow: createUserAccountWorkflow /admin/users/me: get: operationId: GetUsersMe @@ -52839,6 +47820,15 @@ components: description: The payment collection's payments. items: $ref: '#/components/schemas/BasePayment' + AdminPaymentCollectionResponse: + type: object + description: SUMMARY + x-schemaName: AdminPaymentCollectionResponse + required: + - payment_collection + properties: + payment_collection: + $ref: '#/components/schemas/AdminPaymentCollection' AdminPaymentProvider: type: object description: The payment provider's payment providers. @@ -59661,6 +54651,67 @@ components: metadata: type: object description: The item's metadata. + CreateCartWorkflowInput: + type: object + description: SUMMARY + x-schemaName: CreateCartWorkflowInput + properties: + region_id: + type: string + title: region_id + description: The cart's region id. + customer_id: + type: string + title: customer_id + description: The cart's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The cart's sales channel id. + email: + type: string + title: email + description: The cart's email. + format: email + currency_code: + type: string + title: currency_code + description: The cart's currency code. + shipping_address_id: + type: string + title: shipping_address_id + description: The cart's shipping address id. + billing_address_id: + type: string + title: billing_address_id + description: The cart's billing address id. + shipping_address: + oneOf: + - type: string + title: shipping_address + description: The cart's shipping address. + - $ref: '#/components/schemas/CreateCartAddress' + billing_address: + oneOf: + - type: string + title: billing_address + description: The cart's billing address. + - $ref: '#/components/schemas/CreateCartAddress' + metadata: + type: object + description: The cart's metadata. + items: + type: array + description: The cart's items. + items: + $ref: '#/components/schemas/CreateCartCreateLineItem' + promo_codes: + type: array + description: The cart's promo codes. + items: + type: string + title: promo_codes + description: The promo code's promo codes. CreateOrderReturnReason: type: object description: SUMMARY @@ -59688,33 +54739,6 @@ components: metadata: type: object description: The return reason's metadata. - CreateUser: - type: object - description: SUMMARY - x-schemaName: CreateUser - required: - - email - properties: - email: - type: string - title: email - description: The user's email. - format: email - first_name: - type: string - title: first_name - description: The user's first name. - last_name: - type: string - title: last_name - description: The user's last name. - avatar_url: - type: string - title: avatar_url - description: The user's avatar url. - metadata: - type: object - description: The user's metadata. Error: title: Response Error type: object @@ -63655,6 +58679,51 @@ components: metadata: type: object description: The shipping address's metadata. + UpdateCartData: + type: object + description: SUMMARY + x-schemaName: UpdateCartData + properties: + region_id: + type: string + title: region_id + description: The cart's region id. + customer_id: + type: string + title: customer_id + description: The cart's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The cart's sales channel id. + email: + type: string + title: email + description: The cart's email. + format: email + currency_code: + type: string + title: currency_code + description: The cart's currency code. + shipping_address_id: + type: string + title: shipping_address_id + description: The cart's shipping address id. + billing_address_id: + type: string + title: billing_address_id + description: The cart's billing address id. + billing_address: + oneOf: + - $ref: '#/components/schemas/CreateAddress' + - $ref: '#/components/schemas/UpdateAddress' + shipping_address: + oneOf: + - $ref: '#/components/schemas/CreateAddress' + - $ref: '#/components/schemas/UpdateAddress' + metadata: + type: object + description: The cart's metadata. UpdateOrderReturnReason: type: object description: SUMMARY diff --git a/www/apps/api-reference/specs/admin/openapi.yaml b/www/apps/api-reference/specs/admin/openapi.yaml index b903a762a6..1a0b2b8c77 100644 --- a/www/apps/api-reference/specs/admin/openapi.yaml +++ b/www/apps/api-reference/specs/admin/openapi.yaml @@ -74,6 +74,9 @@ tags: - name: Orders x-associatedSchema: $ref: ./components/schemas/AdminOrder.yaml + - name: Payment Collections + x-associatedSchema: + $ref: ./components/schemas/AdminPaymentCollection.yaml - name: Payments x-associatedSchema: $ref: ./components/schemas/AdminPayment.yaml @@ -318,6 +321,8 @@ paths: $ref: paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments.yaml /admin/orders/{id}/preview: $ref: paths/admin_orders_{id}_preview.yaml + /admin/payment-collections: + $ref: paths/admin_payment-collections.yaml /admin/payments: $ref: paths/admin_payments.yaml /admin/payments/payment-providers: diff --git a/www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml b/www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml index 150ee0520c..cb6e649509 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml @@ -189,64 +189,83 @@ post: content: application/json: schema: - description: SUMMARY - properties: - name: - type: string - title: name - description: The campaign's name. - campaign_identifier: - type: string - title: campaign_identifier - description: The campaign's campaign identifier. - description: - type: string - title: description - description: The campaign's description. - budget: - type: object - description: The campaign's budget. + allOf: + - type: object + description: SUMMARY required: - - type - - limit - - currency_code + - name + - campaign_identifier + - description + - budget + - starts_at + - ends_at properties: - type: + name: type: string - enum: - - spend - - usage - limit: - type: number - title: limit - description: The budget's limit. - currency_code: + title: name + description: The campaign's name. + campaign_identifier: type: string - title: currency_code - description: The budget's currency code. - starts_at: - type: string - title: starts_at - description: The campaign's starts at. - format: date-time - ends_at: - type: string - title: ends_at - description: The campaign's ends at. - format: date-time - promotions: - type: array - description: The campaign's promotions. - items: - type: object - description: The promotion's promotions. - required: - - id - properties: - id: - type: string - title: id - description: The promotion's ID. + title: campaign_identifier + description: The campaign's campaign identifier. + description: + type: string + title: description + description: The campaign's description. + budget: + type: object + description: The campaign's budget. + required: + - type + - limit + - currency_code + properties: + type: + type: string + enum: + - spend + - usage + limit: + type: number + title: limit + description: The budget's limit. + currency_code: + type: string + title: currency_code + description: The budget's currency code. + starts_at: + type: string + title: starts_at + description: The campaign's starts at. + format: date-time + ends_at: + type: string + title: ends_at + description: The campaign's ends at. + format: date-time + promotions: + type: array + description: The campaign's promotions. + items: + type: object + description: The promotion's promotions. + required: + - id + properties: + id: + type: string + title: id + description: The promotion's ID. + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: >- + Pass additional custom data to the API route. This data is + passed to the underlying workflow under the + `additional_data` parameter. + description: SUMMARY x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}.yaml index ab0199b1ec..e06b6995dd 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}.yaml @@ -172,53 +172,69 @@ post: content: application/json: schema: - description: SUMMARY - properties: - name: - type: string - title: name - description: The campaign's name. - campaign_identifier: - type: string - title: campaign_identifier - description: The campaign's campaign identifier. - description: - type: string - title: description - description: The campaign's description. - budget: - type: object - description: The campaign's budget. + allOf: + - type: object + description: SUMMARY required: - - limit + - description + - starts_at + - ends_at properties: - limit: - type: number - title: limit - description: The budget's limit. - starts_at: - type: string - title: starts_at - description: The campaign's starts at. - format: date-time - ends_at: - type: string - title: ends_at - description: The campaign's ends at. - format: date-time - promotions: - type: array - description: The campaign's promotions. - items: - type: object - description: The promotion's promotions. - required: - - id - properties: - id: - type: string - title: id - description: The promotion's ID. + name: + type: string + title: name + description: The campaign's name. + campaign_identifier: + type: string + title: campaign_identifier + description: The campaign's campaign identifier. + description: + type: string + title: description + description: The campaign's description. + budget: + type: object + description: The campaign's budget. + required: + - limit + properties: + limit: + type: number + title: limit + description: The budget's limit. + starts_at: + type: string + title: starts_at + description: The campaign's starts at. + format: date-time + ends_at: + type: string + title: ends_at + description: The campaign's ends at. + format: date-time + promotions: + type: array + description: The campaign's promotions. + items: + type: object + description: The promotion's promotions. + required: + - id + properties: + id: + type: string + title: id + description: The promotion's ID. + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: >- + Pass additional custom data to the API route. This data is + passed to the underlying workflow under the + `additional_data` parameter. + description: SUMMARY x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_customers.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers.yaml index 90c46e1cd5..5bfe96b537 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers.yaml @@ -186,32 +186,51 @@ post: content: application/json: schema: + allOf: + - type: object + description: SUMMARY + required: + - email + - company_name + - first_name + - last_name + - phone + - metadata + properties: + email: + type: string + title: email + description: The customer's email. + format: email + company_name: + type: string + title: company_name + description: The customer's company name. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + phone: + type: string + title: phone + description: The customer's phone. + metadata: + type: object + description: The customer's metadata. + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: >- + Pass additional custom data to the API route. This data is + passed to the underlying workflow under the + `additional_data` parameter. description: SUMMARY - properties: - email: - type: string - title: email - description: The customer's email. - format: email - company_name: - type: string - title: company_name - description: The customer's company name. - first_name: - type: string - title: first_name - description: The customer's first name. - last_name: - type: string - title: last_name - description: The customer's last name. - phone: - type: string - title: phone - description: The customer's phone. - metadata: - type: object - description: The customer's metadata. x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}.yaml index 2f91fd4d5a..2c3be88568 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}.yaml @@ -172,32 +172,51 @@ post: content: application/json: schema: + allOf: + - type: object + description: SUMMARY + required: + - email + - company_name + - first_name + - last_name + - phone + - metadata + properties: + email: + type: string + title: email + description: The customer's email. + format: email + company_name: + type: string + title: company_name + description: The customer's company name. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + phone: + type: string + title: phone + description: The customer's phone. + metadata: + type: object + description: The customer's metadata. + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: >- + Pass additional custom data to the API route. This data is + passed to the underlying workflow under the + `additional_data` parameter. description: SUMMARY - properties: - email: - type: string - title: email - description: The customer's email. - format: email - company_name: - type: string - title: company_name - description: The customer's company name. - first_name: - type: string - title: first_name - description: The customer's first name. - last_name: - type: string - title: last_name - description: The customer's last name. - phone: - type: string - title: phone - description: The customer's phone. - metadata: - type: object - description: The customer's metadata. x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses.yaml index 76940caa96..28bdb52358 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses.yaml @@ -201,63 +201,88 @@ post: content: application/json: schema: + allOf: + - type: object + description: SUMMARY + required: + - address_name + - company + - first_name + - last_name + - address_1 + - address_2 + - city + - country_code + - province + - postal_code + - phone + - metadata + properties: + address_name: + type: string + title: address_name + description: The customer's address name. + is_default_shipping: + type: boolean + title: is_default_shipping + description: The customer's is default shipping. + is_default_billing: + type: boolean + title: is_default_billing + description: The customer's is default billing. + company: + type: string + title: company + description: The customer's company. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + address_1: + type: string + title: address_1 + description: The customer's address 1. + address_2: + type: string + title: address_2 + description: The customer's address 2. + city: + type: string + title: city + description: The customer's city. + country_code: + type: string + title: country_code + description: The customer's country code. + province: + type: string + title: province + description: The customer's province. + postal_code: + type: string + title: postal_code + description: The customer's postal code. + phone: + type: string + title: phone + description: The customer's phone. + metadata: + type: object + description: The customer's metadata. + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: >- + Pass additional custom data to the API route. This data is + passed to the underlying workflow under the + `additional_data` parameter. description: SUMMARY - properties: - address_name: - type: string - title: address_name - description: The customer's address name. - is_default_shipping: - type: boolean - title: is_default_shipping - description: The customer's is default shipping. - is_default_billing: - type: boolean - title: is_default_billing - description: The customer's is default billing. - company: - type: string - title: company - description: The customer's company. - first_name: - type: string - title: first_name - description: The customer's first name. - last_name: - type: string - title: last_name - description: The customer's last name. - address_1: - type: string - title: address_1 - description: The customer's address 1. - address_2: - type: string - title: address_2 - description: The customer's address 2. - city: - type: string - title: city - description: The customer's city. - country_code: - type: string - title: country_code - description: The customer's country code. - province: - type: string - title: province - description: The customer's province. - postal_code: - type: string - title: postal_code - description: The customer's postal code. - phone: - type: string - title: phone - description: The customer's phone. - metadata: - type: object - description: The customer's metadata. x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses_{address_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses_{address_id}.yaml index 2e0a1f5b9a..9e98385ce1 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses_{address_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses_{address_id}.yaml @@ -185,63 +185,88 @@ post: content: application/json: schema: + allOf: + - type: object + description: SUMMARY + required: + - address_name + - company + - first_name + - last_name + - address_1 + - address_2 + - city + - country_code + - province + - postal_code + - phone + - metadata + properties: + address_name: + type: string + title: address_name + description: The customer's address name. + is_default_shipping: + type: boolean + title: is_default_shipping + description: The customer's is default shipping. + is_default_billing: + type: boolean + title: is_default_billing + description: The customer's is default billing. + company: + type: string + title: company + description: The customer's company. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + address_1: + type: string + title: address_1 + description: The customer's address 1. + address_2: + type: string + title: address_2 + description: The customer's address 2. + city: + type: string + title: city + description: The customer's city. + country_code: + type: string + title: country_code + description: The customer's country code. + province: + type: string + title: province + description: The customer's province. + postal_code: + type: string + title: postal_code + description: The customer's postal code. + phone: + type: string + title: phone + description: The customer's phone. + metadata: + type: object + description: The customer's metadata. + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: >- + Pass additional custom data to the API route. This data is + passed to the underlying workflow under the + `additional_data` parameter. description: SUMMARY - properties: - address_name: - type: string - title: address_name - description: The customer's address name. - is_default_shipping: - type: boolean - title: is_default_shipping - description: The customer's is default shipping. - is_default_billing: - type: boolean - title: is_default_billing - description: The customer's is default billing. - company: - type: string - title: company - description: The customer's company. - first_name: - type: string - title: first_name - description: The customer's first name. - last_name: - type: string - title: last_name - description: The customer's last name. - address_1: - type: string - title: address_1 - description: The customer's address 1. - address_2: - type: string - title: address_2 - description: The customer's address 2. - city: - type: string - title: city - description: The customer's city. - country_code: - type: string - title: country_code - description: The customer's country code. - province: - type: string - title: province - description: The customer's province. - postal_code: - type: string - title: postal_code - description: The customer's postal code. - phone: - type: string - title: phone - description: The customer's phone. - metadata: - type: object - description: The customer's metadata. x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_draft-orders.yaml b/www/apps/api-reference/specs/admin/paths/admin_draft-orders.yaml index 9a652e13fd..86b04d2212 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_draft-orders.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_draft-orders.yaml @@ -186,279 +186,299 @@ post: content: application/json: schema: + allOf: + - type: object + description: SUMMARY + required: + - sales_channel_id + - email + - customer_id + - region_id + - currency_code + - shipping_methods + - metadata + properties: + status: + type: boolean + title: status + description: The draft order's status. + sales_channel_id: + type: string + title: sales_channel_id + description: The draft order's sales channel id. + email: + type: string + title: email + description: The draft order's email. + format: email + customer_id: + type: string + title: customer_id + description: The draft order's customer id. + billing_address: + type: object + description: The draft order's billing address. + required: + - first_name + - last_name + - phone + - company + - address_1 + - address_2 + - city + - country_code + - province + - postal_code + - metadata + properties: + first_name: + type: string + title: first_name + description: The billing address's first name. + last_name: + type: string + title: last_name + description: The billing address's last name. + phone: + type: string + title: phone + description: The billing address's phone. + company: + type: string + title: company + description: The billing address's company. + address_1: + type: string + title: address_1 + description: The billing address's address 1. + address_2: + type: string + title: address_2 + description: The billing address's address 2. + city: + type: string + title: city + description: The billing address's city. + country_code: + type: string + title: country_code + description: The billing address's country code. + province: + type: string + title: province + description: The billing address's province. + postal_code: + type: string + title: postal_code + description: The billing address's postal code. + metadata: + type: object + description: The billing address's metadata. + shipping_address: + type: object + description: The draft order's shipping address. + required: + - first_name + - last_name + - phone + - company + - address_1 + - address_2 + - city + - country_code + - province + - postal_code + - metadata + properties: + first_name: + type: string + title: first_name + description: The shipping address's first name. + last_name: + type: string + title: last_name + description: The shipping address's last name. + phone: + type: string + title: phone + description: The shipping address's phone. + company: + type: string + title: company + description: The shipping address's company. + address_1: + type: string + title: address_1 + description: The shipping address's address 1. + address_2: + type: string + title: address_2 + description: The shipping address's address 2. + city: + type: string + title: city + description: The shipping address's city. + country_code: + type: string + title: country_code + description: The shipping address's country code. + province: + type: string + title: province + description: The shipping address's province. + postal_code: + type: string + title: postal_code + description: The shipping address's postal code. + metadata: + type: object + description: The shipping address's metadata. + items: + type: array + description: The draft order's items. + items: + type: object + description: The item's items. + required: + - title + - sku + - barcode + - variant_id + - unit_price + - quantity + - metadata + properties: + title: + type: string + title: title + description: The item's title. + sku: + type: string + title: sku + description: The item's sku. + barcode: + type: string + title: barcode + description: The item's barcode. + variant_id: + type: string + title: variant_id + description: The item's variant id. + unit_price: + oneOf: + - type: string + title: unit_price + description: The item's unit price. + - type: number + title: unit_price + description: The item's unit price. + - type: object + description: The item's unit price. + required: + - value + - precision + properties: + value: + type: string + title: value + description: The unit price's value. + precision: + type: number + title: precision + description: The unit price's precision. + quantity: + type: number + title: quantity + description: The item's quantity. + metadata: + type: object + description: The item's metadata. + region_id: + type: string + title: region_id + description: The draft order's region id. + promo_codes: + type: array + description: The draft order's promo codes. + items: + type: string + title: promo_codes + description: The promo code's promo codes. + currency_code: + type: string + title: currency_code + description: The draft order's currency code. + no_notification_order: + type: boolean + title: no_notification_order + description: The draft order's no notification order. + shipping_methods: + type: array + description: The draft order's shipping methods. + items: + type: object + description: The shipping method's shipping methods. + required: + - shipping_method_id + - order_id + - name + - option_id + - amount + properties: + shipping_method_id: + type: string + title: shipping_method_id + description: The shipping method's shipping method id. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + option_id: + type: string + title: option_id + description: The shipping method's option id. + data: + type: object + description: The shipping method's data. + amount: + oneOf: + - type: string + title: amount + description: The shipping method's amount. + - type: number + title: amount + description: The shipping method's amount. + - type: object + description: The shipping method's amount. + required: + - value + - precision + properties: + value: + type: string + title: value + description: The amount's value. + precision: + type: number + title: precision + description: The amount's precision. + metadata: + type: object + description: The draft order's metadata. + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: >- + Pass additional custom data to the API route. This data is + passed to the underlying workflow under the + `additional_data` parameter. description: SUMMARY - properties: - status: - type: boolean - title: status - description: The draft order's status. - sales_channel_id: - type: string - title: sales_channel_id - description: The draft order's sales channel id. - email: - type: string - title: email - description: The draft order's email. - format: email - customer_id: - type: string - title: customer_id - description: The draft order's customer id. - billing_address: - type: object - description: The draft order's billing address. - required: - - first_name - - last_name - - phone - - company - - address_1 - - address_2 - - city - - country_code - - province - - postal_code - - metadata - properties: - first_name: - type: string - title: first_name - description: The billing address's first name. - last_name: - type: string - title: last_name - description: The billing address's last name. - phone: - type: string - title: phone - description: The billing address's phone. - company: - type: string - title: company - description: The billing address's company. - address_1: - type: string - title: address_1 - description: The billing address's address 1. - address_2: - type: string - title: address_2 - description: The billing address's address 2. - city: - type: string - title: city - description: The billing address's city. - country_code: - type: string - title: country_code - description: The billing address's country code. - province: - type: string - title: province - description: The billing address's province. - postal_code: - type: string - title: postal_code - description: The billing address's postal code. - metadata: - type: object - description: The billing address's metadata. - shipping_address: - type: object - description: The draft order's shipping address. - required: - - first_name - - last_name - - phone - - company - - address_1 - - address_2 - - city - - country_code - - province - - postal_code - - metadata - properties: - first_name: - type: string - title: first_name - description: The shipping address's first name. - last_name: - type: string - title: last_name - description: The shipping address's last name. - phone: - type: string - title: phone - description: The shipping address's phone. - company: - type: string - title: company - description: The shipping address's company. - address_1: - type: string - title: address_1 - description: The shipping address's address 1. - address_2: - type: string - title: address_2 - description: The shipping address's address 2. - city: - type: string - title: city - description: The shipping address's city. - country_code: - type: string - title: country_code - description: The shipping address's country code. - province: - type: string - title: province - description: The shipping address's province. - postal_code: - type: string - title: postal_code - description: The shipping address's postal code. - metadata: - type: object - description: The shipping address's metadata. - items: - type: array - description: The draft order's items. - items: - type: object - description: The item's items. - required: - - title - - sku - - barcode - - variant_id - - unit_price - - quantity - - metadata - properties: - title: - type: string - title: title - description: The item's title. - sku: - type: string - title: sku - description: The item's sku. - barcode: - type: string - title: barcode - description: The item's barcode. - variant_id: - type: string - title: variant_id - description: The item's variant id. - unit_price: - oneOf: - - type: string - title: unit_price - description: The item's unit price. - - type: number - title: unit_price - description: The item's unit price. - - type: object - description: The item's unit price. - required: - - value - - precision - properties: - value: - type: string - title: value - description: The unit price's value. - precision: - type: number - title: precision - description: The unit price's precision. - quantity: - type: number - title: quantity - description: The item's quantity. - metadata: - type: object - description: The item's metadata. - region_id: - type: string - title: region_id - description: The draft order's region id. - promo_codes: - type: array - description: The draft order's promo codes. - items: - type: string - title: promo_codes - description: The promo code's promo codes. - currency_code: - type: string - title: currency_code - description: The draft order's currency code. - no_notification_order: - type: boolean - title: no_notification_order - description: The draft order's no notification order. - shipping_methods: - type: array - description: The draft order's shipping methods. - items: - type: object - description: The shipping method's shipping methods. - required: - - shipping_method_id - - order_id - - name - - option_id - - amount - properties: - shipping_method_id: - type: string - title: shipping_method_id - description: The shipping method's shipping method id. - order_id: - type: string - title: order_id - description: The shipping method's order id. - name: - type: string - title: name - description: The shipping method's name. - option_id: - type: string - title: option_id - description: The shipping method's option id. - data: - type: object - description: The shipping method's data. - amount: - oneOf: - - type: string - title: amount - description: The shipping method's amount. - - type: number - title: amount - description: The shipping method's amount. - - type: object - description: The shipping method's amount. - required: - - value - - precision - properties: - value: - type: string - title: value - description: The amount's value. - precision: - type: number - title: precision - description: The amount's precision. - metadata: - type: object - description: The draft order's metadata. x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}.yaml index 668a926867..13a13e077d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}.yaml @@ -24,18 +24,20 @@ get: data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: >- + Comma-separated fields that should be included in the returned data. if + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. without prefix it will + replace the entire default fields. required: false schema: type: string title: fields - description: |- + description: >- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. without + prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits.yaml index 3e83453347..bca2785507 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits.yaml @@ -16,18 +16,20 @@ post: data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: >- + Comma-separated fields that should be included in the returned data. if + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. without prefix it will + replace the entire default fields. required: false schema: type: string title: fields - description: |- + description: >- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. without + prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}.yaml index 3be8eb02ad..0b23979f0e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}.yaml @@ -22,18 +22,20 @@ delete: data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: >- + Comma-separated fields that should be included in the returned data. if + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. without prefix it will + replace the entire default fields. required: false schema: type: string title: fields - description: |- + description: >- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. without + prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_confirm.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_confirm.yaml index 7f21a0ebff..a99c068940 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_confirm.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_confirm.yaml @@ -22,18 +22,20 @@ post: data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: >- + Comma-separated fields that should be included in the returned data. if + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. without prefix it will + replace the entire default fields. required: false schema: type: string title: fields - description: |- + description: >- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. without + prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -94,3 +96,7 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: confirmOrderEditRequestWorkflow + requestBody: + content: + application/json: + schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items.yaml index 0eec4f5d0e..624cb2c2ab 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items.yaml @@ -22,18 +22,20 @@ post: data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: >- + Comma-separated fields that should be included in the returned data. if + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. without prefix it will + replace the entire default fields. required: false schema: type: string title: fields - description: |- + description: >- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. without + prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_{action_id}.yaml index 389191c60e..40993c5ed7 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_{action_id}.yaml @@ -28,18 +28,20 @@ post: data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: >- + Comma-separated fields that should be included in the returned data. if + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. without prefix it will + replace the entire default fields. required: false schema: type: string title: fields - description: |- + description: >- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. without + prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -137,18 +139,20 @@ delete: data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: >- + Comma-separated fields that should be included in the returned data. if + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. without prefix it will + replace the entire default fields. required: false schema: type: string title: fields - description: |- + description: >- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. without + prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method.yaml index f53160451e..57646206d5 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method.yaml @@ -22,18 +22,20 @@ post: data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: >- + Comma-separated fields that should be included in the returned data. if + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. without prefix it will + replace the entire default fields. required: false schema: type: string title: fields - description: |- + description: >- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. without + prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method_{action_id}.yaml index 1be0ad0665..fbe0391b82 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method_{action_id}.yaml @@ -28,18 +28,20 @@ post: data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: >- + Comma-separated fields that should be included in the returned data. if + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. without prefix it will + replace the entire default fields. required: false schema: type: string title: fields - description: |- + description: >- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. without + prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -140,18 +142,20 @@ delete: data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: >- + Comma-separated fields that should be included in the returned data. if + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. without prefix it will + replace the entire default fields. required: false schema: type: string title: fields - description: |- + description: >- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. without + prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_complete.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_complete.yaml index 44f3510f05..ba7bf7255c 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_complete.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_complete.yaml @@ -73,12 +73,26 @@ post: content: application/json: schema: + allOf: + - type: object + description: SUMMARY + required: + - order_id + properties: + order_id: + type: string + title: order_id + description: The order's order id. + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: >- + Pass additional custom data to the API route. This data is + passed to the underlying workflow under the + `additional_data` parameter. description: SUMMARY - properties: - order_id: - type: string - title: order_id - description: The order's order id. x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments.yaml index 066ece5955..dbd891d43d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments.yaml @@ -73,37 +73,53 @@ post: content: application/json: schema: + allOf: + - type: object + description: SUMMARY + required: + - items + - location_id + - metadata + properties: + items: + type: array + description: The order's items. + items: + type: object + description: The item's items. + required: + - id + - quantity + properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + location_id: + type: string + title: location_id + description: The order's location id. + no_notification: + type: boolean + title: no_notification + description: The order's no notification. + metadata: + type: object + description: The order's metadata. + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: >- + Pass additional custom data to the API route. This data is + passed to the underlying workflow under the + `additional_data` parameter. description: SUMMARY - properties: - items: - type: array - description: The order's items. - items: - type: object - description: The item's items. - required: - - id - - quantity - properties: - id: - type: string - title: id - description: The item's ID. - quantity: - type: number - title: quantity - description: The item's quantity. - location_id: - type: string - title: location_id - description: The order's location id. - no_notification: - type: boolean - title: no_notification - description: The order's no notification. - metadata: - type: object - description: The order's metadata. x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml index 3b76af2726..721490c218 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml @@ -79,12 +79,24 @@ post: content: application/json: schema: + allOf: + - type: object + description: SUMMARY + properties: + no_notification: + type: boolean + title: no_notification + description: The order's no notification. + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: >- + Pass additional custom data to the API route. This data is + passed to the underlying workflow under the + `additional_data` parameter. description: SUMMARY - properties: - no_notification: - type: boolean - title: no_notification - description: The order's no notification. x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments.yaml index 5a8691358d..afd3b98810 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments.yaml @@ -79,56 +79,71 @@ post: content: application/json: schema: + allOf: + - type: object + description: SUMMARY + required: + - items + - metadata + properties: + items: + type: array + description: The order's items. + items: + type: object + description: The item's items. + required: + - id + - quantity + properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + labels: + type: array + description: The order's labels. + items: + type: object + description: The label's labels. + required: + - tracking_number + - tracking_url + - label_url + properties: + tracking_number: + type: string + title: tracking_number + description: The label's tracking number. + tracking_url: + type: string + title: tracking_url + description: The label's tracking url. + label_url: + type: string + title: label_url + description: The label's label url. + no_notification: + type: boolean + title: no_notification + description: The order's no notification. + metadata: + type: object + description: The order's metadata. + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: >- + Pass additional custom data to the API route. This data is + passed to the underlying workflow under the + `additional_data` parameter. description: SUMMARY - properties: - items: - type: array - description: The order's items. - items: - type: object - description: The item's items. - required: - - id - - quantity - properties: - id: - type: string - title: id - description: The item's ID. - quantity: - type: number - title: quantity - description: The item's quantity. - labels: - type: array - description: The order's labels. - items: - type: object - description: The label's labels. - required: - - tracking_number - - tracking_url - - label_url - properties: - tracking_number: - type: string - title: tracking_number - description: The label's tracking number. - tracking_url: - type: string - title: tracking_url - description: The label's tracking url. - label_url: - type: string - title: label_url - description: The label's label url. - no_notification: - type: boolean - title: no_notification - description: The order's no notification. - metadata: - type: object - description: The order's metadata. x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_payment-collections.yaml b/www/apps/api-reference/specs/admin/paths/admin_payment-collections.yaml new file mode 100644 index 0000000000..027f6c207f --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_payment-collections.yaml @@ -0,0 +1,107 @@ +post: + operationId: PostPaymentCollections + summary: Create Payment Collection + description: Create a payment collection. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - order_id + properties: + order_id: + type: string + title: order_id + description: The payment collection's order id. + amount: + type: number + title: amount + description: The payment collection's amount. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_payment-collections/post.sh + tags: + - Payment Collections + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminPaymentCollectionResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml + x-workflow: createOrderPaymentCollectionWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_products.yaml b/www/apps/api-reference/specs/admin/paths/admin_products.yaml index 0b9bf1908e..8fc8ca27fc 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products.yaml @@ -10156,1915 +10156,10 @@ get: type: array description: The product's $and. items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - properties: - q: - type: string - title: q - description: The $and's q. - status: - oneOf: - - type: string - title: status - description: The $and's status. - - type: string - title: status - description: The $and's status. - - type: string - title: status - description: The $and's status. - - type: string - title: status - description: The $and's status. - - type: array - description: The $and's status. - items: - type: string - enum: - - draft - - proposed - - published - - rejected - sales_channel_id: - oneOf: - - type: string - title: sales_channel_id - description: The $and's sales channel id. - - type: array - description: The $and's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - title: - oneOf: - - type: string - title: title - description: The $and's title. - - type: array - description: The $and's title. - items: - type: string - title: title - description: The title's details. - handle: - oneOf: - - type: string - title: handle - description: The $and's handle. - - type: array - description: The $and's handle. - items: - type: string - title: handle - description: The handle's details. - id: - oneOf: - - type: string - title: id - description: The $and's ID. - - type: array - description: The $and's ID. - items: - type: string - title: id - description: The id's ID. - is_giftcard: - type: boolean - title: is_giftcard - description: The $and's is giftcard. - tags: - type: object - description: The $and's tags. - properties: - value: - type: array - description: The tag's value. - items: - type: string - title: value - description: The value's details. - type_id: - oneOf: - - type: string - title: type_id - description: The $and's type id. - - type: array - description: The $and's type id. - items: - type: string - title: type_id - description: The type id's details. - category_id: - oneOf: - - type: string - title: category_id - description: The $and's category id. - - type: array - description: The $and's category id. - items: - type: string - title: category_id - description: The category id's details. - - type: object - description: The $and's category id. - properties: - $and: - type: array - description: The category id's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The category id's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The category id's $eq. - - type: object - description: The category id's $eq. - x-schemaName: RegExp - - type: array - description: The category id's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The category id's $ne. - - type: object - description: The category id's $ne. - x-schemaName: RegExp - $in: - type: array - description: The category id's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The category id's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The category id's $not. - - type: object - description: The category id's $not. - x-schemaName: RegExp - - type: object - description: The category id's $not. - - type: array - description: The category id's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The category id's $gt. - - type: object - description: The category id's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The category id's $gte. - - type: object - description: The category id's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The category id's $lt. - - type: object - description: The category id's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The category id's $lte. - - type: object - description: The category id's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The category id's $like. - $re: - type: string - title: $re - description: The category id's $re. - $ilike: - type: string - title: $ilike - description: The category id's $ilike. - $fulltext: - type: string - title: $fulltext - description: The category id's $fulltext. - $overlap: - type: array - description: The category id's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The category id's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The category id's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The category id's $exists. - categories: - oneOf: - - type: object - description: The $and's categories. - required: - - id - properties: - id: - type: object - description: The category's ID. - - type: object - description: The $and's categories. - required: - - id - properties: - id: - type: object - description: The category's ID. - collection_id: - oneOf: - - type: string - title: collection_id - description: The $and's collection id. - - type: array - description: The $and's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - - type: object - description: The $and's collection id. - properties: - $and: - type: array - description: The collection id's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The collection id's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The collection id's $eq. - - type: object - description: The collection id's $eq. - x-schemaName: RegExp - - type: array - description: The collection id's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The collection id's $ne. - - type: object - description: The collection id's $ne. - x-schemaName: RegExp - $in: - type: array - description: The collection id's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The collection id's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The collection id's $not. - - type: object - description: The collection id's $not. - x-schemaName: RegExp - - type: object - description: The collection id's $not. - - type: array - description: The collection id's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The collection id's $gt. - - type: object - description: The collection id's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The collection id's $gte. - - type: object - description: The collection id's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The collection id's $lt. - - type: object - description: The collection id's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The collection id's $lte. - - type: object - description: The collection id's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The collection id's $like. - $re: - type: string - title: $re - description: The collection id's $re. - $ilike: - type: string - title: $ilike - description: The collection id's $ilike. - $fulltext: - type: string - title: $fulltext - description: The collection id's $fulltext. - $overlap: - type: array - description: The collection id's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The collection id's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The collection id's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The collection id's $exists. - created_at: - type: object - description: The $and's created at. - properties: - $and: - type: array - description: The created at's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The created at's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The created at's $eq. - - type: object - description: The created at's $eq. - x-schemaName: RegExp - - type: array - description: The created at's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The created at's $ne. - - type: object - description: The created at's $ne. - x-schemaName: RegExp - $in: - type: array - description: The created at's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The created at's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The created at's $not. - - type: object - description: The created at's $not. - x-schemaName: RegExp - - type: object - description: The created at's $not. - - type: array - description: The created at's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The created at's $gt. - - type: object - description: The created at's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The created at's $gte. - - type: object - description: The created at's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The created at's $lt. - - type: object - description: The created at's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The created at's $lte. - - type: object - description: The created at's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The created at's $like. - $re: - type: string - title: $re - description: The created at's $re. - $ilike: - type: string - title: $ilike - description: The created at's $ilike. - $fulltext: - type: string - title: $fulltext - description: The created at's $fulltext. - $overlap: - type: array - description: The created at's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The created at's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The created at's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The created at's $exists. - updated_at: - type: object - description: The $and's updated at. - properties: - $and: - type: array - description: The updated at's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The updated at's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The updated at's $eq. - - type: object - description: The updated at's $eq. - x-schemaName: RegExp - - type: array - description: The updated at's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The updated at's $ne. - - type: object - description: The updated at's $ne. - x-schemaName: RegExp - $in: - type: array - description: The updated at's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The updated at's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The updated at's $not. - - type: object - description: The updated at's $not. - x-schemaName: RegExp - - type: object - description: The updated at's $not. - - type: array - description: The updated at's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The updated at's $gt. - - type: object - description: The updated at's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The updated at's $gte. - - type: object - description: The updated at's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The updated at's $lt. - - type: object - description: The updated at's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The updated at's $lte. - - type: object - description: The updated at's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The updated at's $like. - $re: - type: string - title: $re - description: The updated at's $re. - $ilike: - type: string - title: $ilike - description: The updated at's $ilike. - $fulltext: - type: string - title: $fulltext - description: The updated at's $fulltext. - $overlap: - type: array - description: The updated at's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The updated at's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The updated at's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The updated at's $exists. - deleted_at: - type: object - description: The $and's deleted at. - properties: - $and: - type: array - description: The deleted at's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The deleted at's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The deleted at's $eq. - - type: object - description: The deleted at's $eq. - x-schemaName: RegExp - - type: array - description: The deleted at's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The deleted at's $ne. - - type: object - description: The deleted at's $ne. - x-schemaName: RegExp - $in: - type: array - description: The deleted at's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The deleted at's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The deleted at's $not. - - type: object - description: The deleted at's $not. - x-schemaName: RegExp - - type: object - description: The deleted at's $not. - - type: array - description: The deleted at's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The deleted at's $gt. - - type: object - description: The deleted at's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The deleted at's $gte. - - type: object - description: The deleted at's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The deleted at's $lt. - - type: object - description: The deleted at's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The deleted at's $lte. - - type: object - description: The deleted at's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The deleted at's $like. - $re: - type: string - title: $re - description: The deleted at's $re. - $ilike: - type: string - title: $ilike - description: The deleted at's $ilike. - $fulltext: - type: string - title: $fulltext - description: The deleted at's $fulltext. - $overlap: - type: array - description: The deleted at's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The deleted at's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The deleted at's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The deleted at's $exists. - limit: - type: number - title: limit - description: The $and's limit. - offset: - type: number - title: offset - description: The $and's offset. - order: - type: string - title: order - description: The $and's order. - fields: - type: string - title: fields - description: The $and's fields. - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - properties: - q: - type: string - title: q - description: The $and's q. - status: - oneOf: - - type: string - title: status - description: The $and's status. - - type: string - title: status - description: The $and's status. - - type: string - title: status - description: The $and's status. - - type: string - title: status - description: The $and's status. - - type: array - description: The $and's status. - items: - type: string - enum: - - draft - - proposed - - published - - rejected - sales_channel_id: - oneOf: - - type: string - title: sales_channel_id - description: The $and's sales channel id. - - type: array - description: The $and's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - title: - oneOf: - - type: string - title: title - description: The $and's title. - - type: array - description: The $and's title. - items: - type: string - title: title - description: The title's details. - handle: - oneOf: - - type: string - title: handle - description: The $and's handle. - - type: array - description: The $and's handle. - items: - type: string - title: handle - description: The handle's details. - id: - oneOf: - - type: string - title: id - description: The $and's ID. - - type: array - description: The $and's ID. - items: - type: string - title: id - description: The id's ID. - is_giftcard: - type: boolean - title: is_giftcard - description: The $and's is giftcard. - tags: - type: object - description: The $and's tags. - type_id: - oneOf: - - type: string - title: type_id - description: The $and's type id. - - type: array - description: The $and's type id. - items: - type: string - title: type_id - description: The type id's details. - category_id: - oneOf: - - type: string - title: category_id - description: The $and's category id. - - type: array - description: The $and's category id. - items: - type: string - title: category_id - description: The category id's details. - - type: object - description: The $and's category id. - categories: - oneOf: - - type: object - description: The $and's categories. - - type: object - description: The $and's categories. - collection_id: - oneOf: - - type: string - title: collection_id - description: The $and's collection id. - - type: array - description: The $and's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - - type: object - description: The $and's collection id. - created_at: - type: object - description: The $and's created at. - updated_at: - type: object - description: The $and's updated at. - deleted_at: - type: object - description: The $and's deleted at. - limit: - type: number - title: limit - description: The $and's limit. - offset: - type: number - title: offset - description: The $and's offset. - order: - type: string - title: order - description: The $and's order. - fields: - type: string - title: fields - description: The $and's fields. - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - - type: object - description: The $or's details. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - - type: object - description: The $or's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - properties: - q: - type: string - title: q - description: The $or's q. - status: - oneOf: - - type: string - title: status - description: The $or's status. - - type: string - title: status - description: The $or's status. - - type: string - title: status - description: The $or's status. - - type: string - title: status - description: The $or's status. - - type: array - description: The $or's status. - items: - type: string - enum: - - draft - - proposed - - published - - rejected - sales_channel_id: - oneOf: - - type: string - title: sales_channel_id - description: The $or's sales channel id. - - type: array - description: The $or's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - title: - oneOf: - - type: string - title: title - description: The $or's title. - - type: array - description: The $or's title. - items: - type: string - title: title - description: The title's details. - handle: - oneOf: - - type: string - title: handle - description: The $or's handle. - - type: array - description: The $or's handle. - items: - type: string - title: handle - description: The handle's details. - id: - oneOf: - - type: string - title: id - description: The $or's ID. - - type: array - description: The $or's ID. - items: - type: string - title: id - description: The id's ID. - is_giftcard: - type: boolean - title: is_giftcard - description: The $or's is giftcard. - tags: - type: object - description: The $or's tags. - type_id: - oneOf: - - type: string - title: type_id - description: The $or's type id. - - type: array - description: The $or's type id. - items: - type: string - title: type_id - description: The type id's details. - category_id: - oneOf: - - type: string - title: category_id - description: The $or's category id. - - type: array - description: The $or's category id. - items: - type: string - title: category_id - description: The category id's details. - - type: object - description: The $or's category id. - categories: - oneOf: - - type: object - description: The $or's categories. - - type: object - description: The $or's categories. - collection_id: - oneOf: - - type: string - title: collection_id - description: The $or's collection id. - - type: array - description: The $or's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - - type: object - description: The $or's collection id. - created_at: - type: object - description: The $or's created at. - updated_at: - type: object - description: The $or's updated at. - deleted_at: - type: object - description: The $or's deleted at. - limit: - type: number - title: limit - description: The $or's limit. - offset: - type: number - title: offset - description: The $or's offset. - order: - type: string - title: order - description: The $or's order. - fields: - type: string - title: fields - description: The $or's fields. - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - - type: object - description: The $or's details. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - - type: object - description: The $or's details. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - properties: - q: - type: string - title: q - description: The $and's q. - status: - oneOf: - - type: string - title: status - description: The $and's status. - - type: string - title: status - description: The $and's status. - - type: string - title: status - description: The $and's status. - - type: string - title: status - description: The $and's status. - - type: array - description: The $and's status. - items: - type: string - enum: - - draft - - proposed - - published - - rejected - sales_channel_id: - oneOf: - - type: string - title: sales_channel_id - description: The $and's sales channel id. - - type: array - description: The $and's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - title: - oneOf: - - type: string - title: title - description: The $and's title. - - type: array - description: The $and's title. - items: - type: string - title: title - description: The title's details. - handle: - oneOf: - - type: string - title: handle - description: The $and's handle. - - type: array - description: The $and's handle. - items: - type: string - title: handle - description: The handle's details. - id: - oneOf: - - type: string - title: id - description: The $and's ID. - - type: array - description: The $and's ID. - items: - type: string - title: id - description: The id's ID. - is_giftcard: - type: boolean - title: is_giftcard - description: The $and's is giftcard. - tags: - type: object - description: The $and's tags. - type_id: - oneOf: - - type: string - title: type_id - description: The $and's type id. - - type: array - description: The $and's type id. - items: - type: string - title: type_id - description: The type id's details. - category_id: - oneOf: - - type: string - title: category_id - description: The $and's category id. - - type: array - description: The $and's category id. - items: - type: string - title: category_id - description: The category id's details. - - type: object - description: The $and's category id. - categories: - oneOf: - - type: object - description: The $and's categories. - - type: object - description: The $and's categories. - collection_id: - oneOf: - - type: string - title: collection_id - description: The $and's collection id. - - type: array - description: The $and's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - - type: object - description: The $and's collection id. - created_at: - type: object - description: The $and's created at. - updated_at: - type: object - description: The $and's updated at. - deleted_at: - type: object - description: The $and's deleted at. - limit: - type: number - title: limit - description: The $and's limit. - offset: - type: number - title: offset - description: The $and's offset. - order: - type: string - title: order - description: The $and's order. - fields: - type: string - title: fields - description: The $and's fields. - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - - type: object - description: The $or's details. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - - type: object - description: The $or's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - properties: - q: - type: string - title: q - description: The $or's q. - status: - oneOf: - - type: string - title: status - description: The $or's status. - - type: string - title: status - description: The $or's status. - - type: string - title: status - description: The $or's status. - - type: string - title: status - description: The $or's status. - - type: array - description: The $or's status. - items: - type: string - enum: - - draft - - proposed - - published - - rejected - sales_channel_id: - oneOf: - - type: string - title: sales_channel_id - description: The $or's sales channel id. - - type: array - description: The $or's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - title: - oneOf: - - type: string - title: title - description: The $or's title. - - type: array - description: The $or's title. - items: - type: string - title: title - description: The title's details. - handle: - oneOf: - - type: string - title: handle - description: The $or's handle. - - type: array - description: The $or's handle. - items: - type: string - title: handle - description: The handle's details. - id: - oneOf: - - type: string - title: id - description: The $or's ID. - - type: array - description: The $or's ID. - items: - type: string - title: id - description: The id's ID. - is_giftcard: - type: boolean - title: is_giftcard - description: The $or's is giftcard. - tags: - type: object - description: The $or's tags. - type_id: - oneOf: - - type: string - title: type_id - description: The $or's type id. - - type: array - description: The $or's type id. - items: - type: string - title: type_id - description: The type id's details. - category_id: - oneOf: - - type: string - title: category_id - description: The $or's category id. - - type: array - description: The $or's category id. - items: - type: string - title: category_id - description: The category id's details. - - type: object - description: The $or's category id. - categories: - oneOf: - - type: object - description: The $or's categories. - - type: object - description: The $or's categories. - collection_id: - oneOf: - - type: string - title: collection_id - description: The $or's collection id. - - type: array - description: The $or's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - - type: object - description: The $or's collection id. - created_at: - type: object - description: The $or's created at. - updated_at: - type: object - description: The $or's updated at. - deleted_at: - type: object - description: The $or's deleted at. - limit: - type: number - title: limit - description: The $or's limit. - offset: - type: number - title: offset - description: The $or's offset. - order: - type: string - title: order - description: The $or's order. - fields: - type: string - title: fields - description: The $or's fields. - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - - type: object - description: The $or's details. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - - type: object - description: The $or's details. type: array items: type: object + title: $and - name: $or in: query description: The product's $or. @@ -12073,1915 +10168,10 @@ get: type: array description: The product's $or. items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - properties: - q: - type: string - title: q - description: The $or's q. - status: - oneOf: - - type: string - title: status - description: The $or's status. - - type: string - title: status - description: The $or's status. - - type: string - title: status - description: The $or's status. - - type: string - title: status - description: The $or's status. - - type: array - description: The $or's status. - items: - type: string - enum: - - draft - - proposed - - published - - rejected - sales_channel_id: - oneOf: - - type: string - title: sales_channel_id - description: The $or's sales channel id. - - type: array - description: The $or's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - title: - oneOf: - - type: string - title: title - description: The $or's title. - - type: array - description: The $or's title. - items: - type: string - title: title - description: The title's details. - handle: - oneOf: - - type: string - title: handle - description: The $or's handle. - - type: array - description: The $or's handle. - items: - type: string - title: handle - description: The handle's details. - id: - oneOf: - - type: string - title: id - description: The $or's ID. - - type: array - description: The $or's ID. - items: - type: string - title: id - description: The id's ID. - is_giftcard: - type: boolean - title: is_giftcard - description: The $or's is giftcard. - tags: - type: object - description: The $or's tags. - properties: - value: - type: array - description: The tag's value. - items: - type: string - title: value - description: The value's details. - type_id: - oneOf: - - type: string - title: type_id - description: The $or's type id. - - type: array - description: The $or's type id. - items: - type: string - title: type_id - description: The type id's details. - category_id: - oneOf: - - type: string - title: category_id - description: The $or's category id. - - type: array - description: The $or's category id. - items: - type: string - title: category_id - description: The category id's details. - - type: object - description: The $or's category id. - properties: - $and: - type: array - description: The category id's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The category id's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The category id's $eq. - - type: object - description: The category id's $eq. - x-schemaName: RegExp - - type: array - description: The category id's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The category id's $ne. - - type: object - description: The category id's $ne. - x-schemaName: RegExp - $in: - type: array - description: The category id's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The category id's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The category id's $not. - - type: object - description: The category id's $not. - x-schemaName: RegExp - - type: object - description: The category id's $not. - - type: array - description: The category id's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The category id's $gt. - - type: object - description: The category id's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The category id's $gte. - - type: object - description: The category id's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The category id's $lt. - - type: object - description: The category id's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The category id's $lte. - - type: object - description: The category id's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The category id's $like. - $re: - type: string - title: $re - description: The category id's $re. - $ilike: - type: string - title: $ilike - description: The category id's $ilike. - $fulltext: - type: string - title: $fulltext - description: The category id's $fulltext. - $overlap: - type: array - description: The category id's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The category id's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The category id's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The category id's $exists. - categories: - oneOf: - - type: object - description: The $or's categories. - required: - - id - properties: - id: - type: object - description: The category's ID. - - type: object - description: The $or's categories. - required: - - id - properties: - id: - type: object - description: The category's ID. - collection_id: - oneOf: - - type: string - title: collection_id - description: The $or's collection id. - - type: array - description: The $or's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - - type: object - description: The $or's collection id. - properties: - $and: - type: array - description: The collection id's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The collection id's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The collection id's $eq. - - type: object - description: The collection id's $eq. - x-schemaName: RegExp - - type: array - description: The collection id's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The collection id's $ne. - - type: object - description: The collection id's $ne. - x-schemaName: RegExp - $in: - type: array - description: The collection id's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The collection id's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The collection id's $not. - - type: object - description: The collection id's $not. - x-schemaName: RegExp - - type: object - description: The collection id's $not. - - type: array - description: The collection id's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The collection id's $gt. - - type: object - description: The collection id's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The collection id's $gte. - - type: object - description: The collection id's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The collection id's $lt. - - type: object - description: The collection id's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The collection id's $lte. - - type: object - description: The collection id's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The collection id's $like. - $re: - type: string - title: $re - description: The collection id's $re. - $ilike: - type: string - title: $ilike - description: The collection id's $ilike. - $fulltext: - type: string - title: $fulltext - description: The collection id's $fulltext. - $overlap: - type: array - description: The collection id's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The collection id's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The collection id's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The collection id's $exists. - created_at: - type: object - description: The $or's created at. - properties: - $and: - type: array - description: The created at's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The created at's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The created at's $eq. - - type: object - description: The created at's $eq. - x-schemaName: RegExp - - type: array - description: The created at's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The created at's $ne. - - type: object - description: The created at's $ne. - x-schemaName: RegExp - $in: - type: array - description: The created at's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The created at's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The created at's $not. - - type: object - description: The created at's $not. - x-schemaName: RegExp - - type: object - description: The created at's $not. - - type: array - description: The created at's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The created at's $gt. - - type: object - description: The created at's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The created at's $gte. - - type: object - description: The created at's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The created at's $lt. - - type: object - description: The created at's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The created at's $lte. - - type: object - description: The created at's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The created at's $like. - $re: - type: string - title: $re - description: The created at's $re. - $ilike: - type: string - title: $ilike - description: The created at's $ilike. - $fulltext: - type: string - title: $fulltext - description: The created at's $fulltext. - $overlap: - type: array - description: The created at's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The created at's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The created at's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The created at's $exists. - updated_at: - type: object - description: The $or's updated at. - properties: - $and: - type: array - description: The updated at's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The updated at's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The updated at's $eq. - - type: object - description: The updated at's $eq. - x-schemaName: RegExp - - type: array - description: The updated at's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The updated at's $ne. - - type: object - description: The updated at's $ne. - x-schemaName: RegExp - $in: - type: array - description: The updated at's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The updated at's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The updated at's $not. - - type: object - description: The updated at's $not. - x-schemaName: RegExp - - type: object - description: The updated at's $not. - - type: array - description: The updated at's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The updated at's $gt. - - type: object - description: The updated at's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The updated at's $gte. - - type: object - description: The updated at's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The updated at's $lt. - - type: object - description: The updated at's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The updated at's $lte. - - type: object - description: The updated at's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The updated at's $like. - $re: - type: string - title: $re - description: The updated at's $re. - $ilike: - type: string - title: $ilike - description: The updated at's $ilike. - $fulltext: - type: string - title: $fulltext - description: The updated at's $fulltext. - $overlap: - type: array - description: The updated at's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The updated at's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The updated at's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The updated at's $exists. - deleted_at: - type: object - description: The $or's deleted at. - properties: - $and: - type: array - description: The deleted at's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The deleted at's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The deleted at's $eq. - - type: object - description: The deleted at's $eq. - x-schemaName: RegExp - - type: array - description: The deleted at's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The deleted at's $ne. - - type: object - description: The deleted at's $ne. - x-schemaName: RegExp - $in: - type: array - description: The deleted at's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The deleted at's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The deleted at's $not. - - type: object - description: The deleted at's $not. - x-schemaName: RegExp - - type: object - description: The deleted at's $not. - - type: array - description: The deleted at's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The deleted at's $gt. - - type: object - description: The deleted at's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The deleted at's $gte. - - type: object - description: The deleted at's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The deleted at's $lt. - - type: object - description: The deleted at's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The deleted at's $lte. - - type: object - description: The deleted at's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The deleted at's $like. - $re: - type: string - title: $re - description: The deleted at's $re. - $ilike: - type: string - title: $ilike - description: The deleted at's $ilike. - $fulltext: - type: string - title: $fulltext - description: The deleted at's $fulltext. - $overlap: - type: array - description: The deleted at's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The deleted at's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The deleted at's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The deleted at's $exists. - limit: - type: number - title: limit - description: The $or's limit. - offset: - type: number - title: offset - description: The $or's offset. - order: - type: string - title: order - description: The $or's order. - fields: - type: string - title: fields - description: The $or's fields. - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - properties: - q: - type: string - title: q - description: The $and's q. - status: - oneOf: - - type: string - title: status - description: The $and's status. - - type: string - title: status - description: The $and's status. - - type: string - title: status - description: The $and's status. - - type: string - title: status - description: The $and's status. - - type: array - description: The $and's status. - items: - type: string - enum: - - draft - - proposed - - published - - rejected - sales_channel_id: - oneOf: - - type: string - title: sales_channel_id - description: The $and's sales channel id. - - type: array - description: The $and's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - title: - oneOf: - - type: string - title: title - description: The $and's title. - - type: array - description: The $and's title. - items: - type: string - title: title - description: The title's details. - handle: - oneOf: - - type: string - title: handle - description: The $and's handle. - - type: array - description: The $and's handle. - items: - type: string - title: handle - description: The handle's details. - id: - oneOf: - - type: string - title: id - description: The $and's ID. - - type: array - description: The $and's ID. - items: - type: string - title: id - description: The id's ID. - is_giftcard: - type: boolean - title: is_giftcard - description: The $and's is giftcard. - tags: - type: object - description: The $and's tags. - type_id: - oneOf: - - type: string - title: type_id - description: The $and's type id. - - type: array - description: The $and's type id. - items: - type: string - title: type_id - description: The type id's details. - category_id: - oneOf: - - type: string - title: category_id - description: The $and's category id. - - type: array - description: The $and's category id. - items: - type: string - title: category_id - description: The category id's details. - - type: object - description: The $and's category id. - categories: - oneOf: - - type: object - description: The $and's categories. - - type: object - description: The $and's categories. - collection_id: - oneOf: - - type: string - title: collection_id - description: The $and's collection id. - - type: array - description: The $and's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - - type: object - description: The $and's collection id. - created_at: - type: object - description: The $and's created at. - updated_at: - type: object - description: The $and's updated at. - deleted_at: - type: object - description: The $and's deleted at. - limit: - type: number - title: limit - description: The $and's limit. - offset: - type: number - title: offset - description: The $and's offset. - order: - type: string - title: order - description: The $and's order. - fields: - type: string - title: fields - description: The $and's fields. - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - - type: object - description: The $or's details. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - - type: object - description: The $or's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - properties: - q: - type: string - title: q - description: The $or's q. - status: - oneOf: - - type: string - title: status - description: The $or's status. - - type: string - title: status - description: The $or's status. - - type: string - title: status - description: The $or's status. - - type: string - title: status - description: The $or's status. - - type: array - description: The $or's status. - items: - type: string - enum: - - draft - - proposed - - published - - rejected - sales_channel_id: - oneOf: - - type: string - title: sales_channel_id - description: The $or's sales channel id. - - type: array - description: The $or's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - title: - oneOf: - - type: string - title: title - description: The $or's title. - - type: array - description: The $or's title. - items: - type: string - title: title - description: The title's details. - handle: - oneOf: - - type: string - title: handle - description: The $or's handle. - - type: array - description: The $or's handle. - items: - type: string - title: handle - description: The handle's details. - id: - oneOf: - - type: string - title: id - description: The $or's ID. - - type: array - description: The $or's ID. - items: - type: string - title: id - description: The id's ID. - is_giftcard: - type: boolean - title: is_giftcard - description: The $or's is giftcard. - tags: - type: object - description: The $or's tags. - type_id: - oneOf: - - type: string - title: type_id - description: The $or's type id. - - type: array - description: The $or's type id. - items: - type: string - title: type_id - description: The type id's details. - category_id: - oneOf: - - type: string - title: category_id - description: The $or's category id. - - type: array - description: The $or's category id. - items: - type: string - title: category_id - description: The category id's details. - - type: object - description: The $or's category id. - categories: - oneOf: - - type: object - description: The $or's categories. - - type: object - description: The $or's categories. - collection_id: - oneOf: - - type: string - title: collection_id - description: The $or's collection id. - - type: array - description: The $or's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - - type: object - description: The $or's collection id. - created_at: - type: object - description: The $or's created at. - updated_at: - type: object - description: The $or's updated at. - deleted_at: - type: object - description: The $or's deleted at. - limit: - type: number - title: limit - description: The $or's limit. - offset: - type: number - title: offset - description: The $or's offset. - order: - type: string - title: order - description: The $or's order. - fields: - type: string - title: fields - description: The $or's fields. - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - - type: object - description: The $or's details. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - - type: object - description: The $or's details. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - properties: - q: - type: string - title: q - description: The $and's q. - status: - oneOf: - - type: string - title: status - description: The $and's status. - - type: string - title: status - description: The $and's status. - - type: string - title: status - description: The $and's status. - - type: string - title: status - description: The $and's status. - - type: array - description: The $and's status. - items: - type: string - enum: - - draft - - proposed - - published - - rejected - sales_channel_id: - oneOf: - - type: string - title: sales_channel_id - description: The $and's sales channel id. - - type: array - description: The $and's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - title: - oneOf: - - type: string - title: title - description: The $and's title. - - type: array - description: The $and's title. - items: - type: string - title: title - description: The title's details. - handle: - oneOf: - - type: string - title: handle - description: The $and's handle. - - type: array - description: The $and's handle. - items: - type: string - title: handle - description: The handle's details. - id: - oneOf: - - type: string - title: id - description: The $and's ID. - - type: array - description: The $and's ID. - items: - type: string - title: id - description: The id's ID. - is_giftcard: - type: boolean - title: is_giftcard - description: The $and's is giftcard. - tags: - type: object - description: The $and's tags. - type_id: - oneOf: - - type: string - title: type_id - description: The $and's type id. - - type: array - description: The $and's type id. - items: - type: string - title: type_id - description: The type id's details. - category_id: - oneOf: - - type: string - title: category_id - description: The $and's category id. - - type: array - description: The $and's category id. - items: - type: string - title: category_id - description: The category id's details. - - type: object - description: The $and's category id. - categories: - oneOf: - - type: object - description: The $and's categories. - - type: object - description: The $and's categories. - collection_id: - oneOf: - - type: string - title: collection_id - description: The $and's collection id. - - type: array - description: The $and's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - - type: object - description: The $and's collection id. - created_at: - type: object - description: The $and's created at. - updated_at: - type: object - description: The $and's updated at. - deleted_at: - type: object - description: The $and's deleted at. - limit: - type: number - title: limit - description: The $and's limit. - offset: - type: number - title: offset - description: The $and's offset. - order: - type: string - title: order - description: The $and's order. - fields: - type: string - title: fields - description: The $and's fields. - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - - type: object - description: The $or's details. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - - type: object - description: The $or's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - properties: - q: - type: string - title: q - description: The $or's q. - status: - oneOf: - - type: string - title: status - description: The $or's status. - - type: string - title: status - description: The $or's status. - - type: string - title: status - description: The $or's status. - - type: string - title: status - description: The $or's status. - - type: array - description: The $or's status. - items: - type: string - enum: - - draft - - proposed - - published - - rejected - sales_channel_id: - oneOf: - - type: string - title: sales_channel_id - description: The $or's sales channel id. - - type: array - description: The $or's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - title: - oneOf: - - type: string - title: title - description: The $or's title. - - type: array - description: The $or's title. - items: - type: string - title: title - description: The title's details. - handle: - oneOf: - - type: string - title: handle - description: The $or's handle. - - type: array - description: The $or's handle. - items: - type: string - title: handle - description: The handle's details. - id: - oneOf: - - type: string - title: id - description: The $or's ID. - - type: array - description: The $or's ID. - items: - type: string - title: id - description: The id's ID. - is_giftcard: - type: boolean - title: is_giftcard - description: The $or's is giftcard. - tags: - type: object - description: The $or's tags. - type_id: - oneOf: - - type: string - title: type_id - description: The $or's type id. - - type: array - description: The $or's type id. - items: - type: string - title: type_id - description: The type id's details. - category_id: - oneOf: - - type: string - title: category_id - description: The $or's category id. - - type: array - description: The $or's category id. - items: - type: string - title: category_id - description: The category id's details. - - type: object - description: The $or's category id. - categories: - oneOf: - - type: object - description: The $or's categories. - - type: object - description: The $or's categories. - collection_id: - oneOf: - - type: string - title: collection_id - description: The $or's collection id. - - type: array - description: The $or's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - - type: object - description: The $or's collection id. - created_at: - type: object - description: The $or's created at. - updated_at: - type: object - description: The $or's updated at. - deleted_at: - type: object - description: The $or's deleted at. - limit: - type: number - title: limit - description: The $or's limit. - offset: - type: number - title: offset - description: The $or's offset. - order: - type: string - title: order - description: The $or's order. - fields: - type: string - title: fields - description: The $or's fields. - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - - type: object - description: The $or's details. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductListParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductListParams - - type: object - description: The $or's details. type: array items: type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -14110,148 +10300,18 @@ post: content: application/json: schema: + allOf: + - $ref: ../components/schemas/AdminCreateProduct.yaml + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: >- + Pass additional custom data to the API route. This data is + passed to the underlying workflow under the + `additional_data` parameter. description: SUMMARY - properties: - title: - type: string - title: title - description: The product's title. - subtitle: - type: string - title: subtitle - description: The product's subtitle. - description: - type: string - title: description - description: The product's description. - is_giftcard: - type: boolean - title: is_giftcard - description: The product's is giftcard. - discountable: - type: boolean - title: discountable - description: The product's discountable. - images: - type: array - description: The product's images. - items: - type: object - description: The image's images. - required: - - url - properties: - url: - type: string - title: url - description: The image's url. - thumbnail: - type: string - title: thumbnail - description: The product's thumbnail. - handle: - type: string - title: handle - description: The product's handle. - status: - type: string - enum: - - draft - - proposed - - published - - rejected - type_id: - type: string - title: type_id - description: The product's type id. - collection_id: - type: string - title: collection_id - description: The product's collection id. - categories: - type: array - description: The product's categories. - items: - type: object - description: The category's categories. - required: - - id - properties: - id: - type: string - title: id - description: The category's ID. - tags: - type: array - description: The product's tags. - items: - type: object - description: The tag's tags. - required: - - id - properties: - id: - type: string - title: id - description: The tag's ID. - options: - type: array - description: The product's options. - items: - $ref: ../components/schemas/AdminCreateProductOption.yaml - variants: - type: array - description: The product's variants. - items: - $ref: ../components/schemas/AdminCreateProductVariant.yaml - sales_channels: - type: array - description: The product's sales channels. - items: - type: object - description: The sales channel's sales channels. - required: - - id - properties: - id: - type: string - title: id - description: The sales channel's ID. - weight: - type: number - title: weight - description: The product's weight. - length: - type: number - title: length - description: The product's length. - height: - type: number - title: height - description: The product's height. - width: - type: number - title: width - description: The product's width. - hs_code: - type: string - title: hs_code - description: The product's hs code. - mid_code: - type: string - title: mid_code - description: The product's mid code. - origin_country: - type: string - title: origin_country - description: The product's origin country. - material: - type: string - title: material - description: The product's material. - metadata: - type: object - description: The product's metadata. x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}.yaml index f4a6ec449e..952048838a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}.yaml @@ -172,150 +172,18 @@ post: content: application/json: schema: + allOf: + - $ref: ../components/schemas/AdminUpdateProduct.yaml + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: >- + Pass additional custom data to the API route. This data is + passed to the underlying workflow under the + `additional_data` parameter. description: SUMMARY - properties: - title: - type: string - title: title - description: The product's title. - subtitle: - type: string - title: subtitle - description: The product's subtitle. - description: - type: string - title: description - description: The product's description. - is_giftcard: - type: boolean - title: is_giftcard - description: The product's is giftcard. - discountable: - type: boolean - title: discountable - description: The product's discountable. - images: - type: array - description: The product's images. - items: - type: object - description: The image's images. - required: - - url - properties: - url: - type: string - title: url - description: The image's url. - thumbnail: - type: string - title: thumbnail - description: The product's thumbnail. - handle: - type: string - title: handle - description: The product's handle. - status: - type: string - enum: - - draft - - proposed - - published - - rejected - type_id: - type: string - title: type_id - description: The product's type id. - collection_id: - type: string - title: collection_id - description: The product's collection id. - categories: - type: array - description: The product's categories. - items: - type: object - description: The category's categories. - required: - - id - properties: - id: - type: string - title: id - description: The category's ID. - tags: - type: array - description: The product's tags. - items: - type: object - description: The tag's tags. - required: - - id - properties: - id: - type: string - title: id - description: The tag's ID. - options: - type: array - description: The product's options. - items: - $ref: ../components/schemas/AdminUpdateProductOption.yaml - variants: - type: array - description: The product's variants. - items: - oneOf: - - $ref: ../components/schemas/AdminCreateProductVariant.yaml - - $ref: ../components/schemas/AdminUpdateProductVariant.yaml - sales_channels: - type: array - description: The product's sales channels. - items: - type: object - description: The sales channel's sales channels. - required: - - id - properties: - id: - type: string - title: id - description: The sales channel's ID. - weight: - type: number - title: weight - description: The product's weight. - length: - type: number - title: length - description: The product's length. - height: - type: number - title: height - description: The product's height. - width: - type: number - title: width - description: The product's width. - hs_code: - type: string - title: hs_code - description: The product's hs code. - mid_code: - type: string - title: mid_code - description: The product's mid code. - origin_country: - type: string - title: origin_country - description: The product's origin country. - material: - type: string - title: material - description: The product's material. - metadata: - type: object - description: The product's metadata. x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options.yaml index c7c3b55e9b..f04c2439ae 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options.yaml @@ -125,490 +125,10 @@ get: type: array description: The product's $and. items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - properties: - q: - type: string - title: q - description: The $and's q. - id: - oneOf: - - type: string - title: id - description: The $and's ID. - - type: array - description: The $and's ID. - items: - type: string - title: id - description: The id's ID. - title: - oneOf: - - type: string - title: title - description: The $and's title. - - type: array - description: The $and's title. - items: - type: string - title: title - description: The title's details. - product_id: - oneOf: - - type: string - title: product_id - description: The $and's product id. - - type: array - description: The $and's product id. - items: - type: string - title: product_id - description: The product id's details. - limit: - type: number - title: limit - description: The $and's limit. - offset: - type: number - title: offset - description: The $and's offset. - order: - type: string - title: order - description: The $and's order. - fields: - type: string - title: fields - description: The $and's fields. - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - properties: - q: - type: string - title: q - description: The $and's q. - id: - oneOf: - - type: string - title: id - description: The $and's ID. - - type: array - description: The $and's ID. - items: - type: string - title: id - description: The id's ID. - title: - oneOf: - - type: string - title: title - description: The $and's title. - - type: array - description: The $and's title. - items: - type: string - title: title - description: The title's details. - product_id: - oneOf: - - type: string - title: product_id - description: The $and's product id. - - type: array - description: The $and's product id. - items: - type: string - title: product_id - description: The product id's details. - limit: - type: number - title: limit - description: The $and's limit. - offset: - type: number - title: offset - description: The $and's offset. - order: - type: string - title: order - description: The $and's order. - fields: - type: string - title: fields - description: The $and's fields. - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $or's details. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $or's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - properties: - q: - type: string - title: q - description: The $or's q. - id: - oneOf: - - type: string - title: id - description: The $or's ID. - - type: array - description: The $or's ID. - items: - type: string - title: id - description: The id's ID. - title: - oneOf: - - type: string - title: title - description: The $or's title. - - type: array - description: The $or's title. - items: - type: string - title: title - description: The title's details. - product_id: - oneOf: - - type: string - title: product_id - description: The $or's product id. - - type: array - description: The $or's product id. - items: - type: string - title: product_id - description: The product id's details. - limit: - type: number - title: limit - description: The $or's limit. - offset: - type: number - title: offset - description: The $or's offset. - order: - type: string - title: order - description: The $or's order. - fields: - type: string - title: fields - description: The $or's fields. - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $or's details. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $or's details. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - properties: - q: - type: string - title: q - description: The $and's q. - id: - oneOf: - - type: string - title: id - description: The $and's ID. - - type: array - description: The $and's ID. - items: - type: string - title: id - description: The id's ID. - title: - oneOf: - - type: string - title: title - description: The $and's title. - - type: array - description: The $and's title. - items: - type: string - title: title - description: The title's details. - product_id: - oneOf: - - type: string - title: product_id - description: The $and's product id. - - type: array - description: The $and's product id. - items: - type: string - title: product_id - description: The product id's details. - limit: - type: number - title: limit - description: The $and's limit. - offset: - type: number - title: offset - description: The $and's offset. - order: - type: string - title: order - description: The $and's order. - fields: - type: string - title: fields - description: The $and's fields. - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $or's details. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $or's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - properties: - q: - type: string - title: q - description: The $or's q. - id: - oneOf: - - type: string - title: id - description: The $or's ID. - - type: array - description: The $or's ID. - items: - type: string - title: id - description: The id's ID. - title: - oneOf: - - type: string - title: title - description: The $or's title. - - type: array - description: The $or's title. - items: - type: string - title: title - description: The title's details. - product_id: - oneOf: - - type: string - title: product_id - description: The $or's product id. - - type: array - description: The $or's product id. - items: - type: string - title: product_id - description: The product id's details. - limit: - type: number - title: limit - description: The $or's limit. - offset: - type: number - title: offset - description: The $or's offset. - order: - type: string - title: order - description: The $or's order. - fields: - type: string - title: fields - description: The $or's fields. - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $or's details. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $or's details. type: array items: type: object + title: $and - name: $or in: query description: The product's $or. @@ -617,490 +137,10 @@ get: type: array description: The product's $or. items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - properties: - q: - type: string - title: q - description: The $or's q. - id: - oneOf: - - type: string - title: id - description: The $or's ID. - - type: array - description: The $or's ID. - items: - type: string - title: id - description: The id's ID. - title: - oneOf: - - type: string - title: title - description: The $or's title. - - type: array - description: The $or's title. - items: - type: string - title: title - description: The title's details. - product_id: - oneOf: - - type: string - title: product_id - description: The $or's product id. - - type: array - description: The $or's product id. - items: - type: string - title: product_id - description: The product id's details. - limit: - type: number - title: limit - description: The $or's limit. - offset: - type: number - title: offset - description: The $or's offset. - order: - type: string - title: order - description: The $or's order. - fields: - type: string - title: fields - description: The $or's fields. - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - properties: - q: - type: string - title: q - description: The $and's q. - id: - oneOf: - - type: string - title: id - description: The $and's ID. - - type: array - description: The $and's ID. - items: - type: string - title: id - description: The id's ID. - title: - oneOf: - - type: string - title: title - description: The $and's title. - - type: array - description: The $and's title. - items: - type: string - title: title - description: The title's details. - product_id: - oneOf: - - type: string - title: product_id - description: The $and's product id. - - type: array - description: The $and's product id. - items: - type: string - title: product_id - description: The product id's details. - limit: - type: number - title: limit - description: The $and's limit. - offset: - type: number - title: offset - description: The $and's offset. - order: - type: string - title: order - description: The $and's order. - fields: - type: string - title: fields - description: The $and's fields. - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $or's details. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $or's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - properties: - q: - type: string - title: q - description: The $or's q. - id: - oneOf: - - type: string - title: id - description: The $or's ID. - - type: array - description: The $or's ID. - items: - type: string - title: id - description: The id's ID. - title: - oneOf: - - type: string - title: title - description: The $or's title. - - type: array - description: The $or's title. - items: - type: string - title: title - description: The title's details. - product_id: - oneOf: - - type: string - title: product_id - description: The $or's product id. - - type: array - description: The $or's product id. - items: - type: string - title: product_id - description: The product id's details. - limit: - type: number - title: limit - description: The $or's limit. - offset: - type: number - title: offset - description: The $or's offset. - order: - type: string - title: order - description: The $or's order. - fields: - type: string - title: fields - description: The $or's fields. - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $or's details. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $or's details. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - properties: - q: - type: string - title: q - description: The $and's q. - id: - oneOf: - - type: string - title: id - description: The $and's ID. - - type: array - description: The $and's ID. - items: - type: string - title: id - description: The id's ID. - title: - oneOf: - - type: string - title: title - description: The $and's title. - - type: array - description: The $and's title. - items: - type: string - title: title - description: The title's details. - product_id: - oneOf: - - type: string - title: product_id - description: The $and's product id. - - type: array - description: The $and's product id. - items: - type: string - title: product_id - description: The product id's details. - limit: - type: number - title: limit - description: The $and's limit. - offset: - type: number - title: offset - description: The $and's offset. - order: - type: string - title: order - description: The $and's order. - fields: - type: string - title: fields - description: The $and's fields. - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $or's details. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $or's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - properties: - q: - type: string - title: q - description: The $or's q. - id: - oneOf: - - type: string - title: id - description: The $or's ID. - - type: array - description: The $or's ID. - items: - type: string - title: id - description: The id's ID. - title: - oneOf: - - type: string - title: title - description: The $or's title. - - type: array - description: The $or's title. - items: - type: string - title: title - description: The title's details. - product_id: - oneOf: - - type: string - title: product_id - description: The $or's product id. - - type: array - description: The $or's product id. - items: - type: string - title: product_id - description: The product id's details. - limit: - type: number - title: limit - description: The $or's limit. - offset: - type: number - title: offset - description: The $or's offset. - order: - type: string - title: order - description: The $or's order. - fields: - type: string - title: fields - description: The $or's fields. - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $or's details. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductOptionParams - - type: object - description: The $or's details. type: array items: type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -1235,19 +275,18 @@ post: content: application/json: schema: + allOf: + - $ref: ../components/schemas/AdminCreateProductOption.yaml + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: >- + Pass additional custom data to the API route. This data is + passed to the underlying workflow under the + `additional_data` parameter. description: SUMMARY - properties: - title: - type: string - title: title - description: The product's title. - values: - type: array - description: The product's values. - items: - type: string - title: values - description: The value's values. x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options_{option_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options_{option_id}.yaml index 1a932887be..b7c256b32a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options_{option_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options_{option_id}.yaml @@ -184,19 +184,18 @@ post: content: application/json: schema: + allOf: + - $ref: ../components/schemas/AdminUpdateProductOption.yaml + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: >- + Pass additional custom data to the API route. This data is + passed to the underlying workflow under the + `additional_data` parameter. description: SUMMARY - properties: - title: - type: string - title: title - description: The product's title. - values: - type: array - description: The product's values. - items: - type: string - title: values - description: The value's values. x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml index d598bf43e5..6e1f8f0735 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml @@ -201,83 +201,18 @@ post: content: application/json: schema: + allOf: + - $ref: ../components/schemas/AdminCreateProductVariant.yaml + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: >- + Pass additional custom data to the API route. This data is + passed to the underlying workflow under the + `additional_data` parameter. description: SUMMARY - properties: - title: - type: string - title: title - description: The product's title. - sku: - type: string - title: sku - description: The product's sku. - ean: - type: string - title: ean - description: The product's ean. - upc: - type: string - title: upc - description: The product's upc. - barcode: - type: string - title: barcode - description: The product's barcode. - hs_code: - type: string - title: hs_code - description: The product's hs code. - mid_code: - type: string - title: mid_code - description: The product's mid code. - allow_backorder: - type: boolean - title: allow_backorder - description: The product's allow backorder. - manage_inventory: - type: boolean - title: manage_inventory - description: The product's manage inventory. - variant_rank: - type: number - title: variant_rank - description: The product's variant rank. - weight: - type: number - title: weight - description: The product's weight. - length: - type: number - title: length - description: The product's length. - height: - type: number - title: height - description: The product's height. - width: - type: number - title: width - description: The product's width. - origin_country: - type: string - title: origin_country - description: The product's origin country. - material: - type: string - title: material - description: The product's material. - metadata: - type: object - description: The product's metadata. - prices: - type: array - description: The product's prices. - items: - $ref: ../components/schemas/AdminCreateProductVariantPrice.yaml - options: - type: object - description: The product's options. x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}.yaml index e11f050abe..230c236c64 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}.yaml @@ -184,83 +184,18 @@ post: content: application/json: schema: + allOf: + - $ref: ../components/schemas/AdminUpdateProductVariant.yaml + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: >- + Pass additional custom data to the API route. This data is + passed to the underlying workflow under the + `additional_data` parameter. description: SUMMARY - properties: - title: - type: string - title: title - description: The product's title. - sku: - type: string - title: sku - description: The product's sku. - ean: - type: string - title: ean - description: The product's ean. - upc: - type: string - title: upc - description: The product's upc. - barcode: - type: string - title: barcode - description: The product's barcode. - hs_code: - type: string - title: hs_code - description: The product's hs code. - mid_code: - type: string - title: mid_code - description: The product's mid code. - allow_backorder: - type: boolean - title: allow_backorder - description: The product's allow backorder. - manage_inventory: - type: boolean - title: manage_inventory - description: The product's manage inventory. - variant_rank: - type: number - title: variant_rank - description: The product's variant rank. - weight: - type: number - title: weight - description: The product's weight. - length: - type: number - title: length - description: The product's length. - height: - type: number - title: height - description: The product's height. - width: - type: number - title: width - description: The product's width. - origin_country: - type: string - title: origin_country - description: The product's origin country. - material: - type: string - title: material - description: The product's material. - metadata: - type: object - description: The product's metadata. - prices: - type: array - description: The product's prices. - items: - $ref: ../components/schemas/AdminCreateProductVariantPrice.yaml - options: - type: object - description: The product's options. x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml index 7c6906ebf3..829064096b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml @@ -364,268 +364,285 @@ post: content: application/json: schema: - description: SUMMARY - properties: - code: - type: string - title: code - description: The promotion's code. - is_automatic: - type: boolean - title: is_automatic - description: The promotion's is automatic. - type: - type: string - enum: - - standard - - buyget - campaign_id: - type: string - title: campaign_id - description: The promotion's campaign id. - campaign: - type: object - description: The promotion's campaign. + allOf: + - type: object + description: SUMMARY required: - - name - - campaign_identifier - - description - - budget - - starts_at - - ends_at - properties: - name: - type: string - title: name - description: The campaign's name. - campaign_identifier: - type: string - title: campaign_identifier - description: The campaign's campaign identifier. - description: - type: string - title: description - description: The campaign's description. - budget: - type: object - description: The campaign's budget. - required: - - type - - limit - - currency_code - properties: - type: - type: string - enum: - - spend - - usage - limit: - type: number - title: limit - description: The budget's limit. - currency_code: - type: string - title: currency_code - description: The budget's currency code. - starts_at: - type: string - title: starts_at - description: The campaign's starts at. - format: date-time - ends_at: - type: string - title: ends_at - description: The campaign's ends at. - format: date-time - promotions: - type: array - description: The campaign's promotions. - items: - type: object - description: The promotion's promotions. - required: - - id - properties: - id: - type: string - title: id - description: The promotion's ID. - application_method: - type: object - description: The promotion's application method. - required: - - description - - value - - currency_code - - max_quantity + - code - type - - target_type - - apply_to_quantity - - buy_rules_min_quantity + - campaign_id + - application_method properties: - description: + code: type: string - title: description - description: The application method's description. - value: - type: number - title: value - description: The application method's value. - currency_code: - type: string - title: currency_code - description: The application method's currency code. - max_quantity: - type: number - title: max_quantity - description: The application method's max quantity. + title: code + description: The promotion's code. + is_automatic: + type: boolean + title: is_automatic + description: The promotion's is automatic. type: type: string enum: - - fixed - - percentage - target_type: + - standard + - buyget + campaign_id: type: string - enum: - - order - - shipping_methods - - items - allocation: - type: string - enum: - - each - - across - target_rules: - type: array - description: The application method's target rules. - items: - type: object - description: The target rule's target rules. - required: - - operator - - description - - attribute - - values - properties: - operator: - type: string - enum: - - gte - - lte - - gt - - lt - - eq - - ne - - in - description: - type: string - title: description - description: The target rule's description. - attribute: - type: string - title: attribute - description: The target rule's attribute. - values: - oneOf: - - type: string - title: values - description: The target rule's values. - - type: array - description: The target rule's values. - items: - type: string - title: values - description: The value's values. - buy_rules: - type: array - description: The application method's buy rules. - items: - type: object - description: The buy rule's buy rules. - required: - - operator - - description - - attribute - - values - properties: - operator: - type: string - enum: - - gte - - lte - - gt - - lt - - eq - - ne - - in - description: - type: string - title: description - description: The buy rule's description. - attribute: - type: string - title: attribute - description: The buy rule's attribute. - values: - oneOf: - - type: string - title: values - description: The buy rule's values. - - type: array - description: The buy rule's values. - items: - type: string - title: values - description: The value's values. - apply_to_quantity: - type: number - title: apply_to_quantity - description: The application method's apply to quantity. - buy_rules_min_quantity: - type: number - title: buy_rules_min_quantity - description: The application method's buy rules min quantity. - rules: - type: array - description: The promotion's rules. - items: - type: object - description: The rule's rules. - required: - - operator - - description - - attribute - - values - properties: - operator: - type: string - enum: - - gte - - lte - - gt - - lt - - eq - - ne - - in - description: - type: string - title: description - description: The rule's description. - attribute: - type: string - title: attribute - description: The rule's attribute. - values: - oneOf: - - type: string - title: values - description: The rule's values. - - type: array - description: The rule's values. - items: + title: campaign_id + description: The promotion's campaign id. + campaign: + type: object + description: The promotion's campaign. + required: + - name + - campaign_identifier + - description + - budget + - starts_at + - ends_at + properties: + name: + type: string + title: name + description: The campaign's name. + campaign_identifier: + type: string + title: campaign_identifier + description: The campaign's campaign identifier. + description: + type: string + title: description + description: The campaign's description. + budget: + type: object + description: The campaign's budget. + required: + - type + - limit + - currency_code + properties: + type: type: string - title: values - description: The value's values. + enum: + - spend + - usage + limit: + type: number + title: limit + description: The budget's limit. + currency_code: + type: string + title: currency_code + description: The budget's currency code. + starts_at: + type: string + title: starts_at + description: The campaign's starts at. + format: date-time + ends_at: + type: string + title: ends_at + description: The campaign's ends at. + format: date-time + promotions: + type: array + description: The campaign's promotions. + items: + type: object + description: The promotion's promotions. + required: + - id + properties: + id: + type: string + title: id + description: The promotion's ID. + application_method: + type: object + description: The promotion's application method. + required: + - description + - value + - currency_code + - max_quantity + - type + - target_type + - apply_to_quantity + - buy_rules_min_quantity + properties: + description: + type: string + title: description + description: The application method's description. + value: + type: number + title: value + description: The application method's value. + currency_code: + type: string + title: currency_code + description: The application method's currency code. + max_quantity: + type: number + title: max_quantity + description: The application method's max quantity. + type: + type: string + enum: + - fixed + - percentage + target_type: + type: string + enum: + - order + - shipping_methods + - items + allocation: + type: string + enum: + - each + - across + target_rules: + type: array + description: The application method's target rules. + items: + type: object + description: The target rule's target rules. + required: + - operator + - description + - attribute + - values + properties: + operator: + type: string + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The target rule's description. + attribute: + type: string + title: attribute + description: The target rule's attribute. + values: + oneOf: + - type: string + title: values + description: The target rule's values. + - type: array + description: The target rule's values. + items: + type: string + title: values + description: The value's values. + buy_rules: + type: array + description: The application method's buy rules. + items: + type: object + description: The buy rule's buy rules. + required: + - operator + - description + - attribute + - values + properties: + operator: + type: string + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The buy rule's description. + attribute: + type: string + title: attribute + description: The buy rule's attribute. + values: + oneOf: + - type: string + title: values + description: The buy rule's values. + - type: array + description: The buy rule's values. + items: + type: string + title: values + description: The value's values. + apply_to_quantity: + type: number + title: apply_to_quantity + description: The application method's apply to quantity. + buy_rules_min_quantity: + type: number + title: buy_rules_min_quantity + description: The application method's buy rules min quantity. + rules: + type: array + description: The promotion's rules. + items: + type: object + description: The rule's rules. + required: + - operator + - description + - attribute + - values + properties: + operator: + type: string + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The rule's description. + attribute: + type: string + title: attribute + description: The rule's attribute. + values: + oneOf: + - type: string + title: values + description: The rule's values. + - type: array + description: The rule's values. + items: + type: string + title: values + description: The value's values. + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: >- + Pass additional custom data to the API route. This data is + passed to the underlying workflow under the + `additional_data` parameter. + description: SUMMARY x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}.yaml index aa0b98aad0..08a9ba7f51 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}.yaml @@ -172,265 +172,279 @@ post: content: application/json: schema: - description: SUMMARY - properties: - code: - type: string - title: code - description: The promotion's code. - is_automatic: - type: boolean - title: is_automatic - description: The promotion's is automatic. - type: - type: string - enum: - - standard - - buyget - campaign_id: - type: string - title: campaign_id - description: The promotion's campaign id. - campaign: - type: object - description: The promotion's campaign. + allOf: + - type: object + description: SUMMARY required: - - name - - campaign_identifier - - description - - budget - - starts_at - - ends_at + - campaign_id properties: - name: + code: type: string - title: name - description: The campaign's name. - campaign_identifier: - type: string - title: campaign_identifier - description: The campaign's campaign identifier. - description: - type: string - title: description - description: The campaign's description. - budget: - type: object - description: The campaign's budget. - required: - - type - - limit - - currency_code - properties: - type: - type: string - enum: - - spend - - usage - limit: - type: number - title: limit - description: The budget's limit. - currency_code: - type: string - title: currency_code - description: The budget's currency code. - starts_at: - type: string - title: starts_at - description: The campaign's starts at. - format: date-time - ends_at: - type: string - title: ends_at - description: The campaign's ends at. - format: date-time - promotions: - type: array - description: The campaign's promotions. - items: - type: object - description: The promotion's promotions. - required: - - id - properties: - id: - type: string - title: id - description: The promotion's ID. - application_method: - type: object - description: The promotion's application method. - required: - - description - - max_quantity - - currency_code - - apply_to_quantity - - buy_rules_min_quantity - properties: - description: - type: string - title: description - description: The application method's description. - value: - type: number - title: value - description: The application method's value. - max_quantity: - type: number - title: max_quantity - description: The application method's max quantity. - currency_code: - type: string - title: currency_code - description: The application method's currency code. + title: code + description: The promotion's code. + is_automatic: + type: boolean + title: is_automatic + description: The promotion's is automatic. type: type: string enum: - - fixed - - percentage - target_type: + - standard + - buyget + campaign_id: type: string - enum: - - order - - shipping_methods - - items - allocation: - type: string - enum: - - each - - across - target_rules: - type: array - description: The application method's target rules. - items: - type: object - description: The target rule's target rules. - required: - - operator - - description - - attribute - - values - properties: - operator: - type: string - enum: - - gte - - lte - - gt - - lt - - eq - - ne - - in - description: - type: string - title: description - description: The target rule's description. - attribute: - type: string - title: attribute - description: The target rule's attribute. - values: - oneOf: - - type: string - title: values - description: The target rule's values. - - type: array - description: The target rule's values. - items: - type: string - title: values - description: The value's values. - buy_rules: - type: array - description: The application method's buy rules. - items: - type: object - description: The buy rule's buy rules. - required: - - operator - - description - - attribute - - values - properties: - operator: - type: string - enum: - - gte - - lte - - gt - - lt - - eq - - ne - - in - description: - type: string - title: description - description: The buy rule's description. - attribute: - type: string - title: attribute - description: The buy rule's attribute. - values: - oneOf: - - type: string - title: values - description: The buy rule's values. - - type: array - description: The buy rule's values. - items: - type: string - title: values - description: The value's values. - apply_to_quantity: - type: number - title: apply_to_quantity - description: The application method's apply to quantity. - buy_rules_min_quantity: - type: number - title: buy_rules_min_quantity - description: The application method's buy rules min quantity. - rules: - type: array - description: The promotion's rules. - items: - type: object - description: The rule's rules. - required: - - operator - - description - - attribute - - values - properties: - operator: - type: string - enum: - - gte - - lte - - gt - - lt - - eq - - ne - - in - description: - type: string - title: description - description: The rule's description. - attribute: - type: string - title: attribute - description: The rule's attribute. - values: - oneOf: - - type: string - title: values - description: The rule's values. - - type: array - description: The rule's values. - items: + title: campaign_id + description: The promotion's campaign id. + campaign: + type: object + description: The promotion's campaign. + required: + - name + - campaign_identifier + - description + - budget + - starts_at + - ends_at + properties: + name: + type: string + title: name + description: The campaign's name. + campaign_identifier: + type: string + title: campaign_identifier + description: The campaign's campaign identifier. + description: + type: string + title: description + description: The campaign's description. + budget: + type: object + description: The campaign's budget. + required: + - type + - limit + - currency_code + properties: + type: type: string - title: values - description: The value's values. + enum: + - spend + - usage + limit: + type: number + title: limit + description: The budget's limit. + currency_code: + type: string + title: currency_code + description: The budget's currency code. + starts_at: + type: string + title: starts_at + description: The campaign's starts at. + format: date-time + ends_at: + type: string + title: ends_at + description: The campaign's ends at. + format: date-time + promotions: + type: array + description: The campaign's promotions. + items: + type: object + description: The promotion's promotions. + required: + - id + properties: + id: + type: string + title: id + description: The promotion's ID. + application_method: + type: object + description: The promotion's application method. + required: + - description + - max_quantity + - currency_code + - apply_to_quantity + - buy_rules_min_quantity + properties: + description: + type: string + title: description + description: The application method's description. + value: + type: number + title: value + description: The application method's value. + max_quantity: + type: number + title: max_quantity + description: The application method's max quantity. + currency_code: + type: string + title: currency_code + description: The application method's currency code. + type: + type: string + enum: + - fixed + - percentage + target_type: + type: string + enum: + - order + - shipping_methods + - items + allocation: + type: string + enum: + - each + - across + target_rules: + type: array + description: The application method's target rules. + items: + type: object + description: The target rule's target rules. + required: + - operator + - description + - attribute + - values + properties: + operator: + type: string + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The target rule's description. + attribute: + type: string + title: attribute + description: The target rule's attribute. + values: + oneOf: + - type: string + title: values + description: The target rule's values. + - type: array + description: The target rule's values. + items: + type: string + title: values + description: The value's values. + buy_rules: + type: array + description: The application method's buy rules. + items: + type: object + description: The buy rule's buy rules. + required: + - operator + - description + - attribute + - values + properties: + operator: + type: string + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The buy rule's description. + attribute: + type: string + title: attribute + description: The buy rule's attribute. + values: + oneOf: + - type: string + title: values + description: The buy rule's values. + - type: array + description: The buy rule's values. + items: + type: string + title: values + description: The value's values. + apply_to_quantity: + type: number + title: apply_to_quantity + description: The application method's apply to quantity. + buy_rules_min_quantity: + type: number + title: buy_rules_min_quantity + description: The application method's buy rules min quantity. + rules: + type: array + description: The promotion's rules. + items: + type: object + description: The rule's rules. + required: + - operator + - description + - attribute + - values + properties: + operator: + type: string + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The rule's description. + attribute: + type: string + title: attribute + description: The rule's attribute. + values: + oneOf: + - type: string + title: values + description: The rule's values. + - type: array + description: The rule's values. + items: + type: string + title: values + description: The value's values. + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: >- + Pass additional custom data to the API route. This data is + passed to the underlying workflow under the + `additional_data` parameter. + description: SUMMARY x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_users.yaml b/www/apps/api-reference/specs/admin/paths/admin_users.yaml index 0b5ac7d82c..557254d105 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_users.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_users.yaml @@ -87,96 +87,3 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml -post: - operationId: PostUsers - summary: Create User - description: Create a user. - x-authenticated: false - parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. - requestBody: - content: - application/json: - schema: - $ref: ../components/schemas/CreateUser.yaml - x-codeSamples: - - lang: Shell - label: cURL - source: - $ref: ../code_samples/Shell/admin_users/post.sh - tags: - - Users - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: ../components/schemas/AdminUserResponse.yaml - '400': - $ref: ../components/responses/400_error.yaml - '401': - $ref: ../components/responses/unauthorized.yaml - '404': - $ref: ../components/responses/not_found_error.yaml - '409': - $ref: ../components/responses/invalid_state_error.yaml - '422': - $ref: ../components/responses/invalid_request_error.yaml - '500': - $ref: ../components/responses/500_error.yaml - x-workflow: createUserAccountWorkflow diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPaymentCollectionResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPaymentCollectionResponse.yaml new file mode 100644 index 0000000000..ccbf99b8f1 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPaymentCollectionResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminPaymentCollectionResponse +required: + - payment_collection +properties: + payment_collection: + $ref: ./AdminPaymentCollection.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/CreateCartWorkflowInput.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateCartWorkflowInput.yaml new file mode 100644 index 0000000000..369ef9b3a1 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/CreateCartWorkflowInput.yaml @@ -0,0 +1,60 @@ +type: object +description: SUMMARY +x-schemaName: CreateCartWorkflowInput +properties: + region_id: + type: string + title: region_id + description: The cart's region id. + customer_id: + type: string + title: customer_id + description: The cart's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The cart's sales channel id. + email: + type: string + title: email + description: The cart's email. + format: email + currency_code: + type: string + title: currency_code + description: The cart's currency code. + shipping_address_id: + type: string + title: shipping_address_id + description: The cart's shipping address id. + billing_address_id: + type: string + title: billing_address_id + description: The cart's billing address id. + shipping_address: + oneOf: + - type: string + title: shipping_address + description: The cart's shipping address. + - $ref: ./CreateCartAddress.yaml + billing_address: + oneOf: + - type: string + title: billing_address + description: The cart's billing address. + - $ref: ./CreateCartAddress.yaml + metadata: + type: object + description: The cart's metadata. + items: + type: array + description: The cart's items. + items: + $ref: ./CreateCartCreateLineItem.yaml + promo_codes: + type: array + description: The cart's promo codes. + items: + type: string + title: promo_codes + description: The promo code's promo codes. diff --git a/www/apps/api-reference/specs/store/components/schemas/CreateUser.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateUser.yaml deleted file mode 100644 index 3dfd4dcddb..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/CreateUser.yaml +++ /dev/null @@ -1,26 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: CreateUser -required: - - email -properties: - email: - type: string - title: email - description: The user's email. - format: email - first_name: - type: string - title: first_name - description: The user's first name. - last_name: - type: string - title: last_name - description: The user's last name. - avatar_url: - type: string - title: avatar_url - description: The user's avatar url. - metadata: - type: object - description: The user's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/UpdateCartData.yaml b/www/apps/api-reference/specs/store/components/schemas/UpdateCartData.yaml new file mode 100644 index 0000000000..0b29d94268 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/UpdateCartData.yaml @@ -0,0 +1,44 @@ +type: object +description: SUMMARY +x-schemaName: UpdateCartData +properties: + region_id: + type: string + title: region_id + description: The cart's region id. + customer_id: + type: string + title: customer_id + description: The cart's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The cart's sales channel id. + email: + type: string + title: email + description: The cart's email. + format: email + currency_code: + type: string + title: currency_code + description: The cart's currency code. + shipping_address_id: + type: string + title: shipping_address_id + description: The cart's shipping address id. + billing_address_id: + type: string + title: billing_address_id + description: The cart's billing address id. + billing_address: + oneOf: + - $ref: ./CreateAddress.yaml + - $ref: ./UpdateAddress.yaml + shipping_address: + oneOf: + - $ref: ./CreateAddress.yaml + - $ref: ./UpdateAddress.yaml + metadata: + type: object + description: The cart's metadata. diff --git a/www/apps/api-reference/specs/store/openapi.full.yaml b/www/apps/api-reference/specs/store/openapi.full.yaml index 0b820cbe00..cc7c67b93d 100644 --- a/www/apps/api-reference/specs/store/openapi.full.yaml +++ b/www/apps/api-reference/specs/store/openapi.full.yaml @@ -114,64 +114,15 @@ paths: content: application/json: schema: + allOf: + - $ref: '#/components/schemas/CreateCartWorkflowInput' + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. description: SUMMARY - properties: - region_id: - type: string - title: region_id - description: The cart's region id. - customer_id: - type: string - title: customer_id - description: The cart's customer id. - sales_channel_id: - type: string - title: sales_channel_id - description: The cart's sales channel id. - email: - type: string - title: email - description: The cart's email. - format: email - currency_code: - type: string - title: currency_code - description: The cart's currency code. - shipping_address_id: - type: string - title: shipping_address_id - description: The cart's shipping address id. - billing_address_id: - type: string - title: billing_address_id - description: The cart's billing address id. - shipping_address: - oneOf: - - type: string - title: shipping_address - description: The cart's shipping address. - - $ref: '#/components/schemas/CreateCartAddress' - billing_address: - oneOf: - - type: string - title: billing_address - description: The cart's billing address. - - $ref: '#/components/schemas/CreateCartAddress' - metadata: - type: object - description: The cart's metadata. - items: - type: array - description: The cart's items. - items: - $ref: '#/components/schemas/CreateCartCreateLineItem' - promo_codes: - type: array - description: The cart's promo codes. - items: - type: string - title: promo_codes - description: The promo code's promo codes. x-codeSamples: - lang: Shell label: cURL @@ -332,48 +283,15 @@ paths: content: application/json: schema: + allOf: + - $ref: '#/components/schemas/UpdateCartData' + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. description: SUMMARY - properties: - region_id: - type: string - title: region_id - description: The cart's region id. - customer_id: - type: string - title: customer_id - description: The cart's customer id. - sales_channel_id: - type: string - title: sales_channel_id - description: The cart's sales channel id. - email: - type: string - title: email - description: The cart's email. - format: email - currency_code: - type: string - title: currency_code - description: The cart's currency code. - shipping_address_id: - type: string - title: shipping_address_id - description: The cart's shipping address id. - billing_address_id: - type: string - title: billing_address_id - description: The cart's billing address id. - billing_address: - oneOf: - - $ref: '#/components/schemas/CreateAddress' - - $ref: '#/components/schemas/UpdateAddress' - shipping_address: - oneOf: - - $ref: '#/components/schemas/CreateAddress' - - $ref: '#/components/schemas/UpdateAddress' - metadata: - type: object - description: The cart's metadata. x-codeSamples: - lang: Shell label: cURL @@ -14625,6 +14543,15 @@ components: description: The payment collection's payments. items: $ref: '#/components/schemas/BasePayment' + AdminPaymentCollectionResponse: + type: object + description: SUMMARY + x-schemaName: AdminPaymentCollectionResponse + required: + - payment_collection + properties: + payment_collection: + $ref: '#/components/schemas/AdminPaymentCollection' AdminPaymentProvider: type: object description: The payment provider's payment providers. @@ -21447,6 +21374,67 @@ components: metadata: type: object description: The item's metadata. + CreateCartWorkflowInput: + type: object + description: SUMMARY + x-schemaName: CreateCartWorkflowInput + properties: + region_id: + type: string + title: region_id + description: The cart's region id. + customer_id: + type: string + title: customer_id + description: The cart's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The cart's sales channel id. + email: + type: string + title: email + description: The cart's email. + format: email + currency_code: + type: string + title: currency_code + description: The cart's currency code. + shipping_address_id: + type: string + title: shipping_address_id + description: The cart's shipping address id. + billing_address_id: + type: string + title: billing_address_id + description: The cart's billing address id. + shipping_address: + oneOf: + - type: string + title: shipping_address + description: The cart's shipping address. + - $ref: '#/components/schemas/CreateCartAddress' + billing_address: + oneOf: + - type: string + title: billing_address + description: The cart's billing address. + - $ref: '#/components/schemas/CreateCartAddress' + metadata: + type: object + description: The cart's metadata. + items: + type: array + description: The cart's items. + items: + $ref: '#/components/schemas/CreateCartCreateLineItem' + promo_codes: + type: array + description: The cart's promo codes. + items: + type: string + title: promo_codes + description: The promo code's promo codes. CreateOrderReturnReason: type: object description: SUMMARY @@ -21474,33 +21462,6 @@ components: metadata: type: object description: The return reason's metadata. - CreateUser: - type: object - description: SUMMARY - x-schemaName: CreateUser - required: - - email - properties: - email: - type: string - title: email - description: The user's email. - format: email - first_name: - type: string - title: first_name - description: The user's first name. - last_name: - type: string - title: last_name - description: The user's last name. - avatar_url: - type: string - title: avatar_url - description: The user's avatar url. - metadata: - type: object - description: The user's metadata. Error: title: Response Error type: object @@ -25441,6 +25402,51 @@ components: metadata: type: object description: The shipping address's metadata. + UpdateCartData: + type: object + description: SUMMARY + x-schemaName: UpdateCartData + properties: + region_id: + type: string + title: region_id + description: The cart's region id. + customer_id: + type: string + title: customer_id + description: The cart's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The cart's sales channel id. + email: + type: string + title: email + description: The cart's email. + format: email + currency_code: + type: string + title: currency_code + description: The cart's currency code. + shipping_address_id: + type: string + title: shipping_address_id + description: The cart's shipping address id. + billing_address_id: + type: string + title: billing_address_id + description: The cart's billing address id. + billing_address: + oneOf: + - $ref: '#/components/schemas/CreateAddress' + - $ref: '#/components/schemas/UpdateAddress' + shipping_address: + oneOf: + - $ref: '#/components/schemas/CreateAddress' + - $ref: '#/components/schemas/UpdateAddress' + metadata: + type: object + description: The cart's metadata. UpdateOrderReturnReason: type: object description: SUMMARY diff --git a/www/apps/api-reference/specs/store/paths/store_carts.yaml b/www/apps/api-reference/specs/store/paths/store_carts.yaml index 3bbf2826a4..a4dbbbda69 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts.yaml @@ -63,64 +63,18 @@ post: content: application/json: schema: + allOf: + - $ref: ../components/schemas/CreateCartWorkflowInput.yaml + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: >- + Pass additional custom data to the API route. This data is + passed to the underlying workflow under the + `additional_data` parameter. description: SUMMARY - properties: - region_id: - type: string - title: region_id - description: The cart's region id. - customer_id: - type: string - title: customer_id - description: The cart's customer id. - sales_channel_id: - type: string - title: sales_channel_id - description: The cart's sales channel id. - email: - type: string - title: email - description: The cart's email. - format: email - currency_code: - type: string - title: currency_code - description: The cart's currency code. - shipping_address_id: - type: string - title: shipping_address_id - description: The cart's shipping address id. - billing_address_id: - type: string - title: billing_address_id - description: The cart's billing address id. - shipping_address: - oneOf: - - type: string - title: shipping_address - description: The cart's shipping address. - - $ref: ../components/schemas/CreateCartAddress.yaml - billing_address: - oneOf: - - type: string - title: billing_address - description: The cart's billing address. - - $ref: ../components/schemas/CreateCartAddress.yaml - metadata: - type: object - description: The cart's metadata. - items: - type: array - description: The cart's items. - items: - $ref: ../components/schemas/CreateCartCreateLineItem.yaml - promo_codes: - type: array - description: The cart's promo codes. - items: - type: string - title: promo_codes - description: The promo code's promo codes. x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml index ad2a63e404..d2e9d52a7c 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml @@ -164,48 +164,18 @@ post: content: application/json: schema: + allOf: + - $ref: ../components/schemas/UpdateCartData.yaml + - type: object + description: SUMMARY + properties: + additional_data: + type: object + description: >- + Pass additional custom data to the API route. This data is + passed to the underlying workflow under the + `additional_data` parameter. description: SUMMARY - properties: - region_id: - type: string - title: region_id - description: The cart's region id. - customer_id: - type: string - title: customer_id - description: The cart's customer id. - sales_channel_id: - type: string - title: sales_channel_id - description: The cart's sales channel id. - email: - type: string - title: email - description: The cart's email. - format: email - currency_code: - type: string - title: currency_code - description: The cart's currency code. - shipping_address_id: - type: string - title: shipping_address_id - description: The cart's shipping address id. - billing_address_id: - type: string - title: billing_address_id - description: The cart's billing address id. - billing_address: - oneOf: - - $ref: ../components/schemas/CreateAddress.yaml - - $ref: ../components/schemas/UpdateAddress.yaml - shipping_address: - oneOf: - - $ref: ../components/schemas/CreateAddress.yaml - - $ref: ../components/schemas/UpdateAddress.yaml - metadata: - type: object - description: The cart's metadata. x-codeSamples: - lang: Shell label: cURL diff --git a/www/utils/generated/oas-output/base/admin.oas.base.yaml b/www/utils/generated/oas-output/base/admin.oas.base.yaml index 258e1d2250..6c793c9b54 100644 --- a/www/utils/generated/oas-output/base/admin.oas.base.yaml +++ b/www/utils/generated/oas-output/base/admin.oas.base.yaml @@ -69,6 +69,9 @@ tags: - name: Orders x-associatedSchema: $ref: "#/components/schemas/AdminOrder" + - name: Payment Collections + x-associatedSchema: + $ref: "#/components/schemas/AdminPaymentCollection" - name: Payments x-associatedSchema: $ref: "#/components/schemas/AdminPayment" diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id].ts index d882405fd6..7ca1c1409f 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id].ts @@ -21,18 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id]_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id]_items_[action_id].ts index 1d750498aa..e1a77209df 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id]_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id]_items_[action_id].ts @@ -28,18 +28,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id]_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id]_shipping-method_[action_id].ts index 2f9ae73839..65abbae2be 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id]_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id]_shipping-method_[action_id].ts @@ -29,18 +29,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_exchanges_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_exchanges_[id].ts index bd5916ae01..2b77dbfce2 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_exchanges_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_exchanges_[id].ts @@ -22,18 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_products.ts b/www/utils/generated/oas-output/operations/admin/get_admin_products.ts index 810005c372..3621f66c9b 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_products.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_products.ts @@ -10151,1915 +10151,10 @@ * type: array * description: The product's $and. * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductListParams - * properties: - * q: - * type: string - * title: q - * description: The $and's q. - * status: - * oneOf: - * - type: string - * title: status - * description: The $and's status. - * - type: string - * title: status - * description: The $and's status. - * - type: string - * title: status - * description: The $and's status. - * - type: string - * title: status - * description: The $and's status. - * - type: array - * description: The $and's status. - * items: - * type: string - * enum: - * - draft - * - proposed - * - published - * - rejected - * sales_channel_id: - * oneOf: - * - type: string - * title: sales_channel_id - * description: The $and's sales channel id. - * - type: array - * description: The $and's sales channel id. - * items: - * type: string - * title: sales_channel_id - * description: The sales channel id's details. - * title: - * oneOf: - * - type: string - * title: title - * description: The $and's title. - * - type: array - * description: The $and's title. - * items: - * type: string - * title: title - * description: The title's details. - * handle: - * oneOf: - * - type: string - * title: handle - * description: The $and's handle. - * - type: array - * description: The $and's handle. - * items: - * type: string - * title: handle - * description: The handle's details. - * id: - * oneOf: - * - type: string - * title: id - * description: The $and's ID. - * - type: array - * description: The $and's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * is_giftcard: - * type: boolean - * title: is_giftcard - * description: The $and's is giftcard. - * tags: - * type: object - * description: The $and's tags. - * properties: - * value: - * type: array - * description: The tag's value. - * items: - * type: string - * title: value - * description: The value's details. - * type_id: - * oneOf: - * - type: string - * title: type_id - * description: The $and's type id. - * - type: array - * description: The $and's type id. - * items: - * type: string - * title: type_id - * description: The type id's details. - * category_id: - * oneOf: - * - type: string - * title: category_id - * description: The $and's category id. - * - type: array - * description: The $and's category id. - * items: - * type: string - * title: category_id - * description: The category id's details. - * - type: object - * description: The $and's category id. - * properties: - * $and: - * type: array - * description: The category id's $and. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * - type: object - * description: The $and's details. - * - type: array - * description: The $and's details. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * $or: - * type: array - * description: The category id's $or. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * - type: object - * description: The $or's details. - * - type: array - * description: The $or's details. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The category id's $eq. - * - type: object - * description: The category id's $eq. - * x-schemaName: RegExp - * - type: array - * description: The category id's $eq. - * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The category id's $ne. - * - type: object - * description: The category id's $ne. - * x-schemaName: RegExp - * $in: - * type: array - * description: The category id's $in. - * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp - * $nin: - * type: array - * description: The category id's $nin. - * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp - * $not: - * oneOf: - * - type: string - * title: $not - * description: The category id's $not. - * - type: object - * description: The category id's $not. - * x-schemaName: RegExp - * - type: object - * description: The category id's $not. - * - type: array - * description: The category id's $not. - * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The category id's $gt. - * - type: object - * description: The category id's $gt. - * x-schemaName: RegExp - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The category id's $gte. - * - type: object - * description: The category id's $gte. - * x-schemaName: RegExp - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The category id's $lt. - * - type: object - * description: The category id's $lt. - * x-schemaName: RegExp - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The category id's $lte. - * - type: object - * description: The category id's $lte. - * x-schemaName: RegExp - * $like: - * type: string - * title: $like - * description: The category id's $like. - * $re: - * type: string - * title: $re - * description: The category id's $re. - * $ilike: - * type: string - * title: $ilike - * description: The category id's $ilike. - * $fulltext: - * type: string - * title: $fulltext - * description: The category id's $fulltext. - * $overlap: - * type: array - * description: The category id's $overlap. - * items: - * type: string - * title: $overlap - * description: The $overlap's details. - * $contains: - * type: array - * description: The category id's $contains. - * items: - * type: string - * title: $contains - * description: The $contain's $contains. - * $contained: - * type: array - * description: The category id's $contained. - * items: - * type: string - * title: $contained - * description: The $contained's details. - * $exists: - * type: boolean - * title: $exists - * description: The category id's $exists. - * categories: - * oneOf: - * - type: object - * description: The $and's categories. - * required: - * - id - * properties: - * id: - * type: object - * description: The category's ID. - * - type: object - * description: The $and's categories. - * required: - * - id - * properties: - * id: - * type: object - * description: The category's ID. - * collection_id: - * oneOf: - * - type: string - * title: collection_id - * description: The $and's collection id. - * - type: array - * description: The $and's collection id. - * items: - * type: string - * title: collection_id - * description: The collection id's details. - * - type: object - * description: The $and's collection id. - * properties: - * $and: - * type: array - * description: The collection id's $and. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * - type: object - * description: The $and's details. - * - type: array - * description: The $and's details. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * $or: - * type: array - * description: The collection id's $or. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * - type: object - * description: The $or's details. - * - type: array - * description: The $or's details. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The collection id's $eq. - * - type: object - * description: The collection id's $eq. - * x-schemaName: RegExp - * - type: array - * description: The collection id's $eq. - * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The collection id's $ne. - * - type: object - * description: The collection id's $ne. - * x-schemaName: RegExp - * $in: - * type: array - * description: The collection id's $in. - * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp - * $nin: - * type: array - * description: The collection id's $nin. - * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp - * $not: - * oneOf: - * - type: string - * title: $not - * description: The collection id's $not. - * - type: object - * description: The collection id's $not. - * x-schemaName: RegExp - * - type: object - * description: The collection id's $not. - * - type: array - * description: The collection id's $not. - * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The collection id's $gt. - * - type: object - * description: The collection id's $gt. - * x-schemaName: RegExp - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The collection id's $gte. - * - type: object - * description: The collection id's $gte. - * x-schemaName: RegExp - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The collection id's $lt. - * - type: object - * description: The collection id's $lt. - * x-schemaName: RegExp - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The collection id's $lte. - * - type: object - * description: The collection id's $lte. - * x-schemaName: RegExp - * $like: - * type: string - * title: $like - * description: The collection id's $like. - * $re: - * type: string - * title: $re - * description: The collection id's $re. - * $ilike: - * type: string - * title: $ilike - * description: The collection id's $ilike. - * $fulltext: - * type: string - * title: $fulltext - * description: The collection id's $fulltext. - * $overlap: - * type: array - * description: The collection id's $overlap. - * items: - * type: string - * title: $overlap - * description: The $overlap's details. - * $contains: - * type: array - * description: The collection id's $contains. - * items: - * type: string - * title: $contains - * description: The $contain's $contains. - * $contained: - * type: array - * description: The collection id's $contained. - * items: - * type: string - * title: $contained - * description: The $contained's details. - * $exists: - * type: boolean - * title: $exists - * description: The collection id's $exists. - * created_at: - * type: object - * description: The $and's created at. - * properties: - * $and: - * type: array - * description: The created at's $and. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * - type: object - * description: The $and's details. - * - type: array - * description: The $and's details. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * $or: - * type: array - * description: The created at's $or. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * - type: object - * description: The $or's details. - * - type: array - * description: The $or's details. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The created at's $eq. - * - type: object - * description: The created at's $eq. - * x-schemaName: RegExp - * - type: array - * description: The created at's $eq. - * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The created at's $ne. - * - type: object - * description: The created at's $ne. - * x-schemaName: RegExp - * $in: - * type: array - * description: The created at's $in. - * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp - * $nin: - * type: array - * description: The created at's $nin. - * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp - * $not: - * oneOf: - * - type: string - * title: $not - * description: The created at's $not. - * - type: object - * description: The created at's $not. - * x-schemaName: RegExp - * - type: object - * description: The created at's $not. - * - type: array - * description: The created at's $not. - * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The created at's $gt. - * - type: object - * description: The created at's $gt. - * x-schemaName: RegExp - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The created at's $gte. - * - type: object - * description: The created at's $gte. - * x-schemaName: RegExp - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The created at's $lt. - * - type: object - * description: The created at's $lt. - * x-schemaName: RegExp - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The created at's $lte. - * - type: object - * description: The created at's $lte. - * x-schemaName: RegExp - * $like: - * type: string - * title: $like - * description: The created at's $like. - * $re: - * type: string - * title: $re - * description: The created at's $re. - * $ilike: - * type: string - * title: $ilike - * description: The created at's $ilike. - * $fulltext: - * type: string - * title: $fulltext - * description: The created at's $fulltext. - * $overlap: - * type: array - * description: The created at's $overlap. - * items: - * type: string - * title: $overlap - * description: The $overlap's details. - * $contains: - * type: array - * description: The created at's $contains. - * items: - * type: string - * title: $contains - * description: The $contain's $contains. - * $contained: - * type: array - * description: The created at's $contained. - * items: - * type: string - * title: $contained - * description: The $contained's details. - * $exists: - * type: boolean - * title: $exists - * description: The created at's $exists. - * updated_at: - * type: object - * description: The $and's updated at. - * properties: - * $and: - * type: array - * description: The updated at's $and. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * - type: object - * description: The $and's details. - * - type: array - * description: The $and's details. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * $or: - * type: array - * description: The updated at's $or. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * - type: object - * description: The $or's details. - * - type: array - * description: The $or's details. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The updated at's $eq. - * - type: object - * description: The updated at's $eq. - * x-schemaName: RegExp - * - type: array - * description: The updated at's $eq. - * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The updated at's $ne. - * - type: object - * description: The updated at's $ne. - * x-schemaName: RegExp - * $in: - * type: array - * description: The updated at's $in. - * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp - * $nin: - * type: array - * description: The updated at's $nin. - * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp - * $not: - * oneOf: - * - type: string - * title: $not - * description: The updated at's $not. - * - type: object - * description: The updated at's $not. - * x-schemaName: RegExp - * - type: object - * description: The updated at's $not. - * - type: array - * description: The updated at's $not. - * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The updated at's $gt. - * - type: object - * description: The updated at's $gt. - * x-schemaName: RegExp - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The updated at's $gte. - * - type: object - * description: The updated at's $gte. - * x-schemaName: RegExp - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The updated at's $lt. - * - type: object - * description: The updated at's $lt. - * x-schemaName: RegExp - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The updated at's $lte. - * - type: object - * description: The updated at's $lte. - * x-schemaName: RegExp - * $like: - * type: string - * title: $like - * description: The updated at's $like. - * $re: - * type: string - * title: $re - * description: The updated at's $re. - * $ilike: - * type: string - * title: $ilike - * description: The updated at's $ilike. - * $fulltext: - * type: string - * title: $fulltext - * description: The updated at's $fulltext. - * $overlap: - * type: array - * description: The updated at's $overlap. - * items: - * type: string - * title: $overlap - * description: The $overlap's details. - * $contains: - * type: array - * description: The updated at's $contains. - * items: - * type: string - * title: $contains - * description: The $contain's $contains. - * $contained: - * type: array - * description: The updated at's $contained. - * items: - * type: string - * title: $contained - * description: The $contained's details. - * $exists: - * type: boolean - * title: $exists - * description: The updated at's $exists. - * deleted_at: - * type: object - * description: The $and's deleted at. - * properties: - * $and: - * type: array - * description: The deleted at's $and. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * - type: object - * description: The $and's details. - * - type: array - * description: The $and's details. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * $or: - * type: array - * description: The deleted at's $or. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * - type: object - * description: The $or's details. - * - type: array - * description: The $or's details. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The deleted at's $eq. - * - type: object - * description: The deleted at's $eq. - * x-schemaName: RegExp - * - type: array - * description: The deleted at's $eq. - * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The deleted at's $ne. - * - type: object - * description: The deleted at's $ne. - * x-schemaName: RegExp - * $in: - * type: array - * description: The deleted at's $in. - * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp - * $nin: - * type: array - * description: The deleted at's $nin. - * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp - * $not: - * oneOf: - * - type: string - * title: $not - * description: The deleted at's $not. - * - type: object - * description: The deleted at's $not. - * x-schemaName: RegExp - * - type: object - * description: The deleted at's $not. - * - type: array - * description: The deleted at's $not. - * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The deleted at's $gt. - * - type: object - * description: The deleted at's $gt. - * x-schemaName: RegExp - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The deleted at's $gte. - * - type: object - * description: The deleted at's $gte. - * x-schemaName: RegExp - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The deleted at's $lt. - * - type: object - * description: The deleted at's $lt. - * x-schemaName: RegExp - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The deleted at's $lte. - * - type: object - * description: The deleted at's $lte. - * x-schemaName: RegExp - * $like: - * type: string - * title: $like - * description: The deleted at's $like. - * $re: - * type: string - * title: $re - * description: The deleted at's $re. - * $ilike: - * type: string - * title: $ilike - * description: The deleted at's $ilike. - * $fulltext: - * type: string - * title: $fulltext - * description: The deleted at's $fulltext. - * $overlap: - * type: array - * description: The deleted at's $overlap. - * items: - * type: string - * title: $overlap - * description: The $overlap's details. - * $contains: - * type: array - * description: The deleted at's $contains. - * items: - * type: string - * title: $contains - * description: The $contain's $contains. - * $contained: - * type: array - * description: The deleted at's $contained. - * items: - * type: string - * title: $contained - * description: The $contained's details. - * $exists: - * type: boolean - * title: $exists - * description: The deleted at's $exists. - * limit: - * type: number - * title: limit - * description: The $and's limit. - * offset: - * type: number - * title: offset - * description: The $and's offset. - * order: - * type: string - * title: order - * description: The $and's order. - * fields: - * type: string - * title: fields - * description: The $and's fields. - * $and: - * type: array - * description: The $and's details. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductListParams - * properties: - * q: - * type: string - * title: q - * description: The $and's q. - * status: - * oneOf: - * - type: string - * title: status - * description: The $and's status. - * - type: string - * title: status - * description: The $and's status. - * - type: string - * title: status - * description: The $and's status. - * - type: string - * title: status - * description: The $and's status. - * - type: array - * description: The $and's status. - * items: - * type: string - * enum: - * - draft - * - proposed - * - published - * - rejected - * sales_channel_id: - * oneOf: - * - type: string - * title: sales_channel_id - * description: The $and's sales channel id. - * - type: array - * description: The $and's sales channel id. - * items: - * type: string - * title: sales_channel_id - * description: The sales channel id's details. - * title: - * oneOf: - * - type: string - * title: title - * description: The $and's title. - * - type: array - * description: The $and's title. - * items: - * type: string - * title: title - * description: The title's details. - * handle: - * oneOf: - * - type: string - * title: handle - * description: The $and's handle. - * - type: array - * description: The $and's handle. - * items: - * type: string - * title: handle - * description: The handle's details. - * id: - * oneOf: - * - type: string - * title: id - * description: The $and's ID. - * - type: array - * description: The $and's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * is_giftcard: - * type: boolean - * title: is_giftcard - * description: The $and's is giftcard. - * tags: - * type: object - * description: The $and's tags. - * type_id: - * oneOf: - * - type: string - * title: type_id - * description: The $and's type id. - * - type: array - * description: The $and's type id. - * items: - * type: string - * title: type_id - * description: The type id's details. - * category_id: - * oneOf: - * - type: string - * title: category_id - * description: The $and's category id. - * - type: array - * description: The $and's category id. - * items: - * type: string - * title: category_id - * description: The category id's details. - * - type: object - * description: The $and's category id. - * categories: - * oneOf: - * - type: object - * description: The $and's categories. - * - type: object - * description: The $and's categories. - * collection_id: - * oneOf: - * - type: string - * title: collection_id - * description: The $and's collection id. - * - type: array - * description: The $and's collection id. - * items: - * type: string - * title: collection_id - * description: The collection id's details. - * - type: object - * description: The $and's collection id. - * created_at: - * type: object - * description: The $and's created at. - * updated_at: - * type: object - * description: The $and's updated at. - * deleted_at: - * type: object - * description: The $and's deleted at. - * limit: - * type: number - * title: limit - * description: The $and's limit. - * offset: - * type: number - * title: offset - * description: The $and's offset. - * order: - * type: string - * title: order - * description: The $and's order. - * fields: - * type: string - * title: fields - * description: The $and's fields. - * $and: - * type: array - * description: The $and's details. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductListParams - * - type: object - * description: The $and's details. - * $or: - * type: array - * description: The $and's $or. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductListParams - * - type: object - * description: The $or's details. - * - type: object - * description: The $and's details. - * properties: - * $and: - * type: array - * description: The $and's details. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductListParams - * - type: object - * description: The $and's details. - * $or: - * type: array - * description: The $and's $or. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductListParams - * - type: object - * description: The $or's details. - * $or: - * type: array - * description: The $and's $or. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductListParams - * properties: - * q: - * type: string - * title: q - * description: The $or's q. - * status: - * oneOf: - * - type: string - * title: status - * description: The $or's status. - * - type: string - * title: status - * description: The $or's status. - * - type: string - * title: status - * description: The $or's status. - * - type: string - * title: status - * description: The $or's status. - * - type: array - * description: The $or's status. - * items: - * type: string - * enum: - * - draft - * - proposed - * - published - * - rejected - * sales_channel_id: - * oneOf: - * - type: string - * title: sales_channel_id - * description: The $or's sales channel id. - * - type: array - * description: The $or's sales channel id. - * items: - * type: string - * title: sales_channel_id - * description: The sales channel id's details. - * title: - * oneOf: - * - type: string - * title: title - * description: The $or's title. - * - type: array - * description: The $or's title. - * items: - * type: string - * title: title - * description: The title's details. - * handle: - * oneOf: - * - type: string - * title: handle - * description: The $or's handle. - * - type: array - * description: The $or's handle. - * items: - * type: string - * title: handle - * description: The handle's details. - * id: - * oneOf: - * - type: string - * title: id - * description: The $or's ID. - * - type: array - * description: The $or's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * is_giftcard: - * type: boolean - * title: is_giftcard - * description: The $or's is giftcard. - * tags: - * type: object - * description: The $or's tags. - * type_id: - * oneOf: - * - type: string - * title: type_id - * description: The $or's type id. - * - type: array - * description: The $or's type id. - * items: - * type: string - * title: type_id - * description: The type id's details. - * category_id: - * oneOf: - * - type: string - * title: category_id - * description: The $or's category id. - * - type: array - * description: The $or's category id. - * items: - * type: string - * title: category_id - * description: The category id's details. - * - type: object - * description: The $or's category id. - * categories: - * oneOf: - * - type: object - * description: The $or's categories. - * - type: object - * description: The $or's categories. - * collection_id: - * oneOf: - * - type: string - * title: collection_id - * description: The $or's collection id. - * - type: array - * description: The $or's collection id. - * items: - * type: string - * title: collection_id - * description: The collection id's details. - * - type: object - * description: The $or's collection id. - * created_at: - * type: object - * description: The $or's created at. - * updated_at: - * type: object - * description: The $or's updated at. - * deleted_at: - * type: object - * description: The $or's deleted at. - * limit: - * type: number - * title: limit - * description: The $or's limit. - * offset: - * type: number - * title: offset - * description: The $or's offset. - * order: - * type: string - * title: order - * description: The $or's order. - * fields: - * type: string - * title: fields - * description: The $or's fields. - * $and: - * type: array - * description: The $or's $and. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductListParams - * - type: object - * description: The $and's details. - * $or: - * type: array - * description: The $or's details. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductListParams - * - type: object - * description: The $or's details. - * - type: object - * description: The $or's details. - * properties: - * $and: - * type: array - * description: The $or's $and. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductListParams - * - type: object - * description: The $and's details. - * $or: - * type: array - * description: The $or's details. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductListParams - * - type: object - * description: The $or's details. - * - type: object - * description: The $and's details. - * properties: - * $and: - * type: array - * description: The $and's details. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductListParams - * properties: - * q: - * type: string - * title: q - * description: The $and's q. - * status: - * oneOf: - * - type: string - * title: status - * description: The $and's status. - * - type: string - * title: status - * description: The $and's status. - * - type: string - * title: status - * description: The $and's status. - * - type: string - * title: status - * description: The $and's status. - * - type: array - * description: The $and's status. - * items: - * type: string - * enum: - * - draft - * - proposed - * - published - * - rejected - * sales_channel_id: - * oneOf: - * - type: string - * title: sales_channel_id - * description: The $and's sales channel id. - * - type: array - * description: The $and's sales channel id. - * items: - * type: string - * title: sales_channel_id - * description: The sales channel id's details. - * title: - * oneOf: - * - type: string - * title: title - * description: The $and's title. - * - type: array - * description: The $and's title. - * items: - * type: string - * title: title - * description: The title's details. - * handle: - * oneOf: - * - type: string - * title: handle - * description: The $and's handle. - * - type: array - * description: The $and's handle. - * items: - * type: string - * title: handle - * description: The handle's details. - * id: - * oneOf: - * - type: string - * title: id - * description: The $and's ID. - * - type: array - * description: The $and's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * is_giftcard: - * type: boolean - * title: is_giftcard - * description: The $and's is giftcard. - * tags: - * type: object - * description: The $and's tags. - * type_id: - * oneOf: - * - type: string - * title: type_id - * description: The $and's type id. - * - type: array - * description: The $and's type id. - * items: - * type: string - * title: type_id - * description: The type id's details. - * category_id: - * oneOf: - * - type: string - * title: category_id - * description: The $and's category id. - * - type: array - * description: The $and's category id. - * items: - * type: string - * title: category_id - * description: The category id's details. - * - type: object - * description: The $and's category id. - * categories: - * oneOf: - * - type: object - * description: The $and's categories. - * - type: object - * description: The $and's categories. - * collection_id: - * oneOf: - * - type: string - * title: collection_id - * description: The $and's collection id. - * - type: array - * description: The $and's collection id. - * items: - * type: string - * title: collection_id - * description: The collection id's details. - * - type: object - * description: The $and's collection id. - * created_at: - * type: object - * description: The $and's created at. - * updated_at: - * type: object - * description: The $and's updated at. - * deleted_at: - * type: object - * description: The $and's deleted at. - * limit: - * type: number - * title: limit - * description: The $and's limit. - * offset: - * type: number - * title: offset - * description: The $and's offset. - * order: - * type: string - * title: order - * description: The $and's order. - * fields: - * type: string - * title: fields - * description: The $and's fields. - * $and: - * type: array - * description: The $and's details. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductListParams - * - type: object - * description: The $and's details. - * $or: - * type: array - * description: The $and's $or. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductListParams - * - type: object - * description: The $or's details. - * - type: object - * description: The $and's details. - * properties: - * $and: - * type: array - * description: The $and's details. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductListParams - * - type: object - * description: The $and's details. - * $or: - * type: array - * description: The $and's $or. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductListParams - * - type: object - * description: The $or's details. - * $or: - * type: array - * description: The $and's $or. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductListParams - * properties: - * q: - * type: string - * title: q - * description: The $or's q. - * status: - * oneOf: - * - type: string - * title: status - * description: The $or's status. - * - type: string - * title: status - * description: The $or's status. - * - type: string - * title: status - * description: The $or's status. - * - type: string - * title: status - * description: The $or's status. - * - type: array - * description: The $or's status. - * items: - * type: string - * enum: - * - draft - * - proposed - * - published - * - rejected - * sales_channel_id: - * oneOf: - * - type: string - * title: sales_channel_id - * description: The $or's sales channel id. - * - type: array - * description: The $or's sales channel id. - * items: - * type: string - * title: sales_channel_id - * description: The sales channel id's details. - * title: - * oneOf: - * - type: string - * title: title - * description: The $or's title. - * - type: array - * description: The $or's title. - * items: - * type: string - * title: title - * description: The title's details. - * handle: - * oneOf: - * - type: string - * title: handle - * description: The $or's handle. - * - type: array - * description: The $or's handle. - * items: - * type: string - * title: handle - * description: The handle's details. - * id: - * oneOf: - * - type: string - * title: id - * description: The $or's ID. - * - type: array - * description: The $or's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * is_giftcard: - * type: boolean - * title: is_giftcard - * description: The $or's is giftcard. - * tags: - * type: object - * description: The $or's tags. - * type_id: - * oneOf: - * - type: string - * title: type_id - * description: The $or's type id. - * - type: array - * description: The $or's type id. - * items: - * type: string - * title: type_id - * description: The type id's details. - * category_id: - * oneOf: - * - type: string - * title: category_id - * description: The $or's category id. - * - type: array - * description: The $or's category id. - * items: - * type: string - * title: category_id - * description: The category id's details. - * - type: object - * description: The $or's category id. - * categories: - * oneOf: - * - type: object - * description: The $or's categories. - * - type: object - * description: The $or's categories. - * collection_id: - * oneOf: - * - type: string - * title: collection_id - * description: The $or's collection id. - * - type: array - * description: The $or's collection id. - * items: - * type: string - * title: collection_id - * description: The collection id's details. - * - type: object - * description: The $or's collection id. - * created_at: - * type: object - * description: The $or's created at. - * updated_at: - * type: object - * description: The $or's updated at. - * deleted_at: - * type: object - * description: The $or's deleted at. - * limit: - * type: number - * title: limit - * description: The $or's limit. - * offset: - * type: number - * title: offset - * description: The $or's offset. - * order: - * type: string - * title: order - * description: The $or's order. - * fields: - * type: string - * title: fields - * description: The $or's fields. - * $and: - * type: array - * description: The $or's $and. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductListParams - * - type: object - * description: The $and's details. - * $or: - * type: array - * description: The $or's details. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductListParams - * - type: object - * description: The $or's details. - * - type: object - * description: The $or's details. - * properties: - * $and: - * type: array - * description: The $or's $and. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductListParams - * - type: object - * description: The $and's details. - * $or: - * type: array - * description: The $or's details. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductListParams - * - type: object - * description: The $or's details. * type: array * items: * type: object + * title: $and * - name: $or * in: query * description: The product's $or. @@ -12068,1915 +10163,10 @@ * type: array * description: The product's $or. * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductListParams - * properties: - * q: - * type: string - * title: q - * description: The $or's q. - * status: - * oneOf: - * - type: string - * title: status - * description: The $or's status. - * - type: string - * title: status - * description: The $or's status. - * - type: string - * title: status - * description: The $or's status. - * - type: string - * title: status - * description: The $or's status. - * - type: array - * description: The $or's status. - * items: - * type: string - * enum: - * - draft - * - proposed - * - published - * - rejected - * sales_channel_id: - * oneOf: - * - type: string - * title: sales_channel_id - * description: The $or's sales channel id. - * - type: array - * description: The $or's sales channel id. - * items: - * type: string - * title: sales_channel_id - * description: The sales channel id's details. - * title: - * oneOf: - * - type: string - * title: title - * description: The $or's title. - * - type: array - * description: The $or's title. - * items: - * type: string - * title: title - * description: The title's details. - * handle: - * oneOf: - * - type: string - * title: handle - * description: The $or's handle. - * - type: array - * description: The $or's handle. - * items: - * type: string - * title: handle - * description: The handle's details. - * id: - * oneOf: - * - type: string - * title: id - * description: The $or's ID. - * - type: array - * description: The $or's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * is_giftcard: - * type: boolean - * title: is_giftcard - * description: The $or's is giftcard. - * tags: - * type: object - * description: The $or's tags. - * properties: - * value: - * type: array - * description: The tag's value. - * items: - * type: string - * title: value - * description: The value's details. - * type_id: - * oneOf: - * - type: string - * title: type_id - * description: The $or's type id. - * - type: array - * description: The $or's type id. - * items: - * type: string - * title: type_id - * description: The type id's details. - * category_id: - * oneOf: - * - type: string - * title: category_id - * description: The $or's category id. - * - type: array - * description: The $or's category id. - * items: - * type: string - * title: category_id - * description: The category id's details. - * - type: object - * description: The $or's category id. - * properties: - * $and: - * type: array - * description: The category id's $and. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * - type: object - * description: The $and's details. - * - type: array - * description: The $and's details. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * $or: - * type: array - * description: The category id's $or. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * - type: object - * description: The $or's details. - * - type: array - * description: The $or's details. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The category id's $eq. - * - type: object - * description: The category id's $eq. - * x-schemaName: RegExp - * - type: array - * description: The category id's $eq. - * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The category id's $ne. - * - type: object - * description: The category id's $ne. - * x-schemaName: RegExp - * $in: - * type: array - * description: The category id's $in. - * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp - * $nin: - * type: array - * description: The category id's $nin. - * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp - * $not: - * oneOf: - * - type: string - * title: $not - * description: The category id's $not. - * - type: object - * description: The category id's $not. - * x-schemaName: RegExp - * - type: object - * description: The category id's $not. - * - type: array - * description: The category id's $not. - * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The category id's $gt. - * - type: object - * description: The category id's $gt. - * x-schemaName: RegExp - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The category id's $gte. - * - type: object - * description: The category id's $gte. - * x-schemaName: RegExp - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The category id's $lt. - * - type: object - * description: The category id's $lt. - * x-schemaName: RegExp - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The category id's $lte. - * - type: object - * description: The category id's $lte. - * x-schemaName: RegExp - * $like: - * type: string - * title: $like - * description: The category id's $like. - * $re: - * type: string - * title: $re - * description: The category id's $re. - * $ilike: - * type: string - * title: $ilike - * description: The category id's $ilike. - * $fulltext: - * type: string - * title: $fulltext - * description: The category id's $fulltext. - * $overlap: - * type: array - * description: The category id's $overlap. - * items: - * type: string - * title: $overlap - * description: The $overlap's details. - * $contains: - * type: array - * description: The category id's $contains. - * items: - * type: string - * title: $contains - * description: The $contain's $contains. - * $contained: - * type: array - * description: The category id's $contained. - * items: - * type: string - * title: $contained - * description: The $contained's details. - * $exists: - * type: boolean - * title: $exists - * description: The category id's $exists. - * categories: - * oneOf: - * - type: object - * description: The $or's categories. - * required: - * - id - * properties: - * id: - * type: object - * description: The category's ID. - * - type: object - * description: The $or's categories. - * required: - * - id - * properties: - * id: - * type: object - * description: The category's ID. - * collection_id: - * oneOf: - * - type: string - * title: collection_id - * description: The $or's collection id. - * - type: array - * description: The $or's collection id. - * items: - * type: string - * title: collection_id - * description: The collection id's details. - * - type: object - * description: The $or's collection id. - * properties: - * $and: - * type: array - * description: The collection id's $and. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * - type: object - * description: The $and's details. - * - type: array - * description: The $and's details. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * $or: - * type: array - * description: The collection id's $or. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * - type: object - * description: The $or's details. - * - type: array - * description: The $or's details. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The collection id's $eq. - * - type: object - * description: The collection id's $eq. - * x-schemaName: RegExp - * - type: array - * description: The collection id's $eq. - * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The collection id's $ne. - * - type: object - * description: The collection id's $ne. - * x-schemaName: RegExp - * $in: - * type: array - * description: The collection id's $in. - * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp - * $nin: - * type: array - * description: The collection id's $nin. - * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp - * $not: - * oneOf: - * - type: string - * title: $not - * description: The collection id's $not. - * - type: object - * description: The collection id's $not. - * x-schemaName: RegExp - * - type: object - * description: The collection id's $not. - * - type: array - * description: The collection id's $not. - * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The collection id's $gt. - * - type: object - * description: The collection id's $gt. - * x-schemaName: RegExp - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The collection id's $gte. - * - type: object - * description: The collection id's $gte. - * x-schemaName: RegExp - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The collection id's $lt. - * - type: object - * description: The collection id's $lt. - * x-schemaName: RegExp - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The collection id's $lte. - * - type: object - * description: The collection id's $lte. - * x-schemaName: RegExp - * $like: - * type: string - * title: $like - * description: The collection id's $like. - * $re: - * type: string - * title: $re - * description: The collection id's $re. - * $ilike: - * type: string - * title: $ilike - * description: The collection id's $ilike. - * $fulltext: - * type: string - * title: $fulltext - * description: The collection id's $fulltext. - * $overlap: - * type: array - * description: The collection id's $overlap. - * items: - * type: string - * title: $overlap - * description: The $overlap's details. - * $contains: - * type: array - * description: The collection id's $contains. - * items: - * type: string - * title: $contains - * description: The $contain's $contains. - * $contained: - * type: array - * description: The collection id's $contained. - * items: - * type: string - * title: $contained - * description: The $contained's details. - * $exists: - * type: boolean - * title: $exists - * description: The collection id's $exists. - * created_at: - * type: object - * description: The $or's created at. - * properties: - * $and: - * type: array - * description: The created at's $and. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * - type: object - * description: The $and's details. - * - type: array - * description: The $and's details. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * $or: - * type: array - * description: The created at's $or. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * - type: object - * description: The $or's details. - * - type: array - * description: The $or's details. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The created at's $eq. - * - type: object - * description: The created at's $eq. - * x-schemaName: RegExp - * - type: array - * description: The created at's $eq. - * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The created at's $ne. - * - type: object - * description: The created at's $ne. - * x-schemaName: RegExp - * $in: - * type: array - * description: The created at's $in. - * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp - * $nin: - * type: array - * description: The created at's $nin. - * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp - * $not: - * oneOf: - * - type: string - * title: $not - * description: The created at's $not. - * - type: object - * description: The created at's $not. - * x-schemaName: RegExp - * - type: object - * description: The created at's $not. - * - type: array - * description: The created at's $not. - * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The created at's $gt. - * - type: object - * description: The created at's $gt. - * x-schemaName: RegExp - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The created at's $gte. - * - type: object - * description: The created at's $gte. - * x-schemaName: RegExp - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The created at's $lt. - * - type: object - * description: The created at's $lt. - * x-schemaName: RegExp - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The created at's $lte. - * - type: object - * description: The created at's $lte. - * x-schemaName: RegExp - * $like: - * type: string - * title: $like - * description: The created at's $like. - * $re: - * type: string - * title: $re - * description: The created at's $re. - * $ilike: - * type: string - * title: $ilike - * description: The created at's $ilike. - * $fulltext: - * type: string - * title: $fulltext - * description: The created at's $fulltext. - * $overlap: - * type: array - * description: The created at's $overlap. - * items: - * type: string - * title: $overlap - * description: The $overlap's details. - * $contains: - * type: array - * description: The created at's $contains. - * items: - * type: string - * title: $contains - * description: The $contain's $contains. - * $contained: - * type: array - * description: The created at's $contained. - * items: - * type: string - * title: $contained - * description: The $contained's details. - * $exists: - * type: boolean - * title: $exists - * description: The created at's $exists. - * updated_at: - * type: object - * description: The $or's updated at. - * properties: - * $and: - * type: array - * description: The updated at's $and. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * - type: object - * description: The $and's details. - * - type: array - * description: The $and's details. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * $or: - * type: array - * description: The updated at's $or. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * - type: object - * description: The $or's details. - * - type: array - * description: The $or's details. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The updated at's $eq. - * - type: object - * description: The updated at's $eq. - * x-schemaName: RegExp - * - type: array - * description: The updated at's $eq. - * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The updated at's $ne. - * - type: object - * description: The updated at's $ne. - * x-schemaName: RegExp - * $in: - * type: array - * description: The updated at's $in. - * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp - * $nin: - * type: array - * description: The updated at's $nin. - * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp - * $not: - * oneOf: - * - type: string - * title: $not - * description: The updated at's $not. - * - type: object - * description: The updated at's $not. - * x-schemaName: RegExp - * - type: object - * description: The updated at's $not. - * - type: array - * description: The updated at's $not. - * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The updated at's $gt. - * - type: object - * description: The updated at's $gt. - * x-schemaName: RegExp - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The updated at's $gte. - * - type: object - * description: The updated at's $gte. - * x-schemaName: RegExp - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The updated at's $lt. - * - type: object - * description: The updated at's $lt. - * x-schemaName: RegExp - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The updated at's $lte. - * - type: object - * description: The updated at's $lte. - * x-schemaName: RegExp - * $like: - * type: string - * title: $like - * description: The updated at's $like. - * $re: - * type: string - * title: $re - * description: The updated at's $re. - * $ilike: - * type: string - * title: $ilike - * description: The updated at's $ilike. - * $fulltext: - * type: string - * title: $fulltext - * description: The updated at's $fulltext. - * $overlap: - * type: array - * description: The updated at's $overlap. - * items: - * type: string - * title: $overlap - * description: The $overlap's details. - * $contains: - * type: array - * description: The updated at's $contains. - * items: - * type: string - * title: $contains - * description: The $contain's $contains. - * $contained: - * type: array - * description: The updated at's $contained. - * items: - * type: string - * title: $contained - * description: The $contained's details. - * $exists: - * type: boolean - * title: $exists - * description: The updated at's $exists. - * deleted_at: - * type: object - * description: The $or's deleted at. - * properties: - * $and: - * type: array - * description: The deleted at's $and. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * - type: object - * description: The $and's details. - * - type: array - * description: The $and's details. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * $or: - * type: array - * description: The deleted at's $or. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * - type: object - * description: The $or's details. - * - type: array - * description: The $or's details. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The deleted at's $eq. - * - type: object - * description: The deleted at's $eq. - * x-schemaName: RegExp - * - type: array - * description: The deleted at's $eq. - * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The deleted at's $ne. - * - type: object - * description: The deleted at's $ne. - * x-schemaName: RegExp - * $in: - * type: array - * description: The deleted at's $in. - * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp - * $nin: - * type: array - * description: The deleted at's $nin. - * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp - * $not: - * oneOf: - * - type: string - * title: $not - * description: The deleted at's $not. - * - type: object - * description: The deleted at's $not. - * x-schemaName: RegExp - * - type: object - * description: The deleted at's $not. - * - type: array - * description: The deleted at's $not. - * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The deleted at's $gt. - * - type: object - * description: The deleted at's $gt. - * x-schemaName: RegExp - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The deleted at's $gte. - * - type: object - * description: The deleted at's $gte. - * x-schemaName: RegExp - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The deleted at's $lt. - * - type: object - * description: The deleted at's $lt. - * x-schemaName: RegExp - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The deleted at's $lte. - * - type: object - * description: The deleted at's $lte. - * x-schemaName: RegExp - * $like: - * type: string - * title: $like - * description: The deleted at's $like. - * $re: - * type: string - * title: $re - * description: The deleted at's $re. - * $ilike: - * type: string - * title: $ilike - * description: The deleted at's $ilike. - * $fulltext: - * type: string - * title: $fulltext - * description: The deleted at's $fulltext. - * $overlap: - * type: array - * description: The deleted at's $overlap. - * items: - * type: string - * title: $overlap - * description: The $overlap's details. - * $contains: - * type: array - * description: The deleted at's $contains. - * items: - * type: string - * title: $contains - * description: The $contain's $contains. - * $contained: - * type: array - * description: The deleted at's $contained. - * items: - * type: string - * title: $contained - * description: The $contained's details. - * $exists: - * type: boolean - * title: $exists - * description: The deleted at's $exists. - * limit: - * type: number - * title: limit - * description: The $or's limit. - * offset: - * type: number - * title: offset - * description: The $or's offset. - * order: - * type: string - * title: order - * description: The $or's order. - * fields: - * type: string - * title: fields - * description: The $or's fields. - * $and: - * type: array - * description: The $or's $and. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductListParams - * properties: - * q: - * type: string - * title: q - * description: The $and's q. - * status: - * oneOf: - * - type: string - * title: status - * description: The $and's status. - * - type: string - * title: status - * description: The $and's status. - * - type: string - * title: status - * description: The $and's status. - * - type: string - * title: status - * description: The $and's status. - * - type: array - * description: The $and's status. - * items: - * type: string - * enum: - * - draft - * - proposed - * - published - * - rejected - * sales_channel_id: - * oneOf: - * - type: string - * title: sales_channel_id - * description: The $and's sales channel id. - * - type: array - * description: The $and's sales channel id. - * items: - * type: string - * title: sales_channel_id - * description: The sales channel id's details. - * title: - * oneOf: - * - type: string - * title: title - * description: The $and's title. - * - type: array - * description: The $and's title. - * items: - * type: string - * title: title - * description: The title's details. - * handle: - * oneOf: - * - type: string - * title: handle - * description: The $and's handle. - * - type: array - * description: The $and's handle. - * items: - * type: string - * title: handle - * description: The handle's details. - * id: - * oneOf: - * - type: string - * title: id - * description: The $and's ID. - * - type: array - * description: The $and's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * is_giftcard: - * type: boolean - * title: is_giftcard - * description: The $and's is giftcard. - * tags: - * type: object - * description: The $and's tags. - * type_id: - * oneOf: - * - type: string - * title: type_id - * description: The $and's type id. - * - type: array - * description: The $and's type id. - * items: - * type: string - * title: type_id - * description: The type id's details. - * category_id: - * oneOf: - * - type: string - * title: category_id - * description: The $and's category id. - * - type: array - * description: The $and's category id. - * items: - * type: string - * title: category_id - * description: The category id's details. - * - type: object - * description: The $and's category id. - * categories: - * oneOf: - * - type: object - * description: The $and's categories. - * - type: object - * description: The $and's categories. - * collection_id: - * oneOf: - * - type: string - * title: collection_id - * description: The $and's collection id. - * - type: array - * description: The $and's collection id. - * items: - * type: string - * title: collection_id - * description: The collection id's details. - * - type: object - * description: The $and's collection id. - * created_at: - * type: object - * description: The $and's created at. - * updated_at: - * type: object - * description: The $and's updated at. - * deleted_at: - * type: object - * description: The $and's deleted at. - * limit: - * type: number - * title: limit - * description: The $and's limit. - * offset: - * type: number - * title: offset - * description: The $and's offset. - * order: - * type: string - * title: order - * description: The $and's order. - * fields: - * type: string - * title: fields - * description: The $and's fields. - * $and: - * type: array - * description: The $and's details. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductListParams - * - type: object - * description: The $and's details. - * $or: - * type: array - * description: The $and's $or. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductListParams - * - type: object - * description: The $or's details. - * - type: object - * description: The $and's details. - * properties: - * $and: - * type: array - * description: The $and's details. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductListParams - * - type: object - * description: The $and's details. - * $or: - * type: array - * description: The $and's $or. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductListParams - * - type: object - * description: The $or's details. - * $or: - * type: array - * description: The $or's details. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductListParams - * properties: - * q: - * type: string - * title: q - * description: The $or's q. - * status: - * oneOf: - * - type: string - * title: status - * description: The $or's status. - * - type: string - * title: status - * description: The $or's status. - * - type: string - * title: status - * description: The $or's status. - * - type: string - * title: status - * description: The $or's status. - * - type: array - * description: The $or's status. - * items: - * type: string - * enum: - * - draft - * - proposed - * - published - * - rejected - * sales_channel_id: - * oneOf: - * - type: string - * title: sales_channel_id - * description: The $or's sales channel id. - * - type: array - * description: The $or's sales channel id. - * items: - * type: string - * title: sales_channel_id - * description: The sales channel id's details. - * title: - * oneOf: - * - type: string - * title: title - * description: The $or's title. - * - type: array - * description: The $or's title. - * items: - * type: string - * title: title - * description: The title's details. - * handle: - * oneOf: - * - type: string - * title: handle - * description: The $or's handle. - * - type: array - * description: The $or's handle. - * items: - * type: string - * title: handle - * description: The handle's details. - * id: - * oneOf: - * - type: string - * title: id - * description: The $or's ID. - * - type: array - * description: The $or's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * is_giftcard: - * type: boolean - * title: is_giftcard - * description: The $or's is giftcard. - * tags: - * type: object - * description: The $or's tags. - * type_id: - * oneOf: - * - type: string - * title: type_id - * description: The $or's type id. - * - type: array - * description: The $or's type id. - * items: - * type: string - * title: type_id - * description: The type id's details. - * category_id: - * oneOf: - * - type: string - * title: category_id - * description: The $or's category id. - * - type: array - * description: The $or's category id. - * items: - * type: string - * title: category_id - * description: The category id's details. - * - type: object - * description: The $or's category id. - * categories: - * oneOf: - * - type: object - * description: The $or's categories. - * - type: object - * description: The $or's categories. - * collection_id: - * oneOf: - * - type: string - * title: collection_id - * description: The $or's collection id. - * - type: array - * description: The $or's collection id. - * items: - * type: string - * title: collection_id - * description: The collection id's details. - * - type: object - * description: The $or's collection id. - * created_at: - * type: object - * description: The $or's created at. - * updated_at: - * type: object - * description: The $or's updated at. - * deleted_at: - * type: object - * description: The $or's deleted at. - * limit: - * type: number - * title: limit - * description: The $or's limit. - * offset: - * type: number - * title: offset - * description: The $or's offset. - * order: - * type: string - * title: order - * description: The $or's order. - * fields: - * type: string - * title: fields - * description: The $or's fields. - * $and: - * type: array - * description: The $or's $and. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductListParams - * - type: object - * description: The $and's details. - * $or: - * type: array - * description: The $or's details. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductListParams - * - type: object - * description: The $or's details. - * - type: object - * description: The $or's details. - * properties: - * $and: - * type: array - * description: The $or's $and. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductListParams - * - type: object - * description: The $and's details. - * $or: - * type: array - * description: The $or's details. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductListParams - * - type: object - * description: The $or's details. - * - type: object - * description: The $or's details. - * properties: - * $and: - * type: array - * description: The $or's $and. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductListParams - * properties: - * q: - * type: string - * title: q - * description: The $and's q. - * status: - * oneOf: - * - type: string - * title: status - * description: The $and's status. - * - type: string - * title: status - * description: The $and's status. - * - type: string - * title: status - * description: The $and's status. - * - type: string - * title: status - * description: The $and's status. - * - type: array - * description: The $and's status. - * items: - * type: string - * enum: - * - draft - * - proposed - * - published - * - rejected - * sales_channel_id: - * oneOf: - * - type: string - * title: sales_channel_id - * description: The $and's sales channel id. - * - type: array - * description: The $and's sales channel id. - * items: - * type: string - * title: sales_channel_id - * description: The sales channel id's details. - * title: - * oneOf: - * - type: string - * title: title - * description: The $and's title. - * - type: array - * description: The $and's title. - * items: - * type: string - * title: title - * description: The title's details. - * handle: - * oneOf: - * - type: string - * title: handle - * description: The $and's handle. - * - type: array - * description: The $and's handle. - * items: - * type: string - * title: handle - * description: The handle's details. - * id: - * oneOf: - * - type: string - * title: id - * description: The $and's ID. - * - type: array - * description: The $and's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * is_giftcard: - * type: boolean - * title: is_giftcard - * description: The $and's is giftcard. - * tags: - * type: object - * description: The $and's tags. - * type_id: - * oneOf: - * - type: string - * title: type_id - * description: The $and's type id. - * - type: array - * description: The $and's type id. - * items: - * type: string - * title: type_id - * description: The type id's details. - * category_id: - * oneOf: - * - type: string - * title: category_id - * description: The $and's category id. - * - type: array - * description: The $and's category id. - * items: - * type: string - * title: category_id - * description: The category id's details. - * - type: object - * description: The $and's category id. - * categories: - * oneOf: - * - type: object - * description: The $and's categories. - * - type: object - * description: The $and's categories. - * collection_id: - * oneOf: - * - type: string - * title: collection_id - * description: The $and's collection id. - * - type: array - * description: The $and's collection id. - * items: - * type: string - * title: collection_id - * description: The collection id's details. - * - type: object - * description: The $and's collection id. - * created_at: - * type: object - * description: The $and's created at. - * updated_at: - * type: object - * description: The $and's updated at. - * deleted_at: - * type: object - * description: The $and's deleted at. - * limit: - * type: number - * title: limit - * description: The $and's limit. - * offset: - * type: number - * title: offset - * description: The $and's offset. - * order: - * type: string - * title: order - * description: The $and's order. - * fields: - * type: string - * title: fields - * description: The $and's fields. - * $and: - * type: array - * description: The $and's details. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductListParams - * - type: object - * description: The $and's details. - * $or: - * type: array - * description: The $and's $or. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductListParams - * - type: object - * description: The $or's details. - * - type: object - * description: The $and's details. - * properties: - * $and: - * type: array - * description: The $and's details. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductListParams - * - type: object - * description: The $and's details. - * $or: - * type: array - * description: The $and's $or. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductListParams - * - type: object - * description: The $or's details. - * $or: - * type: array - * description: The $or's details. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductListParams - * properties: - * q: - * type: string - * title: q - * description: The $or's q. - * status: - * oneOf: - * - type: string - * title: status - * description: The $or's status. - * - type: string - * title: status - * description: The $or's status. - * - type: string - * title: status - * description: The $or's status. - * - type: string - * title: status - * description: The $or's status. - * - type: array - * description: The $or's status. - * items: - * type: string - * enum: - * - draft - * - proposed - * - published - * - rejected - * sales_channel_id: - * oneOf: - * - type: string - * title: sales_channel_id - * description: The $or's sales channel id. - * - type: array - * description: The $or's sales channel id. - * items: - * type: string - * title: sales_channel_id - * description: The sales channel id's details. - * title: - * oneOf: - * - type: string - * title: title - * description: The $or's title. - * - type: array - * description: The $or's title. - * items: - * type: string - * title: title - * description: The title's details. - * handle: - * oneOf: - * - type: string - * title: handle - * description: The $or's handle. - * - type: array - * description: The $or's handle. - * items: - * type: string - * title: handle - * description: The handle's details. - * id: - * oneOf: - * - type: string - * title: id - * description: The $or's ID. - * - type: array - * description: The $or's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * is_giftcard: - * type: boolean - * title: is_giftcard - * description: The $or's is giftcard. - * tags: - * type: object - * description: The $or's tags. - * type_id: - * oneOf: - * - type: string - * title: type_id - * description: The $or's type id. - * - type: array - * description: The $or's type id. - * items: - * type: string - * title: type_id - * description: The type id's details. - * category_id: - * oneOf: - * - type: string - * title: category_id - * description: The $or's category id. - * - type: array - * description: The $or's category id. - * items: - * type: string - * title: category_id - * description: The category id's details. - * - type: object - * description: The $or's category id. - * categories: - * oneOf: - * - type: object - * description: The $or's categories. - * - type: object - * description: The $or's categories. - * collection_id: - * oneOf: - * - type: string - * title: collection_id - * description: The $or's collection id. - * - type: array - * description: The $or's collection id. - * items: - * type: string - * title: collection_id - * description: The collection id's details. - * - type: object - * description: The $or's collection id. - * created_at: - * type: object - * description: The $or's created at. - * updated_at: - * type: object - * description: The $or's updated at. - * deleted_at: - * type: object - * description: The $or's deleted at. - * limit: - * type: number - * title: limit - * description: The $or's limit. - * offset: - * type: number - * title: offset - * description: The $or's offset. - * order: - * type: string - * title: order - * description: The $or's order. - * fields: - * type: string - * title: fields - * description: The $or's fields. - * $and: - * type: array - * description: The $or's $and. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductListParams - * - type: object - * description: The $and's details. - * $or: - * type: array - * description: The $or's details. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductListParams - * - type: object - * description: The $or's details. - * - type: object - * description: The $or's details. - * properties: - * $and: - * type: array - * description: The $or's $and. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductListParams - * - type: object - * description: The $and's details. - * $or: - * type: array - * description: The $or's details. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductListParams - * - type: object - * description: The $or's details. * type: array * items: * type: object + * title: $or * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options.ts b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options.ts index 9cc6602f3d..485338089e 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options.ts @@ -120,490 +120,10 @@ * type: array * description: The product's $and. * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductOptionParams - * properties: - * q: - * type: string - * title: q - * description: The $and's q. - * id: - * oneOf: - * - type: string - * title: id - * description: The $and's ID. - * - type: array - * description: The $and's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * title: - * oneOf: - * - type: string - * title: title - * description: The $and's title. - * - type: array - * description: The $and's title. - * items: - * type: string - * title: title - * description: The title's details. - * product_id: - * oneOf: - * - type: string - * title: product_id - * description: The $and's product id. - * - type: array - * description: The $and's product id. - * items: - * type: string - * title: product_id - * description: The product id's details. - * limit: - * type: number - * title: limit - * description: The $and's limit. - * offset: - * type: number - * title: offset - * description: The $and's offset. - * order: - * type: string - * title: order - * description: The $and's order. - * fields: - * type: string - * title: fields - * description: The $and's fields. - * $and: - * type: array - * description: The $and's details. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductOptionParams - * properties: - * q: - * type: string - * title: q - * description: The $and's q. - * id: - * oneOf: - * - type: string - * title: id - * description: The $and's ID. - * - type: array - * description: The $and's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * title: - * oneOf: - * - type: string - * title: title - * description: The $and's title. - * - type: array - * description: The $and's title. - * items: - * type: string - * title: title - * description: The title's details. - * product_id: - * oneOf: - * - type: string - * title: product_id - * description: The $and's product id. - * - type: array - * description: The $and's product id. - * items: - * type: string - * title: product_id - * description: The product id's details. - * limit: - * type: number - * title: limit - * description: The $and's limit. - * offset: - * type: number - * title: offset - * description: The $and's offset. - * order: - * type: string - * title: order - * description: The $and's order. - * fields: - * type: string - * title: fields - * description: The $and's fields. - * $and: - * type: array - * description: The $and's details. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductOptionParams - * - type: object - * description: The $and's details. - * $or: - * type: array - * description: The $and's $or. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductOptionParams - * - type: object - * description: The $or's details. - * - type: object - * description: The $and's details. - * properties: - * $and: - * type: array - * description: The $and's details. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductOptionParams - * - type: object - * description: The $and's details. - * $or: - * type: array - * description: The $and's $or. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductOptionParams - * - type: object - * description: The $or's details. - * $or: - * type: array - * description: The $and's $or. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductOptionParams - * properties: - * q: - * type: string - * title: q - * description: The $or's q. - * id: - * oneOf: - * - type: string - * title: id - * description: The $or's ID. - * - type: array - * description: The $or's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * title: - * oneOf: - * - type: string - * title: title - * description: The $or's title. - * - type: array - * description: The $or's title. - * items: - * type: string - * title: title - * description: The title's details. - * product_id: - * oneOf: - * - type: string - * title: product_id - * description: The $or's product id. - * - type: array - * description: The $or's product id. - * items: - * type: string - * title: product_id - * description: The product id's details. - * limit: - * type: number - * title: limit - * description: The $or's limit. - * offset: - * type: number - * title: offset - * description: The $or's offset. - * order: - * type: string - * title: order - * description: The $or's order. - * fields: - * type: string - * title: fields - * description: The $or's fields. - * $and: - * type: array - * description: The $or's $and. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductOptionParams - * - type: object - * description: The $and's details. - * $or: - * type: array - * description: The $or's details. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductOptionParams - * - type: object - * description: The $or's details. - * - type: object - * description: The $or's details. - * properties: - * $and: - * type: array - * description: The $or's $and. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductOptionParams - * - type: object - * description: The $and's details. - * $or: - * type: array - * description: The $or's details. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductOptionParams - * - type: object - * description: The $or's details. - * - type: object - * description: The $and's details. - * properties: - * $and: - * type: array - * description: The $and's details. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductOptionParams - * properties: - * q: - * type: string - * title: q - * description: The $and's q. - * id: - * oneOf: - * - type: string - * title: id - * description: The $and's ID. - * - type: array - * description: The $and's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * title: - * oneOf: - * - type: string - * title: title - * description: The $and's title. - * - type: array - * description: The $and's title. - * items: - * type: string - * title: title - * description: The title's details. - * product_id: - * oneOf: - * - type: string - * title: product_id - * description: The $and's product id. - * - type: array - * description: The $and's product id. - * items: - * type: string - * title: product_id - * description: The product id's details. - * limit: - * type: number - * title: limit - * description: The $and's limit. - * offset: - * type: number - * title: offset - * description: The $and's offset. - * order: - * type: string - * title: order - * description: The $and's order. - * fields: - * type: string - * title: fields - * description: The $and's fields. - * $and: - * type: array - * description: The $and's details. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductOptionParams - * - type: object - * description: The $and's details. - * $or: - * type: array - * description: The $and's $or. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductOptionParams - * - type: object - * description: The $or's details. - * - type: object - * description: The $and's details. - * properties: - * $and: - * type: array - * description: The $and's details. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductOptionParams - * - type: object - * description: The $and's details. - * $or: - * type: array - * description: The $and's $or. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductOptionParams - * - type: object - * description: The $or's details. - * $or: - * type: array - * description: The $and's $or. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductOptionParams - * properties: - * q: - * type: string - * title: q - * description: The $or's q. - * id: - * oneOf: - * - type: string - * title: id - * description: The $or's ID. - * - type: array - * description: The $or's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * title: - * oneOf: - * - type: string - * title: title - * description: The $or's title. - * - type: array - * description: The $or's title. - * items: - * type: string - * title: title - * description: The title's details. - * product_id: - * oneOf: - * - type: string - * title: product_id - * description: The $or's product id. - * - type: array - * description: The $or's product id. - * items: - * type: string - * title: product_id - * description: The product id's details. - * limit: - * type: number - * title: limit - * description: The $or's limit. - * offset: - * type: number - * title: offset - * description: The $or's offset. - * order: - * type: string - * title: order - * description: The $or's order. - * fields: - * type: string - * title: fields - * description: The $or's fields. - * $and: - * type: array - * description: The $or's $and. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductOptionParams - * - type: object - * description: The $and's details. - * $or: - * type: array - * description: The $or's details. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductOptionParams - * - type: object - * description: The $or's details. - * - type: object - * description: The $or's details. - * properties: - * $and: - * type: array - * description: The $or's $and. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductOptionParams - * - type: object - * description: The $and's details. - * $or: - * type: array - * description: The $or's details. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductOptionParams - * - type: object - * description: The $or's details. * type: array * items: * type: object + * title: $and * - name: $or * in: query * description: The product's $or. @@ -612,490 +132,10 @@ * type: array * description: The product's $or. * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductOptionParams - * properties: - * q: - * type: string - * title: q - * description: The $or's q. - * id: - * oneOf: - * - type: string - * title: id - * description: The $or's ID. - * - type: array - * description: The $or's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * title: - * oneOf: - * - type: string - * title: title - * description: The $or's title. - * - type: array - * description: The $or's title. - * items: - * type: string - * title: title - * description: The title's details. - * product_id: - * oneOf: - * - type: string - * title: product_id - * description: The $or's product id. - * - type: array - * description: The $or's product id. - * items: - * type: string - * title: product_id - * description: The product id's details. - * limit: - * type: number - * title: limit - * description: The $or's limit. - * offset: - * type: number - * title: offset - * description: The $or's offset. - * order: - * type: string - * title: order - * description: The $or's order. - * fields: - * type: string - * title: fields - * description: The $or's fields. - * $and: - * type: array - * description: The $or's $and. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductOptionParams - * properties: - * q: - * type: string - * title: q - * description: The $and's q. - * id: - * oneOf: - * - type: string - * title: id - * description: The $and's ID. - * - type: array - * description: The $and's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * title: - * oneOf: - * - type: string - * title: title - * description: The $and's title. - * - type: array - * description: The $and's title. - * items: - * type: string - * title: title - * description: The title's details. - * product_id: - * oneOf: - * - type: string - * title: product_id - * description: The $and's product id. - * - type: array - * description: The $and's product id. - * items: - * type: string - * title: product_id - * description: The product id's details. - * limit: - * type: number - * title: limit - * description: The $and's limit. - * offset: - * type: number - * title: offset - * description: The $and's offset. - * order: - * type: string - * title: order - * description: The $and's order. - * fields: - * type: string - * title: fields - * description: The $and's fields. - * $and: - * type: array - * description: The $and's details. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductOptionParams - * - type: object - * description: The $and's details. - * $or: - * type: array - * description: The $and's $or. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductOptionParams - * - type: object - * description: The $or's details. - * - type: object - * description: The $and's details. - * properties: - * $and: - * type: array - * description: The $and's details. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductOptionParams - * - type: object - * description: The $and's details. - * $or: - * type: array - * description: The $and's $or. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductOptionParams - * - type: object - * description: The $or's details. - * $or: - * type: array - * description: The $or's details. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductOptionParams - * properties: - * q: - * type: string - * title: q - * description: The $or's q. - * id: - * oneOf: - * - type: string - * title: id - * description: The $or's ID. - * - type: array - * description: The $or's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * title: - * oneOf: - * - type: string - * title: title - * description: The $or's title. - * - type: array - * description: The $or's title. - * items: - * type: string - * title: title - * description: The title's details. - * product_id: - * oneOf: - * - type: string - * title: product_id - * description: The $or's product id. - * - type: array - * description: The $or's product id. - * items: - * type: string - * title: product_id - * description: The product id's details. - * limit: - * type: number - * title: limit - * description: The $or's limit. - * offset: - * type: number - * title: offset - * description: The $or's offset. - * order: - * type: string - * title: order - * description: The $or's order. - * fields: - * type: string - * title: fields - * description: The $or's fields. - * $and: - * type: array - * description: The $or's $and. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductOptionParams - * - type: object - * description: The $and's details. - * $or: - * type: array - * description: The $or's details. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductOptionParams - * - type: object - * description: The $or's details. - * - type: object - * description: The $or's details. - * properties: - * $and: - * type: array - * description: The $or's $and. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductOptionParams - * - type: object - * description: The $and's details. - * $or: - * type: array - * description: The $or's details. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductOptionParams - * - type: object - * description: The $or's details. - * - type: object - * description: The $or's details. - * properties: - * $and: - * type: array - * description: The $or's $and. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductOptionParams - * properties: - * q: - * type: string - * title: q - * description: The $and's q. - * id: - * oneOf: - * - type: string - * title: id - * description: The $and's ID. - * - type: array - * description: The $and's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * title: - * oneOf: - * - type: string - * title: title - * description: The $and's title. - * - type: array - * description: The $and's title. - * items: - * type: string - * title: title - * description: The title's details. - * product_id: - * oneOf: - * - type: string - * title: product_id - * description: The $and's product id. - * - type: array - * description: The $and's product id. - * items: - * type: string - * title: product_id - * description: The product id's details. - * limit: - * type: number - * title: limit - * description: The $and's limit. - * offset: - * type: number - * title: offset - * description: The $and's offset. - * order: - * type: string - * title: order - * description: The $and's order. - * fields: - * type: string - * title: fields - * description: The $and's fields. - * $and: - * type: array - * description: The $and's details. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductOptionParams - * - type: object - * description: The $and's details. - * $or: - * type: array - * description: The $and's $or. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductOptionParams - * - type: object - * description: The $or's details. - * - type: object - * description: The $and's details. - * properties: - * $and: - * type: array - * description: The $and's details. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductOptionParams - * - type: object - * description: The $and's details. - * $or: - * type: array - * description: The $and's $or. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductOptionParams - * - type: object - * description: The $or's details. - * $or: - * type: array - * description: The $or's details. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductOptionParams - * properties: - * q: - * type: string - * title: q - * description: The $or's q. - * id: - * oneOf: - * - type: string - * title: id - * description: The $or's ID. - * - type: array - * description: The $or's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * title: - * oneOf: - * - type: string - * title: title - * description: The $or's title. - * - type: array - * description: The $or's title. - * items: - * type: string - * title: title - * description: The title's details. - * product_id: - * oneOf: - * - type: string - * title: product_id - * description: The $or's product id. - * - type: array - * description: The $or's product id. - * items: - * type: string - * title: product_id - * description: The product id's details. - * limit: - * type: number - * title: limit - * description: The $or's limit. - * offset: - * type: number - * title: offset - * description: The $or's offset. - * order: - * type: string - * title: order - * description: The $or's order. - * fields: - * type: string - * title: fields - * description: The $or's fields. - * $and: - * type: array - * description: The $or's $and. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductOptionParams - * - type: object - * description: The $and's details. - * $or: - * type: array - * description: The $or's details. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductOptionParams - * - type: object - * description: The $or's details. - * - type: object - * description: The $or's details. - * properties: - * $and: - * type: array - * description: The $or's $and. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductOptionParams - * - type: object - * description: The $and's details. - * $or: - * type: array - * description: The $or's details. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductOptionParams - * - type: object - * description: The $or's details. * type: array * items: * type: object + * title: $or * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns.ts b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns.ts index 0bbbc93391..81d7040950 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns.ts @@ -63,64 +63,82 @@ * content: * application/json: * schema: - * description: SUMMARY - * properties: - * name: - * type: string - * title: name - * description: The campaign's name. - * campaign_identifier: - * type: string - * title: campaign_identifier - * description: The campaign's campaign identifier. - * description: - * type: string - * title: description - * description: The campaign's description. - * budget: - * type: object - * description: The campaign's budget. + * allOf: + * - type: object + * description: SUMMARY * required: - * - type - * - limit - * - currency_code + * - name + * - campaign_identifier + * - description + * - budget + * - starts_at + * - ends_at * properties: - * type: + * name: * type: string - * enum: - * - spend - * - usage - * limit: - * type: number - * title: limit - * description: The budget's limit. - * currency_code: + * title: name + * description: The campaign's name. + * campaign_identifier: * type: string - * title: currency_code - * description: The budget's currency code. - * starts_at: - * type: string - * title: starts_at - * description: The campaign's starts at. - * format: date-time - * ends_at: - * type: string - * title: ends_at - * description: The campaign's ends at. - * format: date-time - * promotions: - * type: array - * description: The campaign's promotions. - * items: - * type: object - * description: The promotion's promotions. - * required: - * - id - * properties: - * id: - * type: string - * title: id - * description: The promotion's ID. + * title: campaign_identifier + * description: The campaign's campaign identifier. + * description: + * type: string + * title: description + * description: The campaign's description. + * budget: + * type: object + * description: The campaign's budget. + * required: + * - type + * - limit + * - currency_code + * properties: + * type: + * type: string + * enum: + * - spend + * - usage + * limit: + * type: number + * title: limit + * description: The budget's limit. + * currency_code: + * type: string + * title: currency_code + * description: The budget's currency code. + * starts_at: + * type: string + * title: starts_at + * description: The campaign's starts at. + * format: date-time + * ends_at: + * type: string + * title: ends_at + * description: The campaign's ends at. + * format: date-time + * promotions: + * type: array + * description: The campaign's promotions. + * items: + * type: object + * description: The promotion's promotions. + * required: + * - id + * properties: + * id: + * type: string + * title: id + * description: The promotion's ID. + * - type: object + * description: SUMMARY + * properties: + * additional_data: + * type: object + * description: Pass additional custom data to the API route. This data is passed + * to the underlying workflow under the `additional_data` + * parameter. + * description: SUMMARY * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id].ts index b842a5c430..486abb3814 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id].ts @@ -69,53 +69,68 @@ * content: * application/json: * schema: - * description: SUMMARY - * properties: - * name: - * type: string - * title: name - * description: The campaign's name. - * campaign_identifier: - * type: string - * title: campaign_identifier - * description: The campaign's campaign identifier. - * description: - * type: string - * title: description - * description: The campaign's description. - * budget: - * type: object - * description: The campaign's budget. + * allOf: + * - type: object + * description: SUMMARY * required: - * - limit + * - description + * - starts_at + * - ends_at * properties: - * limit: - * type: number - * title: limit - * description: The budget's limit. - * starts_at: - * type: string - * title: starts_at - * description: The campaign's starts at. - * format: date-time - * ends_at: - * type: string - * title: ends_at - * description: The campaign's ends at. - * format: date-time - * promotions: - * type: array - * description: The campaign's promotions. - * items: - * type: object - * description: The promotion's promotions. - * required: - * - id - * properties: - * id: - * type: string - * title: id - * description: The promotion's ID. + * name: + * type: string + * title: name + * description: The campaign's name. + * campaign_identifier: + * type: string + * title: campaign_identifier + * description: The campaign's campaign identifier. + * description: + * type: string + * title: description + * description: The campaign's description. + * budget: + * type: object + * description: The campaign's budget. + * required: + * - limit + * properties: + * limit: + * type: number + * title: limit + * description: The budget's limit. + * starts_at: + * type: string + * title: starts_at + * description: The campaign's starts at. + * format: date-time + * ends_at: + * type: string + * title: ends_at + * description: The campaign's ends at. + * format: date-time + * promotions: + * type: array + * description: The campaign's promotions. + * items: + * type: object + * description: The promotion's promotions. + * required: + * - id + * properties: + * id: + * type: string + * title: id + * description: The promotion's ID. + * - type: object + * description: SUMMARY + * properties: + * additional_data: + * type: object + * description: Pass additional custom data to the API route. This data is passed + * to the underlying workflow under the `additional_data` + * parameter. + * description: SUMMARY * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customers.ts b/www/utils/generated/oas-output/operations/admin/post_admin_customers.ts index 55d5524c4f..0d5e7ab719 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customers.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customers.ts @@ -63,32 +63,50 @@ * content: * application/json: * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - email + * - company_name + * - first_name + * - last_name + * - phone + * - metadata + * properties: + * email: + * type: string + * title: email + * description: The customer's email. + * format: email + * company_name: + * type: string + * title: company_name + * description: The customer's company name. + * first_name: + * type: string + * title: first_name + * description: The customer's first name. + * last_name: + * type: string + * title: last_name + * description: The customer's last name. + * phone: + * type: string + * title: phone + * description: The customer's phone. + * metadata: + * type: object + * description: The customer's metadata. + * - type: object + * description: SUMMARY + * properties: + * additional_data: + * type: object + * description: Pass additional custom data to the API route. This data is passed + * to the underlying workflow under the `additional_data` + * parameter. * description: SUMMARY - * properties: - * email: - * type: string - * title: email - * description: The customer's email. - * format: email - * company_name: - * type: string - * title: company_name - * description: The customer's company name. - * first_name: - * type: string - * title: first_name - * description: The customer's first name. - * last_name: - * type: string - * title: last_name - * description: The customer's last name. - * phone: - * type: string - * title: phone - * description: The customer's phone. - * metadata: - * type: object - * description: The customer's metadata. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id].ts index 4b2d460be3..bc3ece80c0 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id].ts @@ -69,32 +69,50 @@ * content: * application/json: * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - email + * - company_name + * - first_name + * - last_name + * - phone + * - metadata + * properties: + * email: + * type: string + * title: email + * description: The customer's email. + * format: email + * company_name: + * type: string + * title: company_name + * description: The customer's company name. + * first_name: + * type: string + * title: first_name + * description: The customer's first name. + * last_name: + * type: string + * title: last_name + * description: The customer's last name. + * phone: + * type: string + * title: phone + * description: The customer's phone. + * metadata: + * type: object + * description: The customer's metadata. + * - type: object + * description: SUMMARY + * properties: + * additional_data: + * type: object + * description: Pass additional custom data to the API route. This data is passed + * to the underlying workflow under the `additional_data` + * parameter. * description: SUMMARY - * properties: - * email: - * type: string - * title: email - * description: The customer's email. - * format: email - * company_name: - * type: string - * title: company_name - * description: The customer's company name. - * first_name: - * type: string - * title: first_name - * description: The customer's first name. - * last_name: - * type: string - * title: last_name - * description: The customer's last name. - * phone: - * type: string - * title: phone - * description: The customer's phone. - * metadata: - * type: object - * description: The customer's metadata. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts index bb2af1c77c..63aee37f43 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts @@ -69,63 +69,87 @@ * content: * application/json: * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - address_name + * - company + * - first_name + * - last_name + * - address_1 + * - address_2 + * - city + * - country_code + * - province + * - postal_code + * - phone + * - metadata + * properties: + * address_name: + * type: string + * title: address_name + * description: The customer's address name. + * is_default_shipping: + * type: boolean + * title: is_default_shipping + * description: The customer's is default shipping. + * is_default_billing: + * type: boolean + * title: is_default_billing + * description: The customer's is default billing. + * company: + * type: string + * title: company + * description: The customer's company. + * first_name: + * type: string + * title: first_name + * description: The customer's first name. + * last_name: + * type: string + * title: last_name + * description: The customer's last name. + * address_1: + * type: string + * title: address_1 + * description: The customer's address 1. + * address_2: + * type: string + * title: address_2 + * description: The customer's address 2. + * city: + * type: string + * title: city + * description: The customer's city. + * country_code: + * type: string + * title: country_code + * description: The customer's country code. + * province: + * type: string + * title: province + * description: The customer's province. + * postal_code: + * type: string + * title: postal_code + * description: The customer's postal code. + * phone: + * type: string + * title: phone + * description: The customer's phone. + * metadata: + * type: object + * description: The customer's metadata. + * - type: object + * description: SUMMARY + * properties: + * additional_data: + * type: object + * description: Pass additional custom data to the API route. This data is passed + * to the underlying workflow under the `additional_data` + * parameter. * description: SUMMARY - * properties: - * address_name: - * type: string - * title: address_name - * description: The customer's address name. - * is_default_shipping: - * type: boolean - * title: is_default_shipping - * description: The customer's is default shipping. - * is_default_billing: - * type: boolean - * title: is_default_billing - * description: The customer's is default billing. - * company: - * type: string - * title: company - * description: The customer's company. - * first_name: - * type: string - * title: first_name - * description: The customer's first name. - * last_name: - * type: string - * title: last_name - * description: The customer's last name. - * address_1: - * type: string - * title: address_1 - * description: The customer's address 1. - * address_2: - * type: string - * title: address_2 - * description: The customer's address 2. - * city: - * type: string - * title: city - * description: The customer's city. - * country_code: - * type: string - * title: country_code - * description: The customer's country code. - * province: - * type: string - * title: province - * description: The customer's province. - * postal_code: - * type: string - * title: postal_code - * description: The customer's postal code. - * phone: - * type: string - * title: phone - * description: The customer's phone. - * metadata: - * type: object - * description: The customer's metadata. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts index 15bd78340d..2211b7e30e 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts @@ -75,63 +75,87 @@ * content: * application/json: * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - address_name + * - company + * - first_name + * - last_name + * - address_1 + * - address_2 + * - city + * - country_code + * - province + * - postal_code + * - phone + * - metadata + * properties: + * address_name: + * type: string + * title: address_name + * description: The customer's address name. + * is_default_shipping: + * type: boolean + * title: is_default_shipping + * description: The customer's is default shipping. + * is_default_billing: + * type: boolean + * title: is_default_billing + * description: The customer's is default billing. + * company: + * type: string + * title: company + * description: The customer's company. + * first_name: + * type: string + * title: first_name + * description: The customer's first name. + * last_name: + * type: string + * title: last_name + * description: The customer's last name. + * address_1: + * type: string + * title: address_1 + * description: The customer's address 1. + * address_2: + * type: string + * title: address_2 + * description: The customer's address 2. + * city: + * type: string + * title: city + * description: The customer's city. + * country_code: + * type: string + * title: country_code + * description: The customer's country code. + * province: + * type: string + * title: province + * description: The customer's province. + * postal_code: + * type: string + * title: postal_code + * description: The customer's postal code. + * phone: + * type: string + * title: phone + * description: The customer's phone. + * metadata: + * type: object + * description: The customer's metadata. + * - type: object + * description: SUMMARY + * properties: + * additional_data: + * type: object + * description: Pass additional custom data to the API route. This data is passed + * to the underlying workflow under the `additional_data` + * parameter. * description: SUMMARY - * properties: - * address_name: - * type: string - * title: address_name - * description: The customer's address name. - * is_default_shipping: - * type: boolean - * title: is_default_shipping - * description: The customer's is default shipping. - * is_default_billing: - * type: boolean - * title: is_default_billing - * description: The customer's is default billing. - * company: - * type: string - * title: company - * description: The customer's company. - * first_name: - * type: string - * title: first_name - * description: The customer's first name. - * last_name: - * type: string - * title: last_name - * description: The customer's last name. - * address_1: - * type: string - * title: address_1 - * description: The customer's address 1. - * address_2: - * type: string - * title: address_2 - * description: The customer's address 2. - * city: - * type: string - * title: city - * description: The customer's city. - * country_code: - * type: string - * title: country_code - * description: The customer's country code. - * province: - * type: string - * title: province - * description: The customer's province. - * postal_code: - * type: string - * title: postal_code - * description: The customer's postal code. - * phone: - * type: string - * title: phone - * description: The customer's phone. - * metadata: - * type: object - * description: The customer's metadata. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders.ts b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders.ts index 379d12eae3..c773570326 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders.ts @@ -63,279 +63,298 @@ * content: * application/json: * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - sales_channel_id + * - email + * - customer_id + * - region_id + * - currency_code + * - shipping_methods + * - metadata + * properties: + * status: + * type: boolean + * title: status + * description: The draft order's status. + * sales_channel_id: + * type: string + * title: sales_channel_id + * description: The draft order's sales channel id. + * email: + * type: string + * title: email + * description: The draft order's email. + * format: email + * customer_id: + * type: string + * title: customer_id + * description: The draft order's customer id. + * billing_address: + * type: object + * description: The draft order's billing address. + * required: + * - first_name + * - last_name + * - phone + * - company + * - address_1 + * - address_2 + * - city + * - country_code + * - province + * - postal_code + * - metadata + * properties: + * first_name: + * type: string + * title: first_name + * description: The billing address's first name. + * last_name: + * type: string + * title: last_name + * description: The billing address's last name. + * phone: + * type: string + * title: phone + * description: The billing address's phone. + * company: + * type: string + * title: company + * description: The billing address's company. + * address_1: + * type: string + * title: address_1 + * description: The billing address's address 1. + * address_2: + * type: string + * title: address_2 + * description: The billing address's address 2. + * city: + * type: string + * title: city + * description: The billing address's city. + * country_code: + * type: string + * title: country_code + * description: The billing address's country code. + * province: + * type: string + * title: province + * description: The billing address's province. + * postal_code: + * type: string + * title: postal_code + * description: The billing address's postal code. + * metadata: + * type: object + * description: The billing address's metadata. + * shipping_address: + * type: object + * description: The draft order's shipping address. + * required: + * - first_name + * - last_name + * - phone + * - company + * - address_1 + * - address_2 + * - city + * - country_code + * - province + * - postal_code + * - metadata + * properties: + * first_name: + * type: string + * title: first_name + * description: The shipping address's first name. + * last_name: + * type: string + * title: last_name + * description: The shipping address's last name. + * phone: + * type: string + * title: phone + * description: The shipping address's phone. + * company: + * type: string + * title: company + * description: The shipping address's company. + * address_1: + * type: string + * title: address_1 + * description: The shipping address's address 1. + * address_2: + * type: string + * title: address_2 + * description: The shipping address's address 2. + * city: + * type: string + * title: city + * description: The shipping address's city. + * country_code: + * type: string + * title: country_code + * description: The shipping address's country code. + * province: + * type: string + * title: province + * description: The shipping address's province. + * postal_code: + * type: string + * title: postal_code + * description: The shipping address's postal code. + * metadata: + * type: object + * description: The shipping address's metadata. + * items: + * type: array + * description: The draft order's items. + * items: + * type: object + * description: The item's items. + * required: + * - title + * - sku + * - barcode + * - variant_id + * - unit_price + * - quantity + * - metadata + * properties: + * title: + * type: string + * title: title + * description: The item's title. + * sku: + * type: string + * title: sku + * description: The item's sku. + * barcode: + * type: string + * title: barcode + * description: The item's barcode. + * variant_id: + * type: string + * title: variant_id + * description: The item's variant id. + * unit_price: + * oneOf: + * - type: string + * title: unit_price + * description: The item's unit price. + * - type: number + * title: unit_price + * description: The item's unit price. + * - type: object + * description: The item's unit price. + * required: + * - value + * - precision + * properties: + * value: + * type: string + * title: value + * description: The unit price's value. + * precision: + * type: number + * title: precision + * description: The unit price's precision. + * quantity: + * type: number + * title: quantity + * description: The item's quantity. + * metadata: + * type: object + * description: The item's metadata. + * region_id: + * type: string + * title: region_id + * description: The draft order's region id. + * promo_codes: + * type: array + * description: The draft order's promo codes. + * items: + * type: string + * title: promo_codes + * description: The promo code's promo codes. + * currency_code: + * type: string + * title: currency_code + * description: The draft order's currency code. + * no_notification_order: + * type: boolean + * title: no_notification_order + * description: The draft order's no notification order. + * shipping_methods: + * type: array + * description: The draft order's shipping methods. + * items: + * type: object + * description: The shipping method's shipping methods. + * required: + * - shipping_method_id + * - order_id + * - name + * - option_id + * - amount + * properties: + * shipping_method_id: + * type: string + * title: shipping_method_id + * description: The shipping method's shipping method id. + * order_id: + * type: string + * title: order_id + * description: The shipping method's order id. + * name: + * type: string + * title: name + * description: The shipping method's name. + * option_id: + * type: string + * title: option_id + * description: The shipping method's option id. + * data: + * type: object + * description: The shipping method's data. + * amount: + * oneOf: + * - type: string + * title: amount + * description: The shipping method's amount. + * - type: number + * title: amount + * description: The shipping method's amount. + * - type: object + * description: The shipping method's amount. + * required: + * - value + * - precision + * properties: + * value: + * type: string + * title: value + * description: The amount's value. + * precision: + * type: number + * title: precision + * description: The amount's precision. + * metadata: + * type: object + * description: The draft order's metadata. + * - type: object + * description: SUMMARY + * properties: + * additional_data: + * type: object + * description: Pass additional custom data to the API route. This data is passed + * to the underlying workflow under the `additional_data` + * parameter. * description: SUMMARY - * properties: - * status: - * type: boolean - * title: status - * description: The draft order's status. - * sales_channel_id: - * type: string - * title: sales_channel_id - * description: The draft order's sales channel id. - * email: - * type: string - * title: email - * description: The draft order's email. - * format: email - * customer_id: - * type: string - * title: customer_id - * description: The draft order's customer id. - * billing_address: - * type: object - * description: The draft order's billing address. - * required: - * - first_name - * - last_name - * - phone - * - company - * - address_1 - * - address_2 - * - city - * - country_code - * - province - * - postal_code - * - metadata - * properties: - * first_name: - * type: string - * title: first_name - * description: The billing address's first name. - * last_name: - * type: string - * title: last_name - * description: The billing address's last name. - * phone: - * type: string - * title: phone - * description: The billing address's phone. - * company: - * type: string - * title: company - * description: The billing address's company. - * address_1: - * type: string - * title: address_1 - * description: The billing address's address 1. - * address_2: - * type: string - * title: address_2 - * description: The billing address's address 2. - * city: - * type: string - * title: city - * description: The billing address's city. - * country_code: - * type: string - * title: country_code - * description: The billing address's country code. - * province: - * type: string - * title: province - * description: The billing address's province. - * postal_code: - * type: string - * title: postal_code - * description: The billing address's postal code. - * metadata: - * type: object - * description: The billing address's metadata. - * shipping_address: - * type: object - * description: The draft order's shipping address. - * required: - * - first_name - * - last_name - * - phone - * - company - * - address_1 - * - address_2 - * - city - * - country_code - * - province - * - postal_code - * - metadata - * properties: - * first_name: - * type: string - * title: first_name - * description: The shipping address's first name. - * last_name: - * type: string - * title: last_name - * description: The shipping address's last name. - * phone: - * type: string - * title: phone - * description: The shipping address's phone. - * company: - * type: string - * title: company - * description: The shipping address's company. - * address_1: - * type: string - * title: address_1 - * description: The shipping address's address 1. - * address_2: - * type: string - * title: address_2 - * description: The shipping address's address 2. - * city: - * type: string - * title: city - * description: The shipping address's city. - * country_code: - * type: string - * title: country_code - * description: The shipping address's country code. - * province: - * type: string - * title: province - * description: The shipping address's province. - * postal_code: - * type: string - * title: postal_code - * description: The shipping address's postal code. - * metadata: - * type: object - * description: The shipping address's metadata. - * items: - * type: array - * description: The draft order's items. - * items: - * type: object - * description: The item's items. - * required: - * - title - * - sku - * - barcode - * - variant_id - * - unit_price - * - quantity - * - metadata - * properties: - * title: - * type: string - * title: title - * description: The item's title. - * sku: - * type: string - * title: sku - * description: The item's sku. - * barcode: - * type: string - * title: barcode - * description: The item's barcode. - * variant_id: - * type: string - * title: variant_id - * description: The item's variant id. - * unit_price: - * oneOf: - * - type: string - * title: unit_price - * description: The item's unit price. - * - type: number - * title: unit_price - * description: The item's unit price. - * - type: object - * description: The item's unit price. - * required: - * - value - * - precision - * properties: - * value: - * type: string - * title: value - * description: The unit price's value. - * precision: - * type: number - * title: precision - * description: The unit price's precision. - * quantity: - * type: number - * title: quantity - * description: The item's quantity. - * metadata: - * type: object - * description: The item's metadata. - * region_id: - * type: string - * title: region_id - * description: The draft order's region id. - * promo_codes: - * type: array - * description: The draft order's promo codes. - * items: - * type: string - * title: promo_codes - * description: The promo code's promo codes. - * currency_code: - * type: string - * title: currency_code - * description: The draft order's currency code. - * no_notification_order: - * type: boolean - * title: no_notification_order - * description: The draft order's no notification order. - * shipping_methods: - * type: array - * description: The draft order's shipping methods. - * items: - * type: object - * description: The shipping method's shipping methods. - * required: - * - shipping_method_id - * - order_id - * - name - * - option_id - * - amount - * properties: - * shipping_method_id: - * type: string - * title: shipping_method_id - * description: The shipping method's shipping method id. - * order_id: - * type: string - * title: order_id - * description: The shipping method's order id. - * name: - * type: string - * title: name - * description: The shipping method's name. - * option_id: - * type: string - * title: option_id - * description: The shipping method's option id. - * data: - * type: object - * description: The shipping method's data. - * amount: - * oneOf: - * - type: string - * title: amount - * description: The shipping method's amount. - * - type: number - * title: amount - * description: The shipping method's amount. - * - type: object - * description: The shipping method's amount. - * required: - * - value - * - precision - * properties: - * value: - * type: string - * title: value - * description: The amount's value. - * precision: - * type: number - * title: precision - * description: The amount's precision. - * metadata: - * type: object - * description: The draft order's metadata. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits.ts b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits.ts index dd65c58bac..e255a33706 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits.ts @@ -15,18 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_confirm.ts b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_confirm.ts index 6fc1f3676c..938e2c71d9 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_confirm.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_confirm.ts @@ -21,18 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -93,6 +93,10 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: confirmOrderEditRequestWorkflow + * requestBody: + * content: + * application/json: + * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items.ts index f72ddb3ecc..7ecfc8bb72 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items.ts @@ -21,18 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items_[action_id].ts index cf6a42205e..86b11621ac 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items_[action_id].ts @@ -27,18 +27,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_shipping-method.ts b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_shipping-method.ts index 36c25d3e65..e9203e6494 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_shipping-method.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_shipping-method.ts @@ -21,18 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_shipping-method_[action_id].ts index a622de5d95..b4cc1096f3 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_shipping-method_[action_id].ts @@ -27,18 +27,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_complete.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_complete.ts index 45eeb32d39..ae566eaf9d 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_complete.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_complete.ts @@ -69,12 +69,25 @@ * content: * application/json: * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - order_id + * properties: + * order_id: + * type: string + * title: order_id + * description: The order's order id. + * - type: object + * description: SUMMARY + * properties: + * additional_data: + * type: object + * description: Pass additional custom data to the API route. This data is passed + * to the underlying workflow under the `additional_data` + * parameter. * description: SUMMARY - * properties: - * order_id: - * type: string - * title: order_id - * description: The order's order id. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments.ts index e8ceba35ad..5eee660528 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments.ts @@ -69,37 +69,52 @@ * content: * application/json: * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - items + * - location_id + * - metadata + * properties: + * items: + * type: array + * description: The order's items. + * items: + * type: object + * description: The item's items. + * required: + * - id + * - quantity + * properties: + * id: + * type: string + * title: id + * description: The item's ID. + * quantity: + * type: number + * title: quantity + * description: The item's quantity. + * location_id: + * type: string + * title: location_id + * description: The order's location id. + * no_notification: + * type: boolean + * title: no_notification + * description: The order's no notification. + * metadata: + * type: object + * description: The order's metadata. + * - type: object + * description: SUMMARY + * properties: + * additional_data: + * type: object + * description: Pass additional custom data to the API route. This data is passed + * to the underlying workflow under the `additional_data` + * parameter. * description: SUMMARY - * properties: - * items: - * type: array - * description: The order's items. - * items: - * type: object - * description: The item's items. - * required: - * - id - * - quantity - * properties: - * id: - * type: string - * title: id - * description: The item's ID. - * quantity: - * type: number - * title: quantity - * description: The item's quantity. - * location_id: - * type: string - * title: location_id - * description: The order's location id. - * no_notification: - * type: boolean - * title: no_notification - * description: The order's no notification. - * metadata: - * type: object - * description: The order's metadata. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_cancel.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_cancel.ts index 72673064f8..f2e28f90cd 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_cancel.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_cancel.ts @@ -75,12 +75,23 @@ * content: * application/json: * schema: + * allOf: + * - type: object + * description: SUMMARY + * properties: + * no_notification: + * type: boolean + * title: no_notification + * description: The order's no notification. + * - type: object + * description: SUMMARY + * properties: + * additional_data: + * type: object + * description: Pass additional custom data to the API route. This data is passed + * to the underlying workflow under the `additional_data` + * parameter. * description: SUMMARY - * properties: - * no_notification: - * type: boolean - * title: no_notification - * description: The order's no notification. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_shipments.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_shipments.ts index 8648751760..56d92e8b2d 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_shipments.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_shipments.ts @@ -75,56 +75,70 @@ * content: * application/json: * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - items + * - metadata + * properties: + * items: + * type: array + * description: The order's items. + * items: + * type: object + * description: The item's items. + * required: + * - id + * - quantity + * properties: + * id: + * type: string + * title: id + * description: The item's ID. + * quantity: + * type: number + * title: quantity + * description: The item's quantity. + * labels: + * type: array + * description: The order's labels. + * items: + * type: object + * description: The label's labels. + * required: + * - tracking_number + * - tracking_url + * - label_url + * properties: + * tracking_number: + * type: string + * title: tracking_number + * description: The label's tracking number. + * tracking_url: + * type: string + * title: tracking_url + * description: The label's tracking url. + * label_url: + * type: string + * title: label_url + * description: The label's label url. + * no_notification: + * type: boolean + * title: no_notification + * description: The order's no notification. + * metadata: + * type: object + * description: The order's metadata. + * - type: object + * description: SUMMARY + * properties: + * additional_data: + * type: object + * description: Pass additional custom data to the API route. This data is passed + * to the underlying workflow under the `additional_data` + * parameter. * description: SUMMARY - * properties: - * items: - * type: array - * description: The order's items. - * items: - * type: object - * description: The item's items. - * required: - * - id - * - quantity - * properties: - * id: - * type: string - * title: id - * description: The item's ID. - * quantity: - * type: number - * title: quantity - * description: The item's quantity. - * labels: - * type: array - * description: The order's labels. - * items: - * type: object - * description: The label's labels. - * required: - * - tracking_number - * - tracking_url - * - label_url - * properties: - * tracking_number: - * type: string - * title: tracking_number - * description: The label's tracking number. - * tracking_url: - * type: string - * title: tracking_url - * description: The label's tracking url. - * label_url: - * type: string - * title: label_url - * description: The label's label url. - * no_notification: - * type: boolean - * title: no_notification - * description: The order's no notification. - * metadata: - * type: object - * description: The order's metadata. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_users.ts b/www/utils/generated/oas-output/operations/admin/post_admin_payment-collections.ts similarity index 57% rename from www/utils/generated/oas-output/operations/admin/post_admin_users.ts rename to www/utils/generated/oas-output/operations/admin/post_admin_payment-collections.ts index 8f9c8d2a07..84d4d03628 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_users.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_payment-collections.ts @@ -1,9 +1,9 @@ /** - * @oas [post] /admin/users - * operationId: PostUsers - * summary: Create User - * description: Create a user. - * x-authenticated: false + * @oas [post] /admin/payment-collections + * operationId: PostPaymentCollections + * summary: Create Payment Collection + * description: Create a payment collection. + * x-authenticated: true * parameters: * - name: expand * in: query @@ -15,18 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -55,29 +55,46 @@ * description: The field to sort the data by. By default, the sort order is * ascending. To change the order to descending, prefix the field name with * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] * requestBody: * content: * application/json: * schema: - * $ref: "#/components/schemas/CreateUser" + * type: object + * description: SUMMARY + * required: + * - order_id + * properties: + * order_id: + * type: string + * title: order_id + * description: The payment collection's order id. + * amount: + * type: number + * title: amount + * description: The payment collection's amount. * x-codeSamples: * - lang: Shell * label: cURL * source: |- - * curl -X POST '{backend_url}/admin/users' \ + * curl -X POST '{backend_url}/admin/payment-collections' \ + * -H 'x-medusa-access-token: {api_token}' \ * -H 'Content-Type: application/json' \ * --data-raw '{ - * "email": "Janie42@hotmail.com" + * "order_id": "{value}" * }' * tags: - * - Users + * - Payment Collections * responses: * "200": * description: OK * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminUserResponse" + * $ref: "#/components/schemas/AdminPaymentCollectionResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -90,7 +107,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * x-workflow: createUserAccountWorkflow + * x-workflow: createOrderPaymentCollectionWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products.ts index caaae14791..8f29462977 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products.ts @@ -63,148 +63,17 @@ * content: * application/json: * schema: + * allOf: + * - $ref: "#/components/schemas/AdminCreateProduct" + * - type: object + * description: SUMMARY + * properties: + * additional_data: + * type: object + * description: Pass additional custom data to the API route. This data is passed + * to the underlying workflow under the `additional_data` + * parameter. * description: SUMMARY - * properties: - * title: - * type: string - * title: title - * description: The product's title. - * subtitle: - * type: string - * title: subtitle - * description: The product's subtitle. - * description: - * type: string - * title: description - * description: The product's description. - * is_giftcard: - * type: boolean - * title: is_giftcard - * description: The product's is giftcard. - * discountable: - * type: boolean - * title: discountable - * description: The product's discountable. - * images: - * type: array - * description: The product's images. - * items: - * type: object - * description: The image's images. - * required: - * - url - * properties: - * url: - * type: string - * title: url - * description: The image's url. - * thumbnail: - * type: string - * title: thumbnail - * description: The product's thumbnail. - * handle: - * type: string - * title: handle - * description: The product's handle. - * status: - * type: string - * enum: - * - draft - * - proposed - * - published - * - rejected - * type_id: - * type: string - * title: type_id - * description: The product's type id. - * collection_id: - * type: string - * title: collection_id - * description: The product's collection id. - * categories: - * type: array - * description: The product's categories. - * items: - * type: object - * description: The category's categories. - * required: - * - id - * properties: - * id: - * type: string - * title: id - * description: The category's ID. - * tags: - * type: array - * description: The product's tags. - * items: - * type: object - * description: The tag's tags. - * required: - * - id - * properties: - * id: - * type: string - * title: id - * description: The tag's ID. - * options: - * type: array - * description: The product's options. - * items: - * $ref: "#/components/schemas/AdminCreateProductOption" - * variants: - * type: array - * description: The product's variants. - * items: - * $ref: "#/components/schemas/AdminCreateProductVariant" - * sales_channels: - * type: array - * description: The product's sales channels. - * items: - * type: object - * description: The sales channel's sales channels. - * required: - * - id - * properties: - * id: - * type: string - * title: id - * description: The sales channel's ID. - * weight: - * type: number - * title: weight - * description: The product's weight. - * length: - * type: number - * title: length - * description: The product's length. - * height: - * type: number - * title: height - * description: The product's height. - * width: - * type: number - * title: width - * description: The product's width. - * hs_code: - * type: string - * title: hs_code - * description: The product's hs code. - * mid_code: - * type: string - * title: mid_code - * description: The product's mid code. - * origin_country: - * type: string - * title: origin_country - * description: The product's origin country. - * material: - * type: string - * title: material - * description: The product's material. - * metadata: - * type: object - * description: The product's metadata. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id].ts index bb2a1de3cc..ac77699489 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id].ts @@ -69,150 +69,17 @@ * content: * application/json: * schema: + * allOf: + * - $ref: "#/components/schemas/AdminUpdateProduct" + * - type: object + * description: SUMMARY + * properties: + * additional_data: + * type: object + * description: Pass additional custom data to the API route. This data is passed + * to the underlying workflow under the `additional_data` + * parameter. * description: SUMMARY - * properties: - * title: - * type: string - * title: title - * description: The product's title. - * subtitle: - * type: string - * title: subtitle - * description: The product's subtitle. - * description: - * type: string - * title: description - * description: The product's description. - * is_giftcard: - * type: boolean - * title: is_giftcard - * description: The product's is giftcard. - * discountable: - * type: boolean - * title: discountable - * description: The product's discountable. - * images: - * type: array - * description: The product's images. - * items: - * type: object - * description: The image's images. - * required: - * - url - * properties: - * url: - * type: string - * title: url - * description: The image's url. - * thumbnail: - * type: string - * title: thumbnail - * description: The product's thumbnail. - * handle: - * type: string - * title: handle - * description: The product's handle. - * status: - * type: string - * enum: - * - draft - * - proposed - * - published - * - rejected - * type_id: - * type: string - * title: type_id - * description: The product's type id. - * collection_id: - * type: string - * title: collection_id - * description: The product's collection id. - * categories: - * type: array - * description: The product's categories. - * items: - * type: object - * description: The category's categories. - * required: - * - id - * properties: - * id: - * type: string - * title: id - * description: The category's ID. - * tags: - * type: array - * description: The product's tags. - * items: - * type: object - * description: The tag's tags. - * required: - * - id - * properties: - * id: - * type: string - * title: id - * description: The tag's ID. - * options: - * type: array - * description: The product's options. - * items: - * $ref: "#/components/schemas/AdminUpdateProductOption" - * variants: - * type: array - * description: The product's variants. - * items: - * oneOf: - * - $ref: "#/components/schemas/AdminCreateProductVariant" - * - $ref: "#/components/schemas/AdminUpdateProductVariant" - * sales_channels: - * type: array - * description: The product's sales channels. - * items: - * type: object - * description: The sales channel's sales channels. - * required: - * - id - * properties: - * id: - * type: string - * title: id - * description: The sales channel's ID. - * weight: - * type: number - * title: weight - * description: The product's weight. - * length: - * type: number - * title: length - * description: The product's length. - * height: - * type: number - * title: height - * description: The product's height. - * width: - * type: number - * title: width - * description: The product's width. - * hs_code: - * type: string - * title: hs_code - * description: The product's hs code. - * mid_code: - * type: string - * title: mid_code - * description: The product's mid code. - * origin_country: - * type: string - * title: origin_country - * description: The product's origin country. - * material: - * type: string - * title: material - * description: The product's material. - * metadata: - * type: object - * description: The product's metadata. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options.ts index f36bf8fad2..ab3f1be315 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options.ts @@ -69,19 +69,17 @@ * content: * application/json: * schema: + * allOf: + * - $ref: "#/components/schemas/AdminCreateProductOption" + * - type: object + * description: SUMMARY + * properties: + * additional_data: + * type: object + * description: Pass additional custom data to the API route. This data is passed + * to the underlying workflow under the `additional_data` + * parameter. * description: SUMMARY - * properties: - * title: - * type: string - * title: title - * description: The product's title. - * values: - * type: array - * description: The product's values. - * items: - * type: string - * title: values - * description: The value's values. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options_[option_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options_[option_id].ts index afee93dc04..47a6d23f2c 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options_[option_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options_[option_id].ts @@ -75,19 +75,17 @@ * content: * application/json: * schema: + * allOf: + * - $ref: "#/components/schemas/AdminUpdateProductOption" + * - type: object + * description: SUMMARY + * properties: + * additional_data: + * type: object + * description: Pass additional custom data to the API route. This data is passed + * to the underlying workflow under the `additional_data` + * parameter. * description: SUMMARY - * properties: - * title: - * type: string - * title: title - * description: The product's title. - * values: - * type: array - * description: The product's values. - * items: - * type: string - * title: values - * description: The value's values. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants.ts index 17d0f5d922..c0dcb87603 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants.ts @@ -69,83 +69,17 @@ * content: * application/json: * schema: + * allOf: + * - $ref: "#/components/schemas/AdminCreateProductVariant" + * - type: object + * description: SUMMARY + * properties: + * additional_data: + * type: object + * description: Pass additional custom data to the API route. This data is passed + * to the underlying workflow under the `additional_data` + * parameter. * description: SUMMARY - * properties: - * title: - * type: string - * title: title - * description: The product's title. - * sku: - * type: string - * title: sku - * description: The product's sku. - * ean: - * type: string - * title: ean - * description: The product's ean. - * upc: - * type: string - * title: upc - * description: The product's upc. - * barcode: - * type: string - * title: barcode - * description: The product's barcode. - * hs_code: - * type: string - * title: hs_code - * description: The product's hs code. - * mid_code: - * type: string - * title: mid_code - * description: The product's mid code. - * allow_backorder: - * type: boolean - * title: allow_backorder - * description: The product's allow backorder. - * manage_inventory: - * type: boolean - * title: manage_inventory - * description: The product's manage inventory. - * variant_rank: - * type: number - * title: variant_rank - * description: The product's variant rank. - * weight: - * type: number - * title: weight - * description: The product's weight. - * length: - * type: number - * title: length - * description: The product's length. - * height: - * type: number - * title: height - * description: The product's height. - * width: - * type: number - * title: width - * description: The product's width. - * origin_country: - * type: string - * title: origin_country - * description: The product's origin country. - * material: - * type: string - * title: material - * description: The product's material. - * metadata: - * type: object - * description: The product's metadata. - * prices: - * type: array - * description: The product's prices. - * items: - * $ref: "#/components/schemas/AdminCreateProductVariantPrice" - * options: - * type: object - * description: The product's options. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id].ts index b5f85c34b6..151b15be14 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id].ts @@ -75,83 +75,17 @@ * content: * application/json: * schema: + * allOf: + * - $ref: "#/components/schemas/AdminUpdateProductVariant" + * - type: object + * description: SUMMARY + * properties: + * additional_data: + * type: object + * description: Pass additional custom data to the API route. This data is passed + * to the underlying workflow under the `additional_data` + * parameter. * description: SUMMARY - * properties: - * title: - * type: string - * title: title - * description: The product's title. - * sku: - * type: string - * title: sku - * description: The product's sku. - * ean: - * type: string - * title: ean - * description: The product's ean. - * upc: - * type: string - * title: upc - * description: The product's upc. - * barcode: - * type: string - * title: barcode - * description: The product's barcode. - * hs_code: - * type: string - * title: hs_code - * description: The product's hs code. - * mid_code: - * type: string - * title: mid_code - * description: The product's mid code. - * allow_backorder: - * type: boolean - * title: allow_backorder - * description: The product's allow backorder. - * manage_inventory: - * type: boolean - * title: manage_inventory - * description: The product's manage inventory. - * variant_rank: - * type: number - * title: variant_rank - * description: The product's variant rank. - * weight: - * type: number - * title: weight - * description: The product's weight. - * length: - * type: number - * title: length - * description: The product's length. - * height: - * type: number - * title: height - * description: The product's height. - * width: - * type: number - * title: width - * description: The product's width. - * origin_country: - * type: string - * title: origin_country - * description: The product's origin country. - * material: - * type: string - * title: material - * description: The product's material. - * metadata: - * type: object - * description: The product's metadata. - * prices: - * type: array - * description: The product's prices. - * items: - * $ref: "#/components/schemas/AdminCreateProductVariantPrice" - * options: - * type: object - * description: The product's options. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_promotions.ts b/www/utils/generated/oas-output/operations/admin/post_admin_promotions.ts index a637cf08ae..c12c0c3a54 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_promotions.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_promotions.ts @@ -63,268 +63,284 @@ * content: * application/json: * schema: - * description: SUMMARY - * properties: - * code: - * type: string - * title: code - * description: The promotion's code. - * is_automatic: - * type: boolean - * title: is_automatic - * description: The promotion's is automatic. - * type: - * type: string - * enum: - * - standard - * - buyget - * campaign_id: - * type: string - * title: campaign_id - * description: The promotion's campaign id. - * campaign: - * type: object - * description: The promotion's campaign. + * allOf: + * - type: object + * description: SUMMARY * required: - * - name - * - campaign_identifier - * - description - * - budget - * - starts_at - * - ends_at - * properties: - * name: - * type: string - * title: name - * description: The campaign's name. - * campaign_identifier: - * type: string - * title: campaign_identifier - * description: The campaign's campaign identifier. - * description: - * type: string - * title: description - * description: The campaign's description. - * budget: - * type: object - * description: The campaign's budget. - * required: - * - type - * - limit - * - currency_code - * properties: - * type: - * type: string - * enum: - * - spend - * - usage - * limit: - * type: number - * title: limit - * description: The budget's limit. - * currency_code: - * type: string - * title: currency_code - * description: The budget's currency code. - * starts_at: - * type: string - * title: starts_at - * description: The campaign's starts at. - * format: date-time - * ends_at: - * type: string - * title: ends_at - * description: The campaign's ends at. - * format: date-time - * promotions: - * type: array - * description: The campaign's promotions. - * items: - * type: object - * description: The promotion's promotions. - * required: - * - id - * properties: - * id: - * type: string - * title: id - * description: The promotion's ID. - * application_method: - * type: object - * description: The promotion's application method. - * required: - * - description - * - value - * - currency_code - * - max_quantity + * - code * - type - * - target_type - * - apply_to_quantity - * - buy_rules_min_quantity + * - campaign_id + * - application_method * properties: - * description: + * code: * type: string - * title: description - * description: The application method's description. - * value: - * type: number - * title: value - * description: The application method's value. - * currency_code: - * type: string - * title: currency_code - * description: The application method's currency code. - * max_quantity: - * type: number - * title: max_quantity - * description: The application method's max quantity. + * title: code + * description: The promotion's code. + * is_automatic: + * type: boolean + * title: is_automatic + * description: The promotion's is automatic. * type: * type: string * enum: - * - fixed - * - percentage - * target_type: + * - standard + * - buyget + * campaign_id: * type: string - * enum: - * - order - * - shipping_methods - * - items - * allocation: - * type: string - * enum: - * - each - * - across - * target_rules: - * type: array - * description: The application method's target rules. - * items: - * type: object - * description: The target rule's target rules. - * required: - * - operator - * - description - * - attribute - * - values - * properties: - * operator: - * type: string - * enum: - * - gte - * - lte - * - gt - * - lt - * - eq - * - ne - * - in - * description: - * type: string - * title: description - * description: The target rule's description. - * attribute: - * type: string - * title: attribute - * description: The target rule's attribute. - * values: - * oneOf: - * - type: string - * title: values - * description: The target rule's values. - * - type: array - * description: The target rule's values. - * items: - * type: string - * title: values - * description: The value's values. - * buy_rules: - * type: array - * description: The application method's buy rules. - * items: - * type: object - * description: The buy rule's buy rules. - * required: - * - operator - * - description - * - attribute - * - values - * properties: - * operator: - * type: string - * enum: - * - gte - * - lte - * - gt - * - lt - * - eq - * - ne - * - in - * description: - * type: string - * title: description - * description: The buy rule's description. - * attribute: - * type: string - * title: attribute - * description: The buy rule's attribute. - * values: - * oneOf: - * - type: string - * title: values - * description: The buy rule's values. - * - type: array - * description: The buy rule's values. - * items: - * type: string - * title: values - * description: The value's values. - * apply_to_quantity: - * type: number - * title: apply_to_quantity - * description: The application method's apply to quantity. - * buy_rules_min_quantity: - * type: number - * title: buy_rules_min_quantity - * description: The application method's buy rules min quantity. - * rules: - * type: array - * description: The promotion's rules. - * items: - * type: object - * description: The rule's rules. - * required: - * - operator - * - description - * - attribute - * - values - * properties: - * operator: - * type: string - * enum: - * - gte - * - lte - * - gt - * - lt - * - eq - * - ne - * - in - * description: - * type: string - * title: description - * description: The rule's description. - * attribute: - * type: string - * title: attribute - * description: The rule's attribute. - * values: - * oneOf: - * - type: string - * title: values - * description: The rule's values. - * - type: array - * description: The rule's values. - * items: + * title: campaign_id + * description: The promotion's campaign id. + * campaign: + * type: object + * description: The promotion's campaign. + * required: + * - name + * - campaign_identifier + * - description + * - budget + * - starts_at + * - ends_at + * properties: + * name: + * type: string + * title: name + * description: The campaign's name. + * campaign_identifier: + * type: string + * title: campaign_identifier + * description: The campaign's campaign identifier. + * description: + * type: string + * title: description + * description: The campaign's description. + * budget: + * type: object + * description: The campaign's budget. + * required: + * - type + * - limit + * - currency_code + * properties: + * type: * type: string - * title: values - * description: The value's values. + * enum: + * - spend + * - usage + * limit: + * type: number + * title: limit + * description: The budget's limit. + * currency_code: + * type: string + * title: currency_code + * description: The budget's currency code. + * starts_at: + * type: string + * title: starts_at + * description: The campaign's starts at. + * format: date-time + * ends_at: + * type: string + * title: ends_at + * description: The campaign's ends at. + * format: date-time + * promotions: + * type: array + * description: The campaign's promotions. + * items: + * type: object + * description: The promotion's promotions. + * required: + * - id + * properties: + * id: + * type: string + * title: id + * description: The promotion's ID. + * application_method: + * type: object + * description: The promotion's application method. + * required: + * - description + * - value + * - currency_code + * - max_quantity + * - type + * - target_type + * - apply_to_quantity + * - buy_rules_min_quantity + * properties: + * description: + * type: string + * title: description + * description: The application method's description. + * value: + * type: number + * title: value + * description: The application method's value. + * currency_code: + * type: string + * title: currency_code + * description: The application method's currency code. + * max_quantity: + * type: number + * title: max_quantity + * description: The application method's max quantity. + * type: + * type: string + * enum: + * - fixed + * - percentage + * target_type: + * type: string + * enum: + * - order + * - shipping_methods + * - items + * allocation: + * type: string + * enum: + * - each + * - across + * target_rules: + * type: array + * description: The application method's target rules. + * items: + * type: object + * description: The target rule's target rules. + * required: + * - operator + * - description + * - attribute + * - values + * properties: + * operator: + * type: string + * enum: + * - gte + * - lte + * - gt + * - lt + * - eq + * - ne + * - in + * description: + * type: string + * title: description + * description: The target rule's description. + * attribute: + * type: string + * title: attribute + * description: The target rule's attribute. + * values: + * oneOf: + * - type: string + * title: values + * description: The target rule's values. + * - type: array + * description: The target rule's values. + * items: + * type: string + * title: values + * description: The value's values. + * buy_rules: + * type: array + * description: The application method's buy rules. + * items: + * type: object + * description: The buy rule's buy rules. + * required: + * - operator + * - description + * - attribute + * - values + * properties: + * operator: + * type: string + * enum: + * - gte + * - lte + * - gt + * - lt + * - eq + * - ne + * - in + * description: + * type: string + * title: description + * description: The buy rule's description. + * attribute: + * type: string + * title: attribute + * description: The buy rule's attribute. + * values: + * oneOf: + * - type: string + * title: values + * description: The buy rule's values. + * - type: array + * description: The buy rule's values. + * items: + * type: string + * title: values + * description: The value's values. + * apply_to_quantity: + * type: number + * title: apply_to_quantity + * description: The application method's apply to quantity. + * buy_rules_min_quantity: + * type: number + * title: buy_rules_min_quantity + * description: The application method's buy rules min quantity. + * rules: + * type: array + * description: The promotion's rules. + * items: + * type: object + * description: The rule's rules. + * required: + * - operator + * - description + * - attribute + * - values + * properties: + * operator: + * type: string + * enum: + * - gte + * - lte + * - gt + * - lt + * - eq + * - ne + * - in + * description: + * type: string + * title: description + * description: The rule's description. + * attribute: + * type: string + * title: attribute + * description: The rule's attribute. + * values: + * oneOf: + * - type: string + * title: values + * description: The rule's values. + * - type: array + * description: The rule's values. + * items: + * type: string + * title: values + * description: The value's values. + * - type: object + * description: SUMMARY + * properties: + * additional_data: + * type: object + * description: Pass additional custom data to the API route. This data is passed + * to the underlying workflow under the `additional_data` + * parameter. + * description: SUMMARY * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id].ts index 89bd15f39c..50daa379a4 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id].ts @@ -69,265 +69,278 @@ * content: * application/json: * schema: - * description: SUMMARY - * properties: - * code: - * type: string - * title: code - * description: The promotion's code. - * is_automatic: - * type: boolean - * title: is_automatic - * description: The promotion's is automatic. - * type: - * type: string - * enum: - * - standard - * - buyget - * campaign_id: - * type: string - * title: campaign_id - * description: The promotion's campaign id. - * campaign: - * type: object - * description: The promotion's campaign. + * allOf: + * - type: object + * description: SUMMARY * required: - * - name - * - campaign_identifier - * - description - * - budget - * - starts_at - * - ends_at + * - campaign_id * properties: - * name: + * code: * type: string - * title: name - * description: The campaign's name. - * campaign_identifier: - * type: string - * title: campaign_identifier - * description: The campaign's campaign identifier. - * description: - * type: string - * title: description - * description: The campaign's description. - * budget: - * type: object - * description: The campaign's budget. - * required: - * - type - * - limit - * - currency_code - * properties: - * type: - * type: string - * enum: - * - spend - * - usage - * limit: - * type: number - * title: limit - * description: The budget's limit. - * currency_code: - * type: string - * title: currency_code - * description: The budget's currency code. - * starts_at: - * type: string - * title: starts_at - * description: The campaign's starts at. - * format: date-time - * ends_at: - * type: string - * title: ends_at - * description: The campaign's ends at. - * format: date-time - * promotions: - * type: array - * description: The campaign's promotions. - * items: - * type: object - * description: The promotion's promotions. - * required: - * - id - * properties: - * id: - * type: string - * title: id - * description: The promotion's ID. - * application_method: - * type: object - * description: The promotion's application method. - * required: - * - description - * - max_quantity - * - currency_code - * - apply_to_quantity - * - buy_rules_min_quantity - * properties: - * description: - * type: string - * title: description - * description: The application method's description. - * value: - * type: number - * title: value - * description: The application method's value. - * max_quantity: - * type: number - * title: max_quantity - * description: The application method's max quantity. - * currency_code: - * type: string - * title: currency_code - * description: The application method's currency code. + * title: code + * description: The promotion's code. + * is_automatic: + * type: boolean + * title: is_automatic + * description: The promotion's is automatic. * type: * type: string * enum: - * - fixed - * - percentage - * target_type: + * - standard + * - buyget + * campaign_id: * type: string - * enum: - * - order - * - shipping_methods - * - items - * allocation: - * type: string - * enum: - * - each - * - across - * target_rules: - * type: array - * description: The application method's target rules. - * items: - * type: object - * description: The target rule's target rules. - * required: - * - operator - * - description - * - attribute - * - values - * properties: - * operator: - * type: string - * enum: - * - gte - * - lte - * - gt - * - lt - * - eq - * - ne - * - in - * description: - * type: string - * title: description - * description: The target rule's description. - * attribute: - * type: string - * title: attribute - * description: The target rule's attribute. - * values: - * oneOf: - * - type: string - * title: values - * description: The target rule's values. - * - type: array - * description: The target rule's values. - * items: - * type: string - * title: values - * description: The value's values. - * buy_rules: - * type: array - * description: The application method's buy rules. - * items: - * type: object - * description: The buy rule's buy rules. - * required: - * - operator - * - description - * - attribute - * - values - * properties: - * operator: - * type: string - * enum: - * - gte - * - lte - * - gt - * - lt - * - eq - * - ne - * - in - * description: - * type: string - * title: description - * description: The buy rule's description. - * attribute: - * type: string - * title: attribute - * description: The buy rule's attribute. - * values: - * oneOf: - * - type: string - * title: values - * description: The buy rule's values. - * - type: array - * description: The buy rule's values. - * items: - * type: string - * title: values - * description: The value's values. - * apply_to_quantity: - * type: number - * title: apply_to_quantity - * description: The application method's apply to quantity. - * buy_rules_min_quantity: - * type: number - * title: buy_rules_min_quantity - * description: The application method's buy rules min quantity. - * rules: - * type: array - * description: The promotion's rules. - * items: - * type: object - * description: The rule's rules. - * required: - * - operator - * - description - * - attribute - * - values - * properties: - * operator: - * type: string - * enum: - * - gte - * - lte - * - gt - * - lt - * - eq - * - ne - * - in - * description: - * type: string - * title: description - * description: The rule's description. - * attribute: - * type: string - * title: attribute - * description: The rule's attribute. - * values: - * oneOf: - * - type: string - * title: values - * description: The rule's values. - * - type: array - * description: The rule's values. - * items: + * title: campaign_id + * description: The promotion's campaign id. + * campaign: + * type: object + * description: The promotion's campaign. + * required: + * - name + * - campaign_identifier + * - description + * - budget + * - starts_at + * - ends_at + * properties: + * name: + * type: string + * title: name + * description: The campaign's name. + * campaign_identifier: + * type: string + * title: campaign_identifier + * description: The campaign's campaign identifier. + * description: + * type: string + * title: description + * description: The campaign's description. + * budget: + * type: object + * description: The campaign's budget. + * required: + * - type + * - limit + * - currency_code + * properties: + * type: * type: string - * title: values - * description: The value's values. + * enum: + * - spend + * - usage + * limit: + * type: number + * title: limit + * description: The budget's limit. + * currency_code: + * type: string + * title: currency_code + * description: The budget's currency code. + * starts_at: + * type: string + * title: starts_at + * description: The campaign's starts at. + * format: date-time + * ends_at: + * type: string + * title: ends_at + * description: The campaign's ends at. + * format: date-time + * promotions: + * type: array + * description: The campaign's promotions. + * items: + * type: object + * description: The promotion's promotions. + * required: + * - id + * properties: + * id: + * type: string + * title: id + * description: The promotion's ID. + * application_method: + * type: object + * description: The promotion's application method. + * required: + * - description + * - max_quantity + * - currency_code + * - apply_to_quantity + * - buy_rules_min_quantity + * properties: + * description: + * type: string + * title: description + * description: The application method's description. + * value: + * type: number + * title: value + * description: The application method's value. + * max_quantity: + * type: number + * title: max_quantity + * description: The application method's max quantity. + * currency_code: + * type: string + * title: currency_code + * description: The application method's currency code. + * type: + * type: string + * enum: + * - fixed + * - percentage + * target_type: + * type: string + * enum: + * - order + * - shipping_methods + * - items + * allocation: + * type: string + * enum: + * - each + * - across + * target_rules: + * type: array + * description: The application method's target rules. + * items: + * type: object + * description: The target rule's target rules. + * required: + * - operator + * - description + * - attribute + * - values + * properties: + * operator: + * type: string + * enum: + * - gte + * - lte + * - gt + * - lt + * - eq + * - ne + * - in + * description: + * type: string + * title: description + * description: The target rule's description. + * attribute: + * type: string + * title: attribute + * description: The target rule's attribute. + * values: + * oneOf: + * - type: string + * title: values + * description: The target rule's values. + * - type: array + * description: The target rule's values. + * items: + * type: string + * title: values + * description: The value's values. + * buy_rules: + * type: array + * description: The application method's buy rules. + * items: + * type: object + * description: The buy rule's buy rules. + * required: + * - operator + * - description + * - attribute + * - values + * properties: + * operator: + * type: string + * enum: + * - gte + * - lte + * - gt + * - lt + * - eq + * - ne + * - in + * description: + * type: string + * title: description + * description: The buy rule's description. + * attribute: + * type: string + * title: attribute + * description: The buy rule's attribute. + * values: + * oneOf: + * - type: string + * title: values + * description: The buy rule's values. + * - type: array + * description: The buy rule's values. + * items: + * type: string + * title: values + * description: The value's values. + * apply_to_quantity: + * type: number + * title: apply_to_quantity + * description: The application method's apply to quantity. + * buy_rules_min_quantity: + * type: number + * title: buy_rules_min_quantity + * description: The application method's buy rules min quantity. + * rules: + * type: array + * description: The promotion's rules. + * items: + * type: object + * description: The rule's rules. + * required: + * - operator + * - description + * - attribute + * - values + * properties: + * operator: + * type: string + * enum: + * - gte + * - lte + * - gt + * - lt + * - eq + * - ne + * - in + * description: + * type: string + * title: description + * description: The rule's description. + * attribute: + * type: string + * title: attribute + * description: The rule's attribute. + * values: + * oneOf: + * - type: string + * title: values + * description: The rule's values. + * - type: array + * description: The rule's values. + * items: + * type: string + * title: values + * description: The value's values. + * - type: object + * description: SUMMARY + * properties: + * additional_data: + * type: object + * description: Pass additional custom data to the API route. This data is passed + * to the underlying workflow under the `additional_data` + * parameter. + * description: SUMMARY * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts.ts b/www/utils/generated/oas-output/operations/store/post_store_carts.ts index f53ca49f55..43cc0c4726 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts.ts @@ -59,64 +59,17 @@ * content: * application/json: * schema: + * allOf: + * - $ref: "#/components/schemas/CreateCartWorkflowInput" + * - type: object + * description: SUMMARY + * properties: + * additional_data: + * type: object + * description: Pass additional custom data to the API route. This data is passed + * to the underlying workflow under the `additional_data` + * parameter. * description: SUMMARY - * properties: - * region_id: - * type: string - * title: region_id - * description: The cart's region id. - * customer_id: - * type: string - * title: customer_id - * description: The cart's customer id. - * sales_channel_id: - * type: string - * title: sales_channel_id - * description: The cart's sales channel id. - * email: - * type: string - * title: email - * description: The cart's email. - * format: email - * currency_code: - * type: string - * title: currency_code - * description: The cart's currency code. - * shipping_address_id: - * type: string - * title: shipping_address_id - * description: The cart's shipping address id. - * billing_address_id: - * type: string - * title: billing_address_id - * description: The cart's billing address id. - * shipping_address: - * oneOf: - * - type: string - * title: shipping_address - * description: The cart's shipping address. - * - $ref: "#/components/schemas/CreateCartAddress" - * billing_address: - * oneOf: - * - type: string - * title: billing_address - * description: The cart's billing address. - * - $ref: "#/components/schemas/CreateCartAddress" - * metadata: - * type: object - * description: The cart's metadata. - * items: - * type: array - * description: The cart's items. - * items: - * $ref: "#/components/schemas/CreateCartCreateLineItem" - * promo_codes: - * type: array - * description: The cart's promo codes. - * items: - * type: string - * title: promo_codes - * description: The promo code's promo codes. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id].ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id].ts index d06deda5fa..93d35ecfb2 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id].ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id].ts @@ -65,48 +65,17 @@ * content: * application/json: * schema: + * allOf: + * - $ref: "#/components/schemas/UpdateCartData" + * - type: object + * description: SUMMARY + * properties: + * additional_data: + * type: object + * description: Pass additional custom data to the API route. This data is passed + * to the underlying workflow under the `additional_data` + * parameter. * description: SUMMARY - * properties: - * region_id: - * type: string - * title: region_id - * description: The cart's region id. - * customer_id: - * type: string - * title: customer_id - * description: The cart's customer id. - * sales_channel_id: - * type: string - * title: sales_channel_id - * description: The cart's sales channel id. - * email: - * type: string - * title: email - * description: The cart's email. - * format: email - * currency_code: - * type: string - * title: currency_code - * description: The cart's currency code. - * shipping_address_id: - * type: string - * title: shipping_address_id - * description: The cart's shipping address id. - * billing_address_id: - * type: string - * title: billing_address_id - * description: The cart's billing address id. - * billing_address: - * oneOf: - * - $ref: "#/components/schemas/CreateAddress" - * - $ref: "#/components/schemas/UpdateAddress" - * shipping_address: - * oneOf: - * - $ref: "#/components/schemas/CreateAddress" - * - $ref: "#/components/schemas/UpdateAddress" - * metadata: - * type: object - * description: The cart's metadata. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/schemas/AdminPaymentCollectionResponse.ts b/www/utils/generated/oas-output/schemas/AdminPaymentCollectionResponse.ts new file mode 100644 index 0000000000..aa5d330852 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPaymentCollectionResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminPaymentCollectionResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminPaymentCollectionResponse + * required: + * - payment_collection + * properties: + * payment_collection: + * $ref: "#/components/schemas/AdminPaymentCollection" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/CreateCartWorkflowInput.ts b/www/utils/generated/oas-output/schemas/CreateCartWorkflowInput.ts new file mode 100644 index 0000000000..4da68eb2ef --- /dev/null +++ b/www/utils/generated/oas-output/schemas/CreateCartWorkflowInput.ts @@ -0,0 +1,65 @@ +/** + * @schema CreateCartWorkflowInput + * type: object + * description: SUMMARY + * x-schemaName: CreateCartWorkflowInput + * properties: + * region_id: + * type: string + * title: region_id + * description: The cart's region id. + * customer_id: + * type: string + * title: customer_id + * description: The cart's customer id. + * sales_channel_id: + * type: string + * title: sales_channel_id + * description: The cart's sales channel id. + * email: + * type: string + * title: email + * description: The cart's email. + * format: email + * currency_code: + * type: string + * title: currency_code + * description: The cart's currency code. + * shipping_address_id: + * type: string + * title: shipping_address_id + * description: The cart's shipping address id. + * billing_address_id: + * type: string + * title: billing_address_id + * description: The cart's billing address id. + * shipping_address: + * oneOf: + * - type: string + * title: shipping_address + * description: The cart's shipping address. + * - $ref: "#/components/schemas/CreateCartAddress" + * billing_address: + * oneOf: + * - type: string + * title: billing_address + * description: The cart's billing address. + * - $ref: "#/components/schemas/CreateCartAddress" + * metadata: + * type: object + * description: The cart's metadata. + * items: + * type: array + * description: The cart's items. + * items: + * $ref: "#/components/schemas/CreateCartCreateLineItem" + * promo_codes: + * type: array + * description: The cart's promo codes. + * items: + * type: string + * title: promo_codes + * description: The promo code's promo codes. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/CreateUser.ts b/www/utils/generated/oas-output/schemas/CreateUser.ts deleted file mode 100644 index 2163c74bcd..0000000000 --- a/www/utils/generated/oas-output/schemas/CreateUser.ts +++ /dev/null @@ -1,31 +0,0 @@ -/** - * @schema CreateUser - * type: object - * description: SUMMARY - * x-schemaName: CreateUser - * required: - * - email - * properties: - * email: - * type: string - * title: email - * description: The user's email. - * format: email - * first_name: - * type: string - * title: first_name - * description: The user's first name. - * last_name: - * type: string - * title: last_name - * description: The user's last name. - * avatar_url: - * type: string - * title: avatar_url - * description: The user's avatar url. - * metadata: - * type: object - * description: The user's metadata. - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/UpdateCartData.ts b/www/utils/generated/oas-output/schemas/UpdateCartData.ts new file mode 100644 index 0000000000..62a5481a5e --- /dev/null +++ b/www/utils/generated/oas-output/schemas/UpdateCartData.ts @@ -0,0 +1,49 @@ +/** + * @schema UpdateCartData + * type: object + * description: SUMMARY + * x-schemaName: UpdateCartData + * properties: + * region_id: + * type: string + * title: region_id + * description: The cart's region id. + * customer_id: + * type: string + * title: customer_id + * description: The cart's customer id. + * sales_channel_id: + * type: string + * title: sales_channel_id + * description: The cart's sales channel id. + * email: + * type: string + * title: email + * description: The cart's email. + * format: email + * currency_code: + * type: string + * title: currency_code + * description: The cart's currency code. + * shipping_address_id: + * type: string + * title: shipping_address_id + * description: The cart's shipping address id. + * billing_address_id: + * type: string + * title: billing_address_id + * description: The cart's billing address id. + * billing_address: + * oneOf: + * - $ref: "#/components/schemas/CreateAddress" + * - $ref: "#/components/schemas/UpdateAddress" + * shipping_address: + * oneOf: + * - $ref: "#/components/schemas/CreateAddress" + * - $ref: "#/components/schemas/UpdateAddress" + * metadata: + * type: object + * description: The cart's metadata. + * +*/ +