diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml index ac9348920ece0..0d80349175377 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml @@ -10,3 +10,7 @@ properties: type: string title: internal_note description: A note viewed only by admin users. + unit_price: + type: number + title: unit_price + description: The item's unit price. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.yaml index f54ff35e99f22..bf3acfba0e409 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.yaml @@ -12,3 +12,7 @@ properties: type: string title: internal_note description: A note viewed only by admin users. + unit_price: + type: number + title: unit_price + description: The item's unit price. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateUser.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateUser.yaml index 2fc8ed46f581e..32e881a213587 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateUser.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateUser.yaml @@ -14,3 +14,6 @@ properties: type: string title: avatar_url description: The URL of the user's avatar. + metadata: + type: object + description: The user's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseCustomerAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseCustomerAddress.yaml deleted file mode 100644 index c894dbf6d0cbb..0000000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseCustomerAddress.yaml +++ /dev/null @@ -1,97 +0,0 @@ -type: object -description: The customer's address. -x-schemaName: BaseCustomerAddress -required: - - id - - address_name - - is_default_shipping - - is_default_billing - - customer_id - - company - - first_name - - last_name - - address_1 - - address_2 - - city - - country_code - - province - - postal_code - - phone - - metadata - - created_at - - updated_at -properties: - id: - type: string - title: id - description: The address's ID. - address_name: - type: string - title: address_name - description: The address's name. - is_default_shipping: - type: boolean - title: is_default_shipping - description: Whether the address is the default shipping address. - is_default_billing: - type: boolean - title: is_default_billing - description: Whether the address is the default billing address. - customer_id: - type: string - title: customer_id - description: The ID of the customer that this address belongs to. - 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 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. - phone: - type: string - title: phone - description: The address's phone. - metadata: - type: object - description: The address's metadata, used to store custom key-value pairs. - created_at: - type: string - format: date-time - title: created_at - description: The address's creation date. - updated_at: - type: string - format: date-time - title: updated_at - description: The address's update date. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderChangeAction.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderChangeAction.yaml deleted file mode 100644 index 476cad774420a..0000000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderChangeAction.yaml +++ /dev/null @@ -1,85 +0,0 @@ -type: object -description: The action's actions. -x-schemaName: BaseOrderChangeAction -properties: - order_change: - type: object - id: - type: string - title: id - description: The action's ID. - order_change_id: - type: string - title: order_change_id - description: The ID of the order change this action belongs to. - order_id: - type: string - title: order_id - description: The ID of the associated order. - reference: - type: string - title: reference - description: The name of the table this action applies on. - enum: - - claim - - exchange - - return - - order_shipping_method - reference_id: - type: string - title: reference_id - description: The ID of the record in the referenced table. - action: - type: string - title: action - description: The applied action. - details: - type: object - description: The action's details. - example: - reference_id: 123 - quantity: 1 - internal_note: - type: string - title: internal_note - description: A note viewed only by admin users. - created_at: - type: string - format: date-time - title: created_at - description: The date the order change action was created. - updated_at: - type: string - format: date-time - title: updated_at - description: The date the order change action was updated. - return_id: - type: string - title: return_id - description: The ID of the associated return. - claim_id: - type: string - title: claim_id - description: The ID of the associated claim. - exchange_id: - type: string - title: exchange_id - description: The ID of the associated exchange. - order: - $ref: ./BaseOrder.yaml -required: - - order_change - - id - - order_change_id - - order_id - - reference - - reference_id - - action - - details - - internal_note - - created_at - - updated_at - - return_id - - claim_id - - exchange_id - - order diff --git a/www/apps/api-reference/specs/admin/components/schemas/BasePromotion.yaml b/www/apps/api-reference/specs/admin/components/schemas/BasePromotion.yaml deleted file mode 100644 index 9715373b34ceb..0000000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/BasePromotion.yaml +++ /dev/null @@ -1,3 +0,0 @@ -type: object -description: The application method's promotion. -x-schemaName: BasePromotion diff --git a/www/apps/api-reference/specs/admin/components/schemas/BasePromotionRule.yaml b/www/apps/api-reference/specs/admin/components/schemas/BasePromotionRule.yaml deleted file mode 100644 index 26a4b19afbc5d..0000000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/BasePromotionRule.yaml +++ /dev/null @@ -1,35 +0,0 @@ -type: object -description: The rule's rules. -x-schemaName: BasePromotionRule -required: - - id - - values -properties: - id: - type: string - title: id - description: The rule's ID. - description: - type: string - title: description - description: The rule's description. - attribute: - type: string - title: attribute - description: The rule's attribute. - operator: - type: string - description: The rule's operator. - enum: - - gt - - lt - - eq - - ne - - in - - lte - - gte - values: - type: array - description: The rule's values. - items: - $ref: ./BasePromotionRuleValue.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/IBigNumber.yaml b/www/apps/api-reference/specs/admin/components/schemas/IBigNumber.yaml deleted file mode 100644 index 50cf33abe6818..0000000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/IBigNumber.yaml +++ /dev/null @@ -1,3 +0,0 @@ -type: object -description: The shipping method's discount tax total. -x-schemaName: IBigNumber diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreRegionCountry.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreRegionCountry.yaml deleted file mode 100644 index 9fd90340741cd..0000000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreRegionCountry.yaml +++ /dev/null @@ -1,32 +0,0 @@ -type: object -description: The country's details. -x-schemaName: StoreRegionCountry -required: - - id -properties: - id: - type: string - title: id - description: The country's ID. - iso_2: - type: string - title: iso_2 - description: The country's ISO 2 code. - example: us - iso_3: - type: string - title: iso_3 - description: The country's ISO 3 codel. - example: usa - num_code: - type: string - title: num_code - description: The country's num code. - name: - type: string - title: name - description: The country's name. - display_name: - type: string - title: display_name - description: The country's display name. diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml index 3672e9bbc1103..f04edd266752d 100644 --- a/www/apps/api-reference/specs/admin/openapi.full.yaml +++ b/www/apps/api-reference/specs/admin/openapi.full.yaml @@ -38192,8 +38192,8 @@ paths: 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. + 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 @@ -51050,6 +51050,10 @@ components: type: string title: internal_note description: A note viewed only by admin users. + unit_price: + type: number + title: unit_price + description: The item's unit price. AdminPostOrderEditsReqSchema: type: object description: The order edit's details. @@ -51129,6 +51133,10 @@ components: type: string title: internal_note description: A note viewed only by admin users. + unit_price: + type: number + title: unit_price + description: The item's unit price. AdminPostOrderExchangesReqSchema: type: object description: The exchange's details. @@ -53180,19 +53188,19 @@ components: exchange_id: type: string title: exchange_id - description: The ID of the exchange that this return belongs to. + description: The return's exchange id. location_id: type: string title: location_id - description: The ID of the location the items are returned to. + description: The return's location id. claim_id: type: string title: claim_id - description: The ID of the claim that this return belongs to. + description: The return's claim id. order_version: type: number title: order_version - description: The version of the order once the return is applied. + description: The return's order version. display_id: type: number title: display_id @@ -55150,6 +55158,9 @@ components: type: string title: avatar_url description: The URL of the user's avatar. + metadata: + type: object + description: The user's metadata, can hold custom key-value pairs. AdminUpdateVariantInventoryItem: type: object description: The properties to update of the variant's inventory item association. @@ -56318,104 +56329,6 @@ components: type: object description: The collection's details. x-schemaName: BaseCollection - BaseCustomerAddress: - type: object - description: The customer's address. - x-schemaName: BaseCustomerAddress - required: - - id - - address_name - - is_default_shipping - - is_default_billing - - customer_id - - company - - first_name - - last_name - - address_1 - - address_2 - - city - - country_code - - province - - postal_code - - phone - - metadata - - created_at - - updated_at - properties: - id: - type: string - title: id - description: The address's ID. - address_name: - type: string - title: address_name - description: The address's name. - is_default_shipping: - type: boolean - title: is_default_shipping - description: Whether the address is the default shipping address. - is_default_billing: - type: boolean - title: is_default_billing - description: Whether the address is the default billing address. - customer_id: - type: string - title: customer_id - description: The ID of the customer that this address belongs to. - 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 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. - phone: - type: string - title: phone - description: The address's phone. - metadata: - type: object - description: The address's metadata, used to store custom key-value pairs. - created_at: - type: string - format: date-time - title: created_at - description: The address's creation date. - updated_at: - type: string - format: date-time - title: updated_at - description: The address's update date. BaseExchangeItem: type: object description: The item's details. @@ -56911,92 +56824,6 @@ components: format: date-time title: updated_at description: The date the address was updated. - BaseOrderChangeAction: - type: object - description: The action's actions. - x-schemaName: BaseOrderChangeAction - properties: - order_change: - type: object - id: - type: string - title: id - description: The action's ID. - order_change_id: - type: string - title: order_change_id - description: The ID of the order change this action belongs to. - order_id: - type: string - title: order_id - description: The ID of the associated order. - reference: - type: string - title: reference - description: The name of the table this action applies on. - enum: - - claim - - exchange - - return - - order_shipping_method - reference_id: - type: string - title: reference_id - description: The ID of the record in the referenced table. - action: - type: string - title: action - description: The applied action. - details: - type: object - description: The action's details. - example: - reference_id: 123 - quantity: 1 - internal_note: - type: string - title: internal_note - description: A note viewed only by admin users. - created_at: - type: string - format: date-time - title: created_at - description: The date the order change action was created. - updated_at: - type: string - format: date-time - title: updated_at - description: The date the order change action was updated. - return_id: - type: string - title: return_id - description: The ID of the associated return. - claim_id: - type: string - title: claim_id - description: The ID of the associated claim. - exchange_id: - type: string - title: exchange_id - description: The ID of the associated exchange. - order: - $ref: '#/components/schemas/BaseOrder' - required: - - order_change - - id - - order_change_id - - order_id - - reference - - reference_id - - action - - details - - internal_note - - created_at - - updated_at - - return_id - - claim_id - - exchange_id - - order BaseOrderFulfillment: type: object description: The fulfillment's fulfillments. @@ -58532,46 +58359,6 @@ components: metadata: type: object description: The variant's metadata, can hold custom key-value pairs. - BasePromotion: - type: object - description: The application method's promotion. - x-schemaName: BasePromotion - BasePromotionRule: - type: object - description: The rule's rules. - x-schemaName: BasePromotionRule - required: - - id - - values - properties: - id: - type: string - title: id - description: The rule's ID. - description: - type: string - title: description - description: The rule's description. - attribute: - type: string - title: attribute - description: The rule's attribute. - operator: - type: string - description: The rule's operator. - enum: - - gt - - lt - - eq - - ne - - in - - lte - - gte - values: - type: array - description: The rule's values. - items: - $ref: '#/components/schemas/BasePromotionRuleValue' BasePromotionRuleValue: type: object description: The rule value's details. @@ -59390,10 +59177,6 @@ components: - unexpected_state - invalid_argument - unknown_error - IBigNumber: - type: object - description: The shipping method's discount tax total. - x-schemaName: IBigNumber InventoryLevel: type: object description: The inventory level's details @@ -64437,39 +64220,6 @@ components: format: date-time title: updated_at description: The date the region was updated. - StoreRegionCountry: - type: object - description: The country's details. - x-schemaName: StoreRegionCountry - required: - - id - properties: - id: - type: string - title: id - description: The country's ID. - iso_2: - type: string - title: iso_2 - description: The country's ISO 2 code. - example: us - iso_3: - type: string - title: iso_3 - description: The country's ISO 3 codel. - example: usa - num_code: - type: string - title: num_code - description: The country's num code. - name: - type: string - title: name - description: The country's name. - display_name: - type: string - title: display_name - description: The country's display name. StoreReturn: type: object description: The return's details. diff --git a/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}.yaml index 08513874bed51..649de15b198be 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}.yaml @@ -24,10 +24,13 @@ get: data. - name: fields in: query - 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. required: false schema: type: string diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml index ac9348920ece0..0d80349175377 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml @@ -10,3 +10,7 @@ properties: type: string title: internal_note description: A note viewed only by admin users. + unit_price: + type: number + title: unit_price + description: The item's unit price. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.yaml index f54ff35e99f22..bf3acfba0e409 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.yaml @@ -12,3 +12,7 @@ properties: type: string title: internal_note description: A note viewed only by admin users. + unit_price: + type: number + title: unit_price + description: The item's unit price. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateUser.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateUser.yaml index 2fc8ed46f581e..32e881a213587 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateUser.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateUser.yaml @@ -14,3 +14,6 @@ properties: type: string title: avatar_url description: The URL of the user's avatar. + metadata: + type: object + description: The user's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseCustomerAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseCustomerAddress.yaml deleted file mode 100644 index c894dbf6d0cbb..0000000000000 --- a/www/apps/api-reference/specs/store/components/schemas/BaseCustomerAddress.yaml +++ /dev/null @@ -1,97 +0,0 @@ -type: object -description: The customer's address. -x-schemaName: BaseCustomerAddress -required: - - id - - address_name - - is_default_shipping - - is_default_billing - - customer_id - - company - - first_name - - last_name - - address_1 - - address_2 - - city - - country_code - - province - - postal_code - - phone - - metadata - - created_at - - updated_at -properties: - id: - type: string - title: id - description: The address's ID. - address_name: - type: string - title: address_name - description: The address's name. - is_default_shipping: - type: boolean - title: is_default_shipping - description: Whether the address is the default shipping address. - is_default_billing: - type: boolean - title: is_default_billing - description: Whether the address is the default billing address. - customer_id: - type: string - title: customer_id - description: The ID of the customer that this address belongs to. - 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 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. - phone: - type: string - title: phone - description: The address's phone. - metadata: - type: object - description: The address's metadata, used to store custom key-value pairs. - created_at: - type: string - format: date-time - title: created_at - description: The address's creation date. - updated_at: - type: string - format: date-time - title: updated_at - description: The address's update date. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderChangeAction.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderChangeAction.yaml deleted file mode 100644 index 476cad774420a..0000000000000 --- a/www/apps/api-reference/specs/store/components/schemas/BaseOrderChangeAction.yaml +++ /dev/null @@ -1,85 +0,0 @@ -type: object -description: The action's actions. -x-schemaName: BaseOrderChangeAction -properties: - order_change: - type: object - id: - type: string - title: id - description: The action's ID. - order_change_id: - type: string - title: order_change_id - description: The ID of the order change this action belongs to. - order_id: - type: string - title: order_id - description: The ID of the associated order. - reference: - type: string - title: reference - description: The name of the table this action applies on. - enum: - - claim - - exchange - - return - - order_shipping_method - reference_id: - type: string - title: reference_id - description: The ID of the record in the referenced table. - action: - type: string - title: action - description: The applied action. - details: - type: object - description: The action's details. - example: - reference_id: 123 - quantity: 1 - internal_note: - type: string - title: internal_note - description: A note viewed only by admin users. - created_at: - type: string - format: date-time - title: created_at - description: The date the order change action was created. - updated_at: - type: string - format: date-time - title: updated_at - description: The date the order change action was updated. - return_id: - type: string - title: return_id - description: The ID of the associated return. - claim_id: - type: string - title: claim_id - description: The ID of the associated claim. - exchange_id: - type: string - title: exchange_id - description: The ID of the associated exchange. - order: - $ref: ./BaseOrder.yaml -required: - - order_change - - id - - order_change_id - - order_id - - reference - - reference_id - - action - - details - - internal_note - - created_at - - updated_at - - return_id - - claim_id - - exchange_id - - order diff --git a/www/apps/api-reference/specs/store/components/schemas/BasePromotion.yaml b/www/apps/api-reference/specs/store/components/schemas/BasePromotion.yaml deleted file mode 100644 index 9715373b34ceb..0000000000000 --- a/www/apps/api-reference/specs/store/components/schemas/BasePromotion.yaml +++ /dev/null @@ -1,3 +0,0 @@ -type: object -description: The application method's promotion. -x-schemaName: BasePromotion diff --git a/www/apps/api-reference/specs/store/components/schemas/BasePromotionRule.yaml b/www/apps/api-reference/specs/store/components/schemas/BasePromotionRule.yaml deleted file mode 100644 index 26a4b19afbc5d..0000000000000 --- a/www/apps/api-reference/specs/store/components/schemas/BasePromotionRule.yaml +++ /dev/null @@ -1,35 +0,0 @@ -type: object -description: The rule's rules. -x-schemaName: BasePromotionRule -required: - - id - - values -properties: - id: - type: string - title: id - description: The rule's ID. - description: - type: string - title: description - description: The rule's description. - attribute: - type: string - title: attribute - description: The rule's attribute. - operator: - type: string - description: The rule's operator. - enum: - - gt - - lt - - eq - - ne - - in - - lte - - gte - values: - type: array - description: The rule's values. - items: - $ref: ./BasePromotionRuleValue.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/IBigNumber.yaml b/www/apps/api-reference/specs/store/components/schemas/IBigNumber.yaml deleted file mode 100644 index 50cf33abe6818..0000000000000 --- a/www/apps/api-reference/specs/store/components/schemas/IBigNumber.yaml +++ /dev/null @@ -1,3 +0,0 @@ -type: object -description: The shipping method's discount tax total. -x-schemaName: IBigNumber diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreRegionCountry.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreRegionCountry.yaml deleted file mode 100644 index 9fd90340741cd..0000000000000 --- a/www/apps/api-reference/specs/store/components/schemas/StoreRegionCountry.yaml +++ /dev/null @@ -1,32 +0,0 @@ -type: object -description: The country's details. -x-schemaName: StoreRegionCountry -required: - - id -properties: - id: - type: string - title: id - description: The country's ID. - iso_2: - type: string - title: iso_2 - description: The country's ISO 2 code. - example: us - iso_3: - type: string - title: iso_3 - description: The country's ISO 3 codel. - example: usa - num_code: - type: string - title: num_code - description: The country's num code. - name: - type: string - title: name - description: The country's name. - display_name: - type: string - title: display_name - description: The country's display name. diff --git a/www/apps/api-reference/specs/store/openapi.full.yaml b/www/apps/api-reference/specs/store/openapi.full.yaml index 80879be0da62a..25ec9b80ea617 100644 --- a/www/apps/api-reference/specs/store/openapi.full.yaml +++ b/www/apps/api-reference/specs/store/openapi.full.yaml @@ -3464,6 +3464,7 @@ paths: security: - cookie_auth: [] - jwt_token: [] + x-workflow: getOrdersListWorkflow /store/orders/{id}: get: operationId: GetOrdersId @@ -3522,6 +3523,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: getOrderDetailWorkflow /store/payment-collections: post: operationId: PostPaymentCollections @@ -12636,6 +12638,10 @@ components: type: string title: internal_note description: A note viewed only by admin users. + unit_price: + type: number + title: unit_price + description: The item's unit price. AdminPostOrderEditsReqSchema: type: object description: The order edit's details. @@ -12715,6 +12721,10 @@ components: type: string title: internal_note description: A note viewed only by admin users. + unit_price: + type: number + title: unit_price + description: The item's unit price. AdminPostOrderExchangesReqSchema: type: object description: The exchange's details. @@ -14766,19 +14776,19 @@ components: exchange_id: type: string title: exchange_id - description: The ID of the exchange that this return belongs to. + description: The return's exchange id. location_id: type: string title: location_id - description: The ID of the location the items are returned to. + description: The return's location id. claim_id: type: string title: claim_id - description: The ID of the claim that this return belongs to. + description: The return's claim id. order_version: type: number title: order_version - description: The version of the order once the return is applied. + description: The return's order version. display_id: type: number title: display_id @@ -16736,6 +16746,9 @@ components: type: string title: avatar_url description: The URL of the user's avatar. + metadata: + type: object + description: The user's metadata, can hold custom key-value pairs. AdminUpdateVariantInventoryItem: type: object description: The properties to update of the variant's inventory item association. @@ -17904,104 +17917,6 @@ components: type: object description: The collection's details. x-schemaName: BaseCollection - BaseCustomerAddress: - type: object - description: The customer's address. - x-schemaName: BaseCustomerAddress - required: - - id - - address_name - - is_default_shipping - - is_default_billing - - customer_id - - company - - first_name - - last_name - - address_1 - - address_2 - - city - - country_code - - province - - postal_code - - phone - - metadata - - created_at - - updated_at - properties: - id: - type: string - title: id - description: The address's ID. - address_name: - type: string - title: address_name - description: The address's name. - is_default_shipping: - type: boolean - title: is_default_shipping - description: Whether the address is the default shipping address. - is_default_billing: - type: boolean - title: is_default_billing - description: Whether the address is the default billing address. - customer_id: - type: string - title: customer_id - description: The ID of the customer that this address belongs to. - 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 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. - phone: - type: string - title: phone - description: The address's phone. - metadata: - type: object - description: The address's metadata, used to store custom key-value pairs. - created_at: - type: string - format: date-time - title: created_at - description: The address's creation date. - updated_at: - type: string - format: date-time - title: updated_at - description: The address's update date. BaseExchangeItem: type: object description: The item's details. @@ -18497,92 +18412,6 @@ components: format: date-time title: updated_at description: The date the address was updated. - BaseOrderChangeAction: - type: object - description: The action's actions. - x-schemaName: BaseOrderChangeAction - properties: - order_change: - type: object - id: - type: string - title: id - description: The action's ID. - order_change_id: - type: string - title: order_change_id - description: The ID of the order change this action belongs to. - order_id: - type: string - title: order_id - description: The ID of the associated order. - reference: - type: string - title: reference - description: The name of the table this action applies on. - enum: - - claim - - exchange - - return - - order_shipping_method - reference_id: - type: string - title: reference_id - description: The ID of the record in the referenced table. - action: - type: string - title: action - description: The applied action. - details: - type: object - description: The action's details. - example: - reference_id: 123 - quantity: 1 - internal_note: - type: string - title: internal_note - description: A note viewed only by admin users. - created_at: - type: string - format: date-time - title: created_at - description: The date the order change action was created. - updated_at: - type: string - format: date-time - title: updated_at - description: The date the order change action was updated. - return_id: - type: string - title: return_id - description: The ID of the associated return. - claim_id: - type: string - title: claim_id - description: The ID of the associated claim. - exchange_id: - type: string - title: exchange_id - description: The ID of the associated exchange. - order: - $ref: '#/components/schemas/BaseOrder' - required: - - order_change - - id - - order_change_id - - order_id - - reference - - reference_id - - action - - details - - internal_note - - created_at - - updated_at - - return_id - - claim_id - - exchange_id - - order BaseOrderFulfillment: type: object description: The fulfillment's fulfillments. @@ -20118,46 +19947,6 @@ components: metadata: type: object description: The variant's metadata, can hold custom key-value pairs. - BasePromotion: - type: object - description: The application method's promotion. - x-schemaName: BasePromotion - BasePromotionRule: - type: object - description: The rule's rules. - x-schemaName: BasePromotionRule - required: - - id - - values - properties: - id: - type: string - title: id - description: The rule's ID. - description: - type: string - title: description - description: The rule's description. - attribute: - type: string - title: attribute - description: The rule's attribute. - operator: - type: string - description: The rule's operator. - enum: - - gt - - lt - - eq - - ne - - in - - lte - - gte - values: - type: array - description: The rule's values. - items: - $ref: '#/components/schemas/BasePromotionRuleValue' BasePromotionRuleValue: type: object description: The rule value's details. @@ -20976,10 +20765,6 @@ components: - unexpected_state - invalid_argument - unknown_error - IBigNumber: - type: object - description: The shipping method's discount tax total. - x-schemaName: IBigNumber InventoryLevel: type: object description: The inventory level's details @@ -26023,39 +25808,6 @@ components: format: date-time title: updated_at description: The date the region was updated. - StoreRegionCountry: - type: object - description: The country's details. - x-schemaName: StoreRegionCountry - required: - - id - properties: - id: - type: string - title: id - description: The country's ID. - iso_2: - type: string - title: iso_2 - description: The country's ISO 2 code. - example: us - iso_3: - type: string - title: iso_3 - description: The country's ISO 3 codel. - example: usa - num_code: - type: string - title: num_code - description: The country's num code. - name: - type: string - title: name - description: The country's name. - display_name: - type: string - title: display_name - description: The country's display name. StoreReturn: type: object description: The return's details. diff --git a/www/apps/api-reference/specs/store/paths/store_orders.yaml b/www/apps/api-reference/specs/store/paths/store_orders.yaml index b925e4ea8b3f0..ce0f9d7c2da06 100644 --- a/www/apps/api-reference/specs/store/paths/store_orders.yaml +++ b/www/apps/api-reference/specs/store/paths/store_orders.yaml @@ -195,3 +195,4 @@ get: security: - cookie_auth: [] - jwt_token: [] + x-workflow: getOrdersListWorkflow diff --git a/www/apps/api-reference/specs/store/paths/store_orders_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_orders_{id}.yaml index e912e58703a43..0007d5124ebc5 100644 --- a/www/apps/api-reference/specs/store/paths/store_orders_{id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_orders_{id}.yaml @@ -66,3 +66,4 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: getOrderDetailWorkflow diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_shipping-options_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_shipping-options_[id].ts index 32a0dc9a58868..012a1a58579fd 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_shipping-options_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_shipping-options_[id].ts @@ -23,8 +23,8 @@ * 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. + * 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 diff --git a/www/utils/generated/oas-output/operations/store/get_store_orders.ts b/www/utils/generated/oas-output/operations/store/get_store_orders.ts index a25edc86784d6..5062da4f2874e 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_orders.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_orders.ts @@ -180,6 +180,7 @@ * security: * - cookie_auth: [] * - jwt_token: [] + * x-workflow: getOrdersListWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/store/get_store_orders_[id].ts b/www/utils/generated/oas-output/operations/store/get_store_orders_[id].ts index 5cfc916fd39a1..7e0869fe162a1 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_orders_[id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_orders_[id].ts @@ -58,6 +58,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: getOrderDetailWorkflow * */ diff --git a/www/utils/generated/oas-output/schemas/AdminApplicationMethod.ts b/www/utils/generated/oas-output/schemas/AdminApplicationMethod.ts index fa370752ce5b7..6c5d7ff67084f 100644 --- a/www/utils/generated/oas-output/schemas/AdminApplicationMethod.ts +++ b/www/utils/generated/oas-output/schemas/AdminApplicationMethod.ts @@ -30,7 +30,8 @@ * - percentage * target_type: * type: string - * description: Which item does the promotion apply to. `items` mean the promotion applies to the cart's items; `shipping_methods` means the promotion applies to the cart's shipping methods; `order` means the promotion applies on the entire order. + * description: Which item does the promotion apply to. `items` mean the promotion applies to the cart's items; `shipping_methods` means the promotion applies to the cart's shipping methods; `order` + * means the promotion applies on the entire order. * enum: * - items * - shipping_methods diff --git a/www/utils/generated/oas-output/schemas/AdminPostOrderEditsItemsActionReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsItemsActionReqSchema.ts index 7879e1c60cd33..1edcddeb7b289 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostOrderEditsItemsActionReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsItemsActionReqSchema.ts @@ -12,6 +12,10 @@ * type: string * title: internal_note * description: A note viewed only by admin users. + * unit_price: + * type: number + * title: unit_price + * description: The item's unit price. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.ts index c059d6348db54..bedc1cbb76132 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.ts @@ -14,6 +14,10 @@ * type: string * title: internal_note * description: A note viewed only by admin users. + * unit_price: + * type: number + * title: unit_price + * description: The item's unit price. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPromotionRule.ts b/www/utils/generated/oas-output/schemas/AdminPromotionRule.ts index ef796e6cb7b24..18d6aafc6c1e7 100644 --- a/www/utils/generated/oas-output/schemas/AdminPromotionRule.ts +++ b/www/utils/generated/oas-output/schemas/AdminPromotionRule.ts @@ -35,7 +35,7 @@ * type: array * description: The rule's values. * example: - * - "cusgroup_123" + * - cusgroup_123 * items: * $ref: "#/components/schemas/BasePromotionRuleValue" * diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateUser.ts b/www/utils/generated/oas-output/schemas/AdminUpdateUser.ts index 1643df127e02b..ca576cd19437b 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateUser.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateUser.ts @@ -16,6 +16,9 @@ * type: string * title: avatar_url * description: The URL of the user's avatar. + * metadata: + * type: object + * description: The user's metadata, can hold custom key-value pairs. * */ diff --git a/www/utils/generated/oas-output/schemas/BaseCustomerAddress.ts b/www/utils/generated/oas-output/schemas/BaseCustomerAddress.ts deleted file mode 100644 index 953edf7e19348..0000000000000 --- a/www/utils/generated/oas-output/schemas/BaseCustomerAddress.ts +++ /dev/null @@ -1,102 +0,0 @@ -/** - * @schema BaseCustomerAddress - * type: object - * description: The customer's address. - * x-schemaName: BaseCustomerAddress - * required: - * - id - * - address_name - * - is_default_shipping - * - is_default_billing - * - customer_id - * - company - * - first_name - * - last_name - * - address_1 - * - address_2 - * - city - * - country_code - * - province - * - postal_code - * - phone - * - metadata - * - created_at - * - updated_at - * properties: - * id: - * type: string - * title: id - * description: The address's ID. - * address_name: - * type: string - * title: address_name - * description: The address's name. - * is_default_shipping: - * type: boolean - * title: is_default_shipping - * description: Whether the address is the default shipping address. - * is_default_billing: - * type: boolean - * title: is_default_billing - * description: Whether the address is the default billing address. - * customer_id: - * type: string - * title: customer_id - * description: The ID of the customer that this address belongs to. - * 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 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. - * phone: - * type: string - * title: phone - * description: The address's phone. - * metadata: - * type: object - * description: The address's metadata, used to store custom key-value pairs. - * created_at: - * type: string - * format: date-time - * title: created_at - * description: The address's creation date. - * updated_at: - * type: string - * format: date-time - * title: updated_at - * description: The address's update date. - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/BaseOrderChangeAction.ts b/www/utils/generated/oas-output/schemas/BaseOrderChangeAction.ts deleted file mode 100644 index e39982ab095f1..0000000000000 --- a/www/utils/generated/oas-output/schemas/BaseOrderChangeAction.ts +++ /dev/null @@ -1,89 +0,0 @@ -/** - * @schema BaseOrderChangeAction - * type: object - * description: The action's actions. - * x-schemaName: BaseOrderChangeAction - * properties: - * order_change: - * $ref: "#/components/schemas/AdminOrderChange" - * id: - * type: string - * title: id - * description: The action's ID. - * order_change_id: - * type: string - * title: order_change_id - * description: The ID of the order change this action belongs to. - * order_id: - * type: string - * title: order_id - * description: The ID of the associated order. - * reference: - * type: string - * title: reference - * description: The name of the table this action applies on. - * enum: - * - claim - * - exchange - * - return - * - order_shipping_method - * reference_id: - * type: string - * title: reference_id - * description: The ID of the record in the referenced table. - * action: - * type: string - * title: action - * description: The applied action. - * details: - * type: object - * description: The action's details. - * example: - * reference_id: 123 - * quantity: 1 - * internal_note: - * type: string - * title: internal_note - * description: A note viewed only by admin users. - * created_at: - * type: string - * format: date-time - * title: created_at - * description: The date the order change action was created. - * updated_at: - * type: string - * format: date-time - * title: updated_at - * description: The date the order change action was updated. - * return_id: - * type: string - * title: return_id - * description: The ID of the associated return. - * claim_id: - * type: string - * title: claim_id - * description: The ID of the associated claim. - * exchange_id: - * type: string - * title: exchange_id - * description: The ID of the associated exchange. - * order: - * $ref: "#/components/schemas/BaseOrder" - * required: - * - order_change - * - id - * - order_change_id - * - order_id - * - reference - * - reference_id - * - action - * - details - * - internal_note - * - created_at - * - updated_at - * - return_id - * - claim_id - * - exchange_id - * - order - * -*/ diff --git a/www/utils/generated/oas-output/schemas/BasePromotion.ts b/www/utils/generated/oas-output/schemas/BasePromotion.ts deleted file mode 100644 index 09762d74c9fff..0000000000000 --- a/www/utils/generated/oas-output/schemas/BasePromotion.ts +++ /dev/null @@ -1,8 +0,0 @@ -/** - * @schema BasePromotion - * type: object - * description: The application method's promotion. - * x-schemaName: BasePromotion - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/BasePromotionRule.ts b/www/utils/generated/oas-output/schemas/BasePromotionRule.ts deleted file mode 100644 index 5d8b4d5730ed5..0000000000000 --- a/www/utils/generated/oas-output/schemas/BasePromotionRule.ts +++ /dev/null @@ -1,40 +0,0 @@ -/** - * @schema BasePromotionRule - * type: object - * description: The rule's rules. - * x-schemaName: BasePromotionRule - * required: - * - id - * - values - * properties: - * id: - * type: string - * title: id - * description: The rule's ID. - * description: - * type: string - * title: description - * description: The rule's description. - * attribute: - * type: string - * title: attribute - * description: The rule's attribute. - * operator: - * type: string - * description: The rule's operator. - * enum: - * - gt - * - lt - * - eq - * - ne - * - in - * - lte - * - gte - * values: - * type: array - * description: The rule's values. - * items: - * $ref: "#/components/schemas/BasePromotionRuleValue" - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/IBigNumber.ts b/www/utils/generated/oas-output/schemas/IBigNumber.ts deleted file mode 100644 index c49fb6b3b24d0..0000000000000 --- a/www/utils/generated/oas-output/schemas/IBigNumber.ts +++ /dev/null @@ -1,8 +0,0 @@ -/** - * @schema IBigNumber - * type: object - * description: The shipping method's discount tax total. - * x-schemaName: IBigNumber - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/StoreRegionCountry.ts b/www/utils/generated/oas-output/schemas/StoreRegionCountry.ts deleted file mode 100644 index a55d5d34eda87..0000000000000 --- a/www/utils/generated/oas-output/schemas/StoreRegionCountry.ts +++ /dev/null @@ -1,37 +0,0 @@ -/** - * @schema StoreRegionCountry - * type: object - * description: The country's details. - * x-schemaName: StoreRegionCountry - * required: - * - id - * properties: - * id: - * type: string - * title: id - * description: The country's ID. - * iso_2: - * type: string - * title: iso_2 - * description: The country's ISO 2 code. - * example: us - * iso_3: - * type: string - * title: iso_3 - * description: The country's ISO 3 codel. - * example: usa - * num_code: - * type: string - * title: num_code - * description: The country's num code. - * name: - * type: string - * title: name - * description: The country's name. - * display_name: - * type: string - * title: display_name - * description: The country's display name. - * -*/ -