diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}/post.sh new file mode 100644 index 0000000000000..d3c39b10fd2c5 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/orders/{id}' \ +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateOrder.yaml new file mode 100644 index 0000000000000..6f03904453e70 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateOrder.yaml @@ -0,0 +1,105 @@ +type: object +description: The details to update in the order. +x-schemaName: AdminUpdateOrder +properties: + email: + type: string + title: email + description: The order's email. + format: email + shipping_address: + type: object + description: The order's shipping address. + properties: + first_name: + type: string + title: first_name + description: The address's first name. + last_name: + type: string + title: last_name + description: The address's last name. + phone: + type: string + title: phone + description: The address's phone. + company: + type: string + title: company + description: The address's company. + address_1: + type: string + title: address_1 + description: The address's first line. + address_2: + type: string + title: address_2 + description: The address's second line. + city: + type: string + title: city + description: The address's city. + country_code: + type: string + title: country_code + description: The address's country code. + example: us + province: + type: string + title: province + description: The address's province. + postal_code: + type: string + title: postal_code + description: The address's postal code. + metadata: + type: object + description: The address's metadata, can hold custom key-value pairs. + billing_address: + type: object + description: The order's billing address. + properties: + first_name: + type: string + title: first_name + description: The address's first name. + last_name: + type: string + title: last_name + description: The address's last name. + phone: + type: string + title: phone + description: The address's phone. + company: + type: string + title: company + description: The address's company. + address_1: + type: string + title: address_1 + description: The address's first line. + address_2: + type: string + title: address_2 + description: The address's second line. + city: + type: string + title: city + description: The address's city. + country_code: + type: string + title: country_code + description: The address's country code. + example: us + province: + type: string + title: province + description: The address's province. + postal_code: + type: string + title: postal_code + description: The address's postal code. + metadata: + type: object + description: The address's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseCalculatedPriceSet.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseCalculatedPriceSet.yaml index ec11356ec0947..ac22d66e394f8 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseCalculatedPriceSet.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseCalculatedPriceSet.yaml @@ -56,60 +56,6 @@ properties: calculated_price: type: object description: The calculated price's details. - properties: - id: - type: string - title: id - description: The ID of the price. - price_list_id: - type: string - title: price_list_id - description: The ID of the associated price list. - price_list_type: - type: string - title: price_list_type - description: The price list's type. For example, sale. - min_quantity: - type: number - title: min_quantity - description: The minimum quantity required in the cart for this price to apply. - max_quantity: - type: number - title: max_quantity - description: The maximum quantity allowed in the cart for this price to apply. - required: - - id - - price_list_id - - price_list_type - - min_quantity - - max_quantity original_price: type: object description: The original price's details. - properties: - id: - type: string - title: id - description: The ID of the price. - price_list_id: - type: string - title: price_list_id - description: The ID of the associated price list. - price_list_type: - type: string - title: price_list_type - description: The price list's type. For example, sale. - min_quantity: - type: number - title: min_quantity - description: The minimum quantity required in the cart for this price to apply. - max_quantity: - type: number - title: max_quantity - description: The maximum quantity allowed in the cart for this price to apply. - required: - - id - - price_list_id - - price_list_type - - min_quantity - - max_quantity diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml index 8f67e56846073..cb63c52362d79 100644 --- a/www/apps/api-reference/specs/admin/openapi.full.yaml +++ b/www/apps/api-reference/specs/admin/openapi.full.yaml @@ -19772,6 +19772,68 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: getOrderDetailWorkflow + post: + operationId: PostOrdersId + summary: Update Order + description: Update an order's details. + x-authenticated: true + parameters: + - name: id + in: path + description: The order's ID. + required: true + schema: + type: string + - 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. + externalDocs: + url: '#select-fields-and-relations' + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminUpdateOrder' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/orders/{id}' \ + -H 'Authorization: Bearer {access_token}' + tags: + - Orders + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrderResponse' + '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: updateOrderWorkflow /admin/orders/{id}/archive: post: operationId: PostOrdersIdArchive @@ -23053,20 +23115,20 @@ paths: description: A parent category's ID. - name: include_ancestors_tree in: query - description: Whether to include the parent category of each category. If enabled, the parent category is set in the `parent_category` property of each category object. + description: Whether to include the parent category of each category. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`. required: false schema: type: boolean title: include_ancestors_tree - description: Whether to include the parent category of each category. If enabled, the parent category is set in the `parent_category` property of each category object. + description: Whether to include the parent category of each category. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`. - name: include_descendants_tree in: query - description: Whether to include the child categories of each category. If enabled, the child categories are added to the `category_children` property of each category object. + description: Whether to include the child categories of each category. If you enable this, add to the `fields` query parameter `category_children` to set the children of a category in this field. You can either pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, `fields=category_children.id,category_children.name`. required: false schema: type: boolean title: include_descendants_tree - description: Whether to include the child categories of each category. If enabled, the child categories are added to the `category_children` property of each category object. + description: Whether to include the child categories of each category. If you enable this, add to the `fields` query parameter `category_children` to set the children of a category in this field. You can either pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, `fields=category_children.id,category_children.name`. - name: is_internal in: query description: Filter by whether the category is internal. @@ -23587,20 +23649,20 @@ paths: url: '#select-fields-and-relations' - name: include_ancestors_tree in: query - description: Whether to retrieve the category's parent. When enabled, the parent category is set in the `parent_category` property. + description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`. required: false schema: type: boolean title: include_ancestors_tree - description: Whether to retrieve the category's parent. When enabled, the parent category is set in the `parent_category` property. + description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`. - name: include_descendants_tree in: query - description: Whether to retrieve a list of child categories. When enabled, the parent categories are added to the `category_children` property. + description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the children of a category in this field. You can either pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, `fields=category_children.id,category_children.name`. required: false schema: type: boolean title: include_descendants_tree - description: Whether to retrieve a list of child categories. When enabled, the parent categories are added to the `category_children` property. + description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the children of a category in this field. You can either pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, `fields=category_children.id,category_children.name`. security: - api_token: [] - cookie_auth: [] @@ -53654,6 +53716,112 @@ components: metadata: type: object description: The customer group's metadata, can hold custom key-value pairs. + AdminUpdateOrder: + type: object + description: The details to update in the order. + x-schemaName: AdminUpdateOrder + properties: + email: + type: string + title: email + description: The order's email. + format: email + shipping_address: + type: object + description: The order's shipping address. + properties: + first_name: + type: string + title: first_name + description: The address's first name. + last_name: + type: string + title: last_name + description: The address's last name. + phone: + type: string + title: phone + description: The address's phone. + company: + type: string + title: company + description: The address's company. + address_1: + type: string + title: address_1 + description: The address's first line. + address_2: + type: string + title: address_2 + description: The address's second line. + city: + type: string + title: city + description: The address's city. + country_code: + type: string + title: country_code + description: The address's country code. + example: us + province: + type: string + title: province + description: The address's province. + postal_code: + type: string + title: postal_code + description: The address's postal code. + metadata: + type: object + description: The address's metadata, can hold custom key-value pairs. + billing_address: + type: object + description: The order's billing address. + properties: + first_name: + type: string + title: first_name + description: The address's first name. + last_name: + type: string + title: last_name + description: The address's last name. + phone: + type: string + title: phone + description: The address's phone. + company: + type: string + title: company + description: The address's company. + address_1: + type: string + title: address_1 + description: The address's first line. + address_2: + type: string + title: address_2 + description: The address's second line. + city: + type: string + title: city + description: The address's city. + country_code: + type: string + title: country_code + description: The address's country code. + example: us + province: + type: string + title: province + description: The address's province. + postal_code: + type: string + title: postal_code + description: The address's postal code. + metadata: + type: object + description: The address's metadata, can hold custom key-value pairs. AdminUpdatePriceList: type: object description: the details to update in a price list. @@ -54804,63 +54972,9 @@ components: calculated_price: type: object description: The calculated price's details. - properties: - id: - type: string - title: id - description: The ID of the price. - price_list_id: - type: string - title: price_list_id - description: The ID of the associated price list. - price_list_type: - type: string - title: price_list_type - description: The price list's type. For example, sale. - min_quantity: - type: number - title: min_quantity - description: The minimum quantity required in the cart for this price to apply. - max_quantity: - type: number - title: max_quantity - description: The maximum quantity allowed in the cart for this price to apply. - required: - - id - - price_list_id - - price_list_type - - min_quantity - - max_quantity original_price: type: object description: The original price's details. - properties: - id: - type: string - title: id - description: The ID of the price. - price_list_id: - type: string - title: price_list_id - description: The ID of the associated price list. - price_list_type: - type: string - title: price_list_type - description: The price list's type. For example, sale. - min_quantity: - type: number - title: min_quantity - description: The minimum quantity required in the cart for this price to apply. - max_quantity: - type: number - title: max_quantity - description: The maximum quantity allowed in the cart for this price to apply. - required: - - id - - price_list_id - - price_list_type - - min_quantity - - max_quantity BaseCapture: type: object description: The details of a captured payment. diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml index fd00de2fb9f45..d14dc0f95de09 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml @@ -109,3 +109,71 @@ get: '500': $ref: ../components/responses/500_error.yaml x-workflow: getOrderDetailWorkflow +post: + operationId: PostOrdersId + summary: Update Order + description: Update an order's details. + x-authenticated: true + parameters: + - name: id + in: path + description: The order's ID. + required: true + schema: + type: string + - 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. + externalDocs: + url: '#select-fields-and-relations' + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminUpdateOrder.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_orders_{id}/post.sh + tags: + - Orders + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminOrderResponse.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: updateOrderWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml index f3b353a77ad3a..9a994d19122aa 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml @@ -129,31 +129,43 @@ get: - name: include_ancestors_tree in: query description: >- - Whether to include the parent category of each category. If enabled, the - parent category is set in the `parent_category` property of each - category object. + Whether to include the parent category of each category. If you enable + this, add to the `fields` query parameter `parent_category` to set the + parent of a category in this field. You can either pass + `*parent_category` to retreieve the fields of all parent categories, or + select specific fields to make the response size smaller. For example, + `fields=parent_category.id,parent_category.name`. required: false schema: type: boolean title: include_ancestors_tree description: >- - Whether to include the parent category of each category. If enabled, - the parent category is set in the `parent_category` property of each - category object. + Whether to include the parent category of each category. If you enable + this, add to the `fields` query parameter `parent_category` to set the + parent of a category in this field. You can either pass + `*parent_category` to retreieve the fields of all parent categories, + or select specific fields to make the response size smaller. For + example, `fields=parent_category.id,parent_category.name`. - name: include_descendants_tree in: query description: >- - Whether to include the child categories of each category. If enabled, - the child categories are added to the `category_children` property of - each category object. + Whether to include the child categories of each category. If you enable + this, add to the `fields` query parameter `category_children` to set the + children of a category in this field. You can either pass + `*category_children` to retreieve the fields of all child categories, or + select specific fields to make the response size smaller. For example, + `fields=category_children.id,category_children.name`. required: false schema: type: boolean title: include_descendants_tree description: >- - Whether to include the child categories of each category. If enabled, - the child categories are added to the `category_children` property of - each category object. + Whether to include the child categories of each category. If you + enable this, add to the `fields` query parameter `category_children` + to set the children of a category in this field. You can either pass + `*category_children` to retreieve the fields of all child categories, + or select specific fields to make the response size smaller. For + example, `fields=category_children.id,category_children.name`. - name: is_internal in: query description: Filter by whether the category is internal. diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml index dafd3fe56b3ee..28aa904ff7247 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml @@ -33,27 +33,43 @@ get: - name: include_ancestors_tree in: query description: >- - Whether to retrieve the category's parent. When enabled, the parent - category is set in the `parent_category` property. + Whether to retrieve the category's parent. If you enable this, add to + the `fields` query parameter `parent_category` to set the parent of a + category in this field. You can either pass `*parent_category` to + retreieve the fields of all parent categories, or select specific fields + to make the response size smaller. For example, + `fields=parent_category.id,parent_category.name`. required: false schema: type: boolean title: include_ancestors_tree description: >- - Whether to retrieve the category's parent. When enabled, the parent - category is set in the `parent_category` property. + Whether to retrieve the category's parent. If you enable this, add to + the `fields` query parameter `parent_category` to set the parent of a + category in this field. You can either pass `*parent_category` to + retreieve the fields of all parent categories, or select specific + fields to make the response size smaller. For example, + `fields=parent_category.id,parent_category.name`. - name: include_descendants_tree in: query description: >- - Whether to retrieve a list of child categories. When enabled, the parent - categories are added to the `category_children` property. + Whether to retrieve a list of child categories. If you enable this, add + to the `fields` query parameter `category_children` to set the children + of a category in this field. You can either pass `*category_children` to + retreieve the fields of all child categories, or select specific fields + to make the response size smaller. For example, + `fields=category_children.id,category_children.name`. required: false schema: type: boolean title: include_descendants_tree description: >- - Whether to retrieve a list of child categories. When enabled, the - parent categories are added to the `category_children` property. + Whether to retrieve a list of child categories. If you enable this, + add to the `fields` query parameter `category_children` to set the + children of a category in this field. You can either pass + `*category_children` to retreieve the fields of all child categories, + or select specific fields to make the response size smaller. For + example, `fields=category_children.id,category_children.name`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateOrder.yaml new file mode 100644 index 0000000000000..6f03904453e70 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateOrder.yaml @@ -0,0 +1,105 @@ +type: object +description: The details to update in the order. +x-schemaName: AdminUpdateOrder +properties: + email: + type: string + title: email + description: The order's email. + format: email + shipping_address: + type: object + description: The order's shipping address. + properties: + first_name: + type: string + title: first_name + description: The address's first name. + last_name: + type: string + title: last_name + description: The address's last name. + phone: + type: string + title: phone + description: The address's phone. + company: + type: string + title: company + description: The address's company. + address_1: + type: string + title: address_1 + description: The address's first line. + address_2: + type: string + title: address_2 + description: The address's second line. + city: + type: string + title: city + description: The address's city. + country_code: + type: string + title: country_code + description: The address's country code. + example: us + province: + type: string + title: province + description: The address's province. + postal_code: + type: string + title: postal_code + description: The address's postal code. + metadata: + type: object + description: The address's metadata, can hold custom key-value pairs. + billing_address: + type: object + description: The order's billing address. + properties: + first_name: + type: string + title: first_name + description: The address's first name. + last_name: + type: string + title: last_name + description: The address's last name. + phone: + type: string + title: phone + description: The address's phone. + company: + type: string + title: company + description: The address's company. + address_1: + type: string + title: address_1 + description: The address's first line. + address_2: + type: string + title: address_2 + description: The address's second line. + city: + type: string + title: city + description: The address's city. + country_code: + type: string + title: country_code + description: The address's country code. + example: us + province: + type: string + title: province + description: The address's province. + postal_code: + type: string + title: postal_code + description: The address's postal code. + metadata: + type: object + description: The address's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseCalculatedPriceSet.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseCalculatedPriceSet.yaml index ec11356ec0947..ac22d66e394f8 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseCalculatedPriceSet.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseCalculatedPriceSet.yaml @@ -56,60 +56,6 @@ properties: calculated_price: type: object description: The calculated price's details. - properties: - id: - type: string - title: id - description: The ID of the price. - price_list_id: - type: string - title: price_list_id - description: The ID of the associated price list. - price_list_type: - type: string - title: price_list_type - description: The price list's type. For example, sale. - min_quantity: - type: number - title: min_quantity - description: The minimum quantity required in the cart for this price to apply. - max_quantity: - type: number - title: max_quantity - description: The maximum quantity allowed in the cart for this price to apply. - required: - - id - - price_list_id - - price_list_type - - min_quantity - - max_quantity original_price: type: object description: The original price's details. - properties: - id: - type: string - title: id - description: The ID of the price. - price_list_id: - type: string - title: price_list_id - description: The ID of the associated price list. - price_list_type: - type: string - title: price_list_type - description: The price list's type. For example, sale. - min_quantity: - type: number - title: min_quantity - description: The minimum quantity required in the cart for this price to apply. - max_quantity: - type: number - title: max_quantity - description: The maximum quantity allowed in the cart for this price to apply. - required: - - id - - price_list_id - - price_list_type - - min_quantity - - max_quantity diff --git a/www/apps/api-reference/specs/store/openapi.full.yaml b/www/apps/api-reference/specs/store/openapi.full.yaml index 2bd69b8809630..ec1bffb47e83f 100644 --- a/www/apps/api-reference/specs/store/openapi.full.yaml +++ b/www/apps/api-reference/specs/store/openapi.full.yaml @@ -3747,20 +3747,20 @@ paths: description: A product category's ID. - name: include_ancestors_tree in: query - description: Whether to retrieve the category's parent. When enabled, the parent category is set in the `parent_category` property. + description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`. required: false schema: type: boolean title: include_ancestors_tree - description: Whether to retrieve the category's parent. When enabled, the parent category is set in the `parent_category` property. + description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`. - name: include_descendants_tree in: query - description: Whether to retrieve a list of child categories. When enabled, the parent categories are added to the `category_children` property. + description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the child of a category in this field. You can either pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, `fields=category_children.id,category_children.name`. required: false schema: type: boolean title: include_descendants_tree - description: Whether to retrieve a list of child categories. When enabled, the parent categories are added to the `category_children` property. + description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the child of a category in this field. You can either pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, `fields=category_children.id,category_children.name`. - name: created_at in: query description: Filter by the category's creation date. @@ -4310,20 +4310,20 @@ paths: url: '#select-fields-and-relations' - name: include_ancestors_tree in: query - description: Whether to retrieve the category's parent. When enabled, the parent category is set in the `parent_category` property. + description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`. required: false schema: type: boolean title: include_ancestors_tree - description: Whether to retrieve the category's parent. When enabled, the parent category is set in the `parent_category` property. + description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`. - name: include_descendants_tree in: query - description: Whether to retrieve a list of child categories. When enabled, the parent categories are added to the `category_children` property. + description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the children of a category in this field. You can either pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, `fields=category_children.id,category_children.name`. required: false schema: type: boolean title: include_descendants_tree - description: Whether to retrieve a list of child categories. When enabled, the parent categories are added to the `category_children` property. + description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the children of a category in this field. You can either pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, `fields=category_children.id,category_children.name`. x-codeSamples: - lang: Shell label: cURL @@ -15914,6 +15914,112 @@ components: metadata: type: object description: The customer group's metadata, can hold custom key-value pairs. + AdminUpdateOrder: + type: object + description: The details to update in the order. + x-schemaName: AdminUpdateOrder + properties: + email: + type: string + title: email + description: The order's email. + format: email + shipping_address: + type: object + description: The order's shipping address. + properties: + first_name: + type: string + title: first_name + description: The address's first name. + last_name: + type: string + title: last_name + description: The address's last name. + phone: + type: string + title: phone + description: The address's phone. + company: + type: string + title: company + description: The address's company. + address_1: + type: string + title: address_1 + description: The address's first line. + address_2: + type: string + title: address_2 + description: The address's second line. + city: + type: string + title: city + description: The address's city. + country_code: + type: string + title: country_code + description: The address's country code. + example: us + province: + type: string + title: province + description: The address's province. + postal_code: + type: string + title: postal_code + description: The address's postal code. + metadata: + type: object + description: The address's metadata, can hold custom key-value pairs. + billing_address: + type: object + description: The order's billing address. + properties: + first_name: + type: string + title: first_name + description: The address's first name. + last_name: + type: string + title: last_name + description: The address's last name. + phone: + type: string + title: phone + description: The address's phone. + company: + type: string + title: company + description: The address's company. + address_1: + type: string + title: address_1 + description: The address's first line. + address_2: + type: string + title: address_2 + description: The address's second line. + city: + type: string + title: city + description: The address's city. + country_code: + type: string + title: country_code + description: The address's country code. + example: us + province: + type: string + title: province + description: The address's province. + postal_code: + type: string + title: postal_code + description: The address's postal code. + metadata: + type: object + description: The address's metadata, can hold custom key-value pairs. AdminUpdatePriceList: type: object description: the details to update in a price list. @@ -17064,63 +17170,9 @@ components: calculated_price: type: object description: The calculated price's details. - properties: - id: - type: string - title: id - description: The ID of the price. - price_list_id: - type: string - title: price_list_id - description: The ID of the associated price list. - price_list_type: - type: string - title: price_list_type - description: The price list's type. For example, sale. - min_quantity: - type: number - title: min_quantity - description: The minimum quantity required in the cart for this price to apply. - max_quantity: - type: number - title: max_quantity - description: The maximum quantity allowed in the cart for this price to apply. - required: - - id - - price_list_id - - price_list_type - - min_quantity - - max_quantity original_price: type: object description: The original price's details. - properties: - id: - type: string - title: id - description: The ID of the price. - price_list_id: - type: string - title: price_list_id - description: The ID of the associated price list. - price_list_type: - type: string - title: price_list_type - description: The price list's type. For example, sale. - min_quantity: - type: number - title: min_quantity - description: The minimum quantity required in the cart for this price to apply. - max_quantity: - type: number - title: max_quantity - description: The maximum quantity allowed in the cart for this price to apply. - required: - - id - - price_list_id - - price_list_type - - min_quantity - - max_quantity BaseCapture: type: object description: The details of a captured payment. diff --git a/www/apps/api-reference/specs/store/paths/store_product-categories.yaml b/www/apps/api-reference/specs/store/paths/store_product-categories.yaml index 540db6122241b..4baf703dc5856 100644 --- a/www/apps/api-reference/specs/store/paths/store_product-categories.yaml +++ b/www/apps/api-reference/specs/store/paths/store_product-categories.yaml @@ -135,27 +135,43 @@ get: - name: include_ancestors_tree in: query description: >- - Whether to retrieve the category's parent. When enabled, the parent - category is set in the `parent_category` property. + Whether to retrieve the category's parent. If you enable this, add to + the `fields` query parameter `parent_category` to set the parent of a + category in this field. You can either pass `*parent_category` to + retreieve the fields of all parent categories, or select specific fields + to make the response size smaller. For example, + `fields=parent_category.id,parent_category.name`. required: false schema: type: boolean title: include_ancestors_tree description: >- - Whether to retrieve the category's parent. When enabled, the parent - category is set in the `parent_category` property. + Whether to retrieve the category's parent. If you enable this, add to + the `fields` query parameter `parent_category` to set the parent of a + category in this field. You can either pass `*parent_category` to + retreieve the fields of all parent categories, or select specific + fields to make the response size smaller. For example, + `fields=parent_category.id,parent_category.name`. - name: include_descendants_tree in: query description: >- - Whether to retrieve a list of child categories. When enabled, the parent - categories are added to the `category_children` property. + Whether to retrieve a list of child categories. If you enable this, add + to the `fields` query parameter `category_children` to set the child of + a category in this field. You can either pass `*category_children` to + retreieve the fields of all child categories, or select specific fields + to make the response size smaller. For example, + `fields=category_children.id,category_children.name`. required: false schema: type: boolean title: include_descendants_tree description: >- - Whether to retrieve a list of child categories. When enabled, the - parent categories are added to the `category_children` property. + Whether to retrieve a list of child categories. If you enable this, + add to the `fields` query parameter `category_children` to set the + child of a category in this field. You can either pass + `*category_children` to retreieve the fields of all child categories, + or select specific fields to make the response size smaller. For + example, `fields=category_children.id,category_children.name`. - name: created_at in: query description: Filter by the category's creation date. diff --git a/www/apps/api-reference/specs/store/paths/store_product-categories_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_product-categories_{id}.yaml index bb7cf01187273..4b4dd734c8874 100644 --- a/www/apps/api-reference/specs/store/paths/store_product-categories_{id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_product-categories_{id}.yaml @@ -37,27 +37,43 @@ get: - name: include_ancestors_tree in: query description: >- - Whether to retrieve the category's parent. When enabled, the parent - category is set in the `parent_category` property. + Whether to retrieve the category's parent. If you enable this, add to + the `fields` query parameter `parent_category` to set the parent of a + category in this field. You can either pass `*parent_category` to + retreieve the fields of all parent categories, or select specific fields + to make the response size smaller. For example, + `fields=parent_category.id,parent_category.name`. required: false schema: type: boolean title: include_ancestors_tree description: >- - Whether to retrieve the category's parent. When enabled, the parent - category is set in the `parent_category` property. + Whether to retrieve the category's parent. If you enable this, add to + the `fields` query parameter `parent_category` to set the parent of a + category in this field. You can either pass `*parent_category` to + retreieve the fields of all parent categories, or select specific + fields to make the response size smaller. For example, + `fields=parent_category.id,parent_category.name`. - name: include_descendants_tree in: query description: >- - Whether to retrieve a list of child categories. When enabled, the parent - categories are added to the `category_children` property. + Whether to retrieve a list of child categories. If you enable this, add + to the `fields` query parameter `category_children` to set the children + of a category in this field. You can either pass `*category_children` to + retreieve the fields of all child categories, or select specific fields + to make the response size smaller. For example, + `fields=category_children.id,category_children.name`. required: false schema: type: boolean title: include_descendants_tree description: >- - Whether to retrieve a list of child categories. When enabled, the - parent categories are added to the `category_children` property. + Whether to retrieve a list of child categories. If you enable this, + add to the `fields` query parameter `category_children` to set the + children of a category in this field. You can either pass + `*category_children` to retreieve the fields of all child categories, + or select specific fields to make the response size smaller. For + example, `fields=category_children.id,category_children.name`. x-codeSamples: - lang: Shell label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts index 4db18e6bf1e3e..36c7b2ca9327e 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts @@ -111,20 +111,28 @@ * description: A parent category's ID. * - name: include_ancestors_tree * in: query - * description: Whether to include the parent category of each category. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`. + * description: Whether to include the parent category of each category. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can + * either pass `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, + * `fields=parent_category.id,parent_category.name`. * required: false * schema: * type: boolean * title: include_ancestors_tree - * description: Whether to include the parent category of each category. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`. + * description: Whether to include the parent category of each category. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can + * either pass `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, + * `fields=parent_category.id,parent_category.name`. * - name: include_descendants_tree * in: query - * description: Whether to include the child categories of each category. If you enable this, add to the `fields` query parameter `category_children` to set the children of a category in this field. You can either pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, `fields=category_children.id,category_children.name`. + * description: Whether to include the child categories of each category. If you enable this, add to the `fields` query parameter `category_children` to set the children of a category in this field. You + * can either pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, + * `fields=category_children.id,category_children.name`. * required: false * schema: * type: boolean * title: include_descendants_tree - * description: Whether to include the child categories of each category. If you enable this, add to the `fields` query parameter `category_children` to set the children of a category in this field. You can either pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, `fields=category_children.id,category_children.name`. + * description: Whether to include the child categories of each category. If you enable this, add to the `fields` query parameter `category_children` to set the children of a category in this field. You + * can either pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, + * `fields=category_children.id,category_children.name`. * - name: is_internal * in: query * description: Filter by whether the category is internal. diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-categories_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-categories_[id].ts index 3662dd2c3e5d0..955422f37a4f3 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-categories_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-categories_[id].ts @@ -25,20 +25,26 @@ * url: "#select-fields-and-relations" * - name: include_ancestors_tree * in: query - * description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`. + * description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass + * `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`. * required: false * schema: * type: boolean * title: include_ancestors_tree - * description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`. + * description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass + * `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`. * - name: include_descendants_tree * in: query - * description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the children of a category in this field. You can either pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, `fields=category_children.id,category_children.name`. + * description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the children of a category in this field. You can either + * pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, + * `fields=category_children.id,category_children.name`. * required: false * schema: * type: boolean * title: include_descendants_tree - * description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the children of a category in this field. You can either pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, `fields=category_children.id,category_children.name`. + * description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the children of a category in this field. You can either + * pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, + * `fields=category_children.id,category_children.name`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id].ts new file mode 100644 index 0000000000000..5fdfaf5651adb --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id].ts @@ -0,0 +1,67 @@ +/** + * @oas [post] /admin/orders/{id} + * operationId: PostOrdersId + * summary: Update Order + * description: Update an order's details. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The order's ID. + * required: true + * schema: + * type: string + * - 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. + * externalDocs: + * url: "#select-fields-and-relations" + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminUpdateOrder" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/orders/{id}' \ + * -H 'Authorization: Bearer {access_token}' + * tags: + * - Orders + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminOrderResponse" + * "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: updateOrderWorkflow + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_transfer_cancel.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_transfer_cancel.ts index 318958633bdde..11b0a9c561852 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_transfer_cancel.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_transfer_cancel.ts @@ -58,5 +58,6 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: cancelOrderTransferRequestWorkflow + * */ diff --git a/www/utils/generated/oas-output/operations/store/get_store_product-categories.ts b/www/utils/generated/oas-output/operations/store/get_store_product-categories.ts index 5314b03478789..09c139ede45c3 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_product-categories.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_product-categories.ts @@ -114,20 +114,26 @@ * description: A product category's ID. * - name: include_ancestors_tree * in: query - * description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`. + * description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass + * `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`. * required: false * schema: * type: boolean * title: include_ancestors_tree - * description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`. + * description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass + * `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`. * - name: include_descendants_tree * in: query - * description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the child of a category in this field. You can either pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, `fields=category_children.id,category_children.name`. + * description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the child of a category in this field. You can either + * pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, + * `fields=category_children.id,category_children.name`. * required: false * schema: * type: boolean * title: include_descendants_tree - * description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the child of a category in this field. You can either pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, `fields=category_children.id,category_children.name`. + * description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the child of a category in this field. You can either + * pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, + * `fields=category_children.id,category_children.name`. * - name: created_at * in: query * description: Filter by the category's creation date. diff --git a/www/utils/generated/oas-output/operations/store/get_store_product-categories_[id].ts b/www/utils/generated/oas-output/operations/store/get_store_product-categories_[id].ts index f6c58e03c0b4a..acd33920403ae 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_product-categories_[id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_product-categories_[id].ts @@ -28,20 +28,26 @@ * url: "#select-fields-and-relations" * - name: include_ancestors_tree * in: query - * description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`. + * description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass + * `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`. * required: false * schema: * type: boolean * title: include_ancestors_tree - * description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`. + * description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass + * `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`. * - name: include_descendants_tree * in: query - * description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the children of a category in this field. You can either pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, `fields=category_children.id,category_children.name`. + * description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the children of a category in this field. You can either + * pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, + * `fields=category_children.id,category_children.name`. * required: false * schema: * type: boolean * title: include_descendants_tree - * description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the children of a category in this field. You can either pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, `fields=category_children.id,category_children.name`. + * description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the children of a category in this field. You can either + * pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, + * `fields=category_children.id,category_children.name`. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateOrder.ts b/www/utils/generated/oas-output/schemas/AdminUpdateOrder.ts new file mode 100644 index 0000000000000..279ce39930ed1 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminUpdateOrder.ts @@ -0,0 +1,110 @@ +/** + * @schema AdminUpdateOrder + * type: object + * description: The details to update in the order. + * x-schemaName: AdminUpdateOrder + * properties: + * email: + * type: string + * title: email + * description: The order's email. + * format: email + * shipping_address: + * type: object + * description: The order's shipping address. + * properties: + * first_name: + * type: string + * title: first_name + * description: The address's first name. + * last_name: + * type: string + * title: last_name + * description: The address's last name. + * phone: + * type: string + * title: phone + * description: The address's phone. + * company: + * type: string + * title: company + * description: The address's company. + * address_1: + * type: string + * title: address_1 + * description: The address's first line. + * address_2: + * type: string + * title: address_2 + * description: The address's second line. + * city: + * type: string + * title: city + * description: The address's city. + * country_code: + * type: string + * title: country_code + * description: The address's country code. + * example: us + * province: + * type: string + * title: province + * description: The address's province. + * postal_code: + * type: string + * title: postal_code + * description: The address's postal code. + * metadata: + * type: object + * description: The address's metadata, can hold custom key-value pairs. + * billing_address: + * type: object + * description: The order's billing address. + * properties: + * first_name: + * type: string + * title: first_name + * description: The address's first name. + * last_name: + * type: string + * title: last_name + * description: The address's last name. + * phone: + * type: string + * title: phone + * description: The address's phone. + * company: + * type: string + * title: company + * description: The address's company. + * address_1: + * type: string + * title: address_1 + * description: The address's first line. + * address_2: + * type: string + * title: address_2 + * description: The address's second line. + * city: + * type: string + * title: city + * description: The address's city. + * country_code: + * type: string + * title: country_code + * description: The address's country code. + * example: us + * province: + * type: string + * title: province + * description: The address's province. + * postal_code: + * type: string + * title: postal_code + * description: The address's postal code. + * metadata: + * type: object + * description: The address's metadata, can hold custom key-value pairs. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseCalculatedPriceSet.ts b/www/utils/generated/oas-output/schemas/BaseCalculatedPriceSet.ts index a339bb81f87cb..ea2335d125a5f 100644 --- a/www/utils/generated/oas-output/schemas/BaseCalculatedPriceSet.ts +++ b/www/utils/generated/oas-output/schemas/BaseCalculatedPriceSet.ts @@ -53,63 +53,9 @@ * calculated_price: * type: object * description: The calculated price's details. - * properties: - * id: - * type: string - * title: id - * description: The ID of the price. - * price_list_id: - * type: string - * title: price_list_id - * description: The ID of the associated price list. - * price_list_type: - * type: string - * title: price_list_type - * description: The price list's type. For example, sale. - * min_quantity: - * type: number - * title: min_quantity - * description: The minimum quantity required in the cart for this price to apply. - * max_quantity: - * type: number - * title: max_quantity - * description: The maximum quantity allowed in the cart for this price to apply. - * required: - * - id - * - price_list_id - * - price_list_type - * - min_quantity - * - max_quantity * original_price: * type: object * description: The original price's details. - * properties: - * id: - * type: string - * title: id - * description: The ID of the price. - * price_list_id: - * type: string - * title: price_list_id - * description: The ID of the associated price list. - * price_list_type: - * type: string - * title: price_list_type - * description: The price list's type. For example, sale. - * min_quantity: - * type: number - * title: min_quantity - * description: The minimum quantity required in the cart for this price to apply. - * max_quantity: - * type: number - * title: max_quantity - * description: The maximum quantity allowed in the cart for this price to apply. - * required: - * - id - * - price_list_id - * - price_list_type - * - min_quantity - * - max_quantity * */ diff --git a/www/utils/generated/oas-output/schemas/StoreAddCartLineItem.ts b/www/utils/generated/oas-output/schemas/StoreAddCartLineItem.ts index fbef5c7a826b5..6d12167efef14 100644 --- a/www/utils/generated/oas-output/schemas/StoreAddCartLineItem.ts +++ b/www/utils/generated/oas-output/schemas/StoreAddCartLineItem.ts @@ -20,4 +20,3 @@ * description: The item's metadata, can hold custom key-value pairs. * */ -