chore(docs): Updated API Reference (v2) (#9437)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
1 parent
97c193be1b
commit
21badd069d
894 files changed
+35649
-28168
No files matched your search
@@ -60,7 +60,7 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* x-workflow: deleteCustomersWorkflow
|
||||
* x-workflow: removeCustomerAccountWorkflow
|
||||
*
|
||||
*/
|
||||
|
||||
-20
@@ -21,26 +21,6 @@
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* - name: expand
|
||||
* in: query
|
||||
* description: Comma-separated relations that should be expanded in the returned data.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: expand
|
||||
* description: Comma-separated relations that should be expanded in the returned data.
|
||||
* - name: fields
|
||||
* in: query
|
||||
* description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
|
||||
* fields. without prefix it will replace the entire default fields.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
|
||||
* fields. without prefix it will replace the entire default fields.
|
||||
* externalDocs:
|
||||
* url: "#select-fields-and-relations"
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
|
||||
@@ -36,7 +36,7 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* x-workflow: deleteUsersWorkflow
|
||||
* x-workflow: removeUserAccountWorkflow
|
||||
*
|
||||
*/
|
||||
|
||||
+1
-3
@@ -3,12 +3,10 @@
|
||||
* operationId: GetPromotionsIdRule_type
|
||||
* summary: List Rules of a Promotion
|
||||
* x-sidebar-summary: List Rules
|
||||
* description: >
|
||||
* description: |
|
||||
* Retrieve a list of rules in a promotion. The type of rules retrieved depend on the value of the `rule_type` path parameter:
|
||||
*
|
||||
* - If `rule_type` is `rules`, the promotion's rules are retrivied. - If `rule_type` is `target-rules`, the target rules of the promotion's application method are retrieved.
|
||||
*
|
||||
*
|
||||
* - If `rule_type` is `buy-rules`, the buy rules of the promotion's application method are retrieved.
|
||||
* x-authenticated: true
|
||||
* parameters:
|
||||
|
||||
@@ -0,0 +1,69 @@
|
||||
/**
|
||||
* @oas [get] /admin/shipping-options/{id}
|
||||
* operationId: GetShippingOptionsId
|
||||
* summary: Get a Shipping Option
|
||||
* description: Retrieve a shipping option by its ID. You can expand the shipping option's relations or select the fields that should be returned.
|
||||
* x-authenticated: true
|
||||
* parameters:
|
||||
* - name: id
|
||||
* in: path
|
||||
* description: The shipping option's ID.
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* - name: expand
|
||||
* in: query
|
||||
* description: Comma-separated relations that should be expanded in the returned data.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: expand
|
||||
* description: Comma-separated relations that should be expanded in the returned data.
|
||||
* - name: fields
|
||||
* in: query
|
||||
* description: |-
|
||||
* Comma-separated fields that should be included in the returned data.
|
||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||
* * without prefix it will replace the entire default fields.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
|
||||
* fields. without prefix it will replace the entire default fields.
|
||||
* externalDocs:
|
||||
* url: "#select-fields-and-relations"
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* - jwt_token: []
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |-
|
||||
* curl '{backend_url}/admin/shipping-options/{id}' \
|
||||
* -H 'Authorization: Bearer {access_token}'
|
||||
* tags:
|
||||
* - Shipping Options
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminShippingOptionResponse"
|
||||
* "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"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -63,10 +63,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
* x-workflow: confirmClaimRequestWorkflow
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -63,10 +63,6 @@
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* x-workflow: confirmExchangeRequestWorkflow
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -56,10 +56,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
* x-workflow: refreshInviteTokensWorkflow
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -62,10 +62,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -35,11 +35,6 @@
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* - jwt_token: []
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminArchiveOrder"
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
|
||||
@@ -70,10 +70,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
* x-workflow: cancelOrderWorkflow
|
||||
*
|
||||
*/
|
||||
|
||||
-5
@@ -42,11 +42,6 @@
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* - jwt_token: []
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminMarkOrderFulfillmentDelivered"
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
|
||||
+1
-1
@@ -31,8 +31,8 @@
|
||||
* description: A price's details.
|
||||
* required:
|
||||
* - currency_code
|
||||
* - amount
|
||||
* - variant_id
|
||||
* - amount
|
||||
* properties:
|
||||
* currency_code:
|
||||
* type: string
|
||||
|
||||
@@ -33,7 +33,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminCreateProduct"
|
||||
* $ref: "#/components/schemas/AdminCreateProductType"
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
|
||||
+5
-5
@@ -30,9 +30,9 @@
|
||||
* type: object
|
||||
* description: The associations to create between a product variant and an inventory item.
|
||||
* required:
|
||||
* - required_quantity
|
||||
* - inventory_item_id
|
||||
* - variant_id
|
||||
* - inventory_item_id
|
||||
* - required_quantity
|
||||
* properties:
|
||||
* required_quantity:
|
||||
* type: number
|
||||
@@ -53,9 +53,9 @@
|
||||
* type: object
|
||||
* description: Update a product variant's association with an inventory item.
|
||||
* required:
|
||||
* - required_quantity
|
||||
* - inventory_item_id
|
||||
* - variant_id
|
||||
* - inventory_item_id
|
||||
* - required_quantity
|
||||
* properties:
|
||||
* required_quantity:
|
||||
* type: number
|
||||
@@ -76,8 +76,8 @@
|
||||
* type: object
|
||||
* description: Delete a product variant's association with an inventory item.
|
||||
* required:
|
||||
* - inventory_item_id
|
||||
* - variant_id
|
||||
* - inventory_item_id
|
||||
* properties:
|
||||
* inventory_item_id:
|
||||
* type: string
|
||||
|
||||
+2
-83
@@ -47,93 +47,12 @@
|
||||
* type: array
|
||||
* description: The buy rules to create.
|
||||
* items:
|
||||
* type: object
|
||||
* description: A buy rule's details.
|
||||
* required:
|
||||
* - operator
|
||||
* - attribute
|
||||
* - values
|
||||
* properties:
|
||||
* operator:
|
||||
* type: string
|
||||
* description: The operator used to check whether the buy rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value.
|
||||
* enum:
|
||||
* - gte
|
||||
* - lte
|
||||
* - gt
|
||||
* - lt
|
||||
* - eq
|
||||
* - ne
|
||||
* - in
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The buy rule's description.
|
||||
* attribute:
|
||||
* type: string
|
||||
* title: attribute
|
||||
* description: The attribute to compare against when checking whether a promotion can be applied on a cart.
|
||||
* example: items.product.id
|
||||
* values:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: values
|
||||
* description: The attribute's value.
|
||||
* example: prod_123
|
||||
* - type: array
|
||||
* description: The allowed attribute values.
|
||||
* items:
|
||||
* type: string
|
||||
* title: values
|
||||
* description: An attribute value.
|
||||
* example: prod_123
|
||||
* $ref: "#/components/schemas/AdminCreatePromotionRule"
|
||||
* update:
|
||||
* type: array
|
||||
* description: The buy rules to update.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The properties to update in a buy rule.
|
||||
* required:
|
||||
* - id
|
||||
* - values
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The buy rule's ID.
|
||||
* operator:
|
||||
* type: string
|
||||
* description: The operator used to check whether the buy rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value.
|
||||
* enum:
|
||||
* - gte
|
||||
* - lte
|
||||
* - gt
|
||||
* - lt
|
||||
* - eq
|
||||
* - ne
|
||||
* - in
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The buy rule's description.
|
||||
* attribute:
|
||||
* type: string
|
||||
* title: attribute
|
||||
* description: The attribute to compare against when checking whether a promotion can be applied on a cart.
|
||||
* example: items.product.id
|
||||
* values:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: values
|
||||
* description: The attribute's value.
|
||||
* example: prod_123
|
||||
* - type: array
|
||||
* description: The allowed attribute values.
|
||||
* items:
|
||||
* type: string
|
||||
* title: values
|
||||
* description: An attribute value.
|
||||
* example: prod_123
|
||||
* $ref: "#/components/schemas/AdminUpdatePromotionRule"
|
||||
* delete:
|
||||
* type: array
|
||||
* description: The buy rules to delete.
|
||||
|
||||
+2
-83
@@ -47,93 +47,12 @@
|
||||
* type: array
|
||||
* description: The rules to create.
|
||||
* items:
|
||||
* type: object
|
||||
* description: A rule's details.
|
||||
* required:
|
||||
* - operator
|
||||
* - attribute
|
||||
* - values
|
||||
* properties:
|
||||
* operator:
|
||||
* type: string
|
||||
* description: The operator used to check whether the rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value.
|
||||
* enum:
|
||||
* - gte
|
||||
* - lte
|
||||
* - gt
|
||||
* - lt
|
||||
* - eq
|
||||
* - ne
|
||||
* - in
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The rule's description.
|
||||
* attribute:
|
||||
* type: string
|
||||
* title: attribute
|
||||
* description: The attribute to compare against when checking whether a promotion can be applied on a cart.
|
||||
* example: items.product.id
|
||||
* values:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: values
|
||||
* description: The attribute's value.
|
||||
* example: prod_123
|
||||
* - type: array
|
||||
* description: The allowed attribute values.
|
||||
* items:
|
||||
* type: string
|
||||
* title: values
|
||||
* description: An attribute value.
|
||||
* example: prod_123
|
||||
* $ref: "#/components/schemas/AdminCreatePromotionRule"
|
||||
* update:
|
||||
* type: array
|
||||
* description: The rules to update.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The properties to update in a rule.
|
||||
* required:
|
||||
* - id
|
||||
* - values
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The rule's ID.
|
||||
* operator:
|
||||
* type: string
|
||||
* description: The operator used to check whether the rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value.
|
||||
* enum:
|
||||
* - gte
|
||||
* - lte
|
||||
* - gt
|
||||
* - lt
|
||||
* - eq
|
||||
* - ne
|
||||
* - in
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The rule's description.
|
||||
* attribute:
|
||||
* type: string
|
||||
* title: attribute
|
||||
* description: The attribute to compare against when checking whether a promotion can be applied on a cart.
|
||||
* example: items.product.id
|
||||
* values:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: values
|
||||
* description: The attribute's value.
|
||||
* example: prod_123
|
||||
* - type: array
|
||||
* description: The allowed attribute values.
|
||||
* items:
|
||||
* type: string
|
||||
* title: values
|
||||
* description: An attribute value.
|
||||
* example: prod_123
|
||||
* $ref: "#/components/schemas/AdminUpdatePromotionRule"
|
||||
* delete:
|
||||
* type: array
|
||||
* description: The rules to delete.
|
||||
|
||||
+2
-83
@@ -47,93 +47,12 @@
|
||||
* type: array
|
||||
* description: The target rules to create.
|
||||
* items:
|
||||
* type: object
|
||||
* description: A target rule's details.
|
||||
* required:
|
||||
* - operator
|
||||
* - attribute
|
||||
* - values
|
||||
* properties:
|
||||
* operator:
|
||||
* type: string
|
||||
* description: The operator used to check whether the target rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value.
|
||||
* enum:
|
||||
* - gte
|
||||
* - lte
|
||||
* - gt
|
||||
* - lt
|
||||
* - eq
|
||||
* - ne
|
||||
* - in
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The target rule's description.
|
||||
* attribute:
|
||||
* type: string
|
||||
* title: attribute
|
||||
* description: The attribute to compare against when checking whether a promotion can be applied on a cart.
|
||||
* example: items.product.id
|
||||
* values:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: values
|
||||
* description: The attribute's value.
|
||||
* example: prod_123
|
||||
* - type: array
|
||||
* description: The allowed attribute values.
|
||||
* items:
|
||||
* type: string
|
||||
* title: values
|
||||
* description: An attribute value.
|
||||
* example: prod_123
|
||||
* $ref: "#/components/schemas/AdminCreatePromotionRule"
|
||||
* update:
|
||||
* type: array
|
||||
* description: The target rules to update.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The properties to update in a target rule.
|
||||
* required:
|
||||
* - id
|
||||
* - values
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The target rule's ID.
|
||||
* operator:
|
||||
* type: string
|
||||
* description: The operator used to check whether the target rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value.
|
||||
* enum:
|
||||
* - gte
|
||||
* - lte
|
||||
* - gt
|
||||
* - lt
|
||||
* - eq
|
||||
* - ne
|
||||
* - in
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The target rule's description.
|
||||
* attribute:
|
||||
* type: string
|
||||
* title: attribute
|
||||
* description: The attribute to compare against when checking whether a promotion can be applied on a cart.
|
||||
* example: items.product.id
|
||||
* values:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: values
|
||||
* description: The attribute's value.
|
||||
* example: prod_123
|
||||
* - type: array
|
||||
* description: The allowed attribute values.
|
||||
* items:
|
||||
* type: string
|
||||
* title: values
|
||||
* description: An attribute value.
|
||||
* example: prod_123
|
||||
* $ref: "#/components/schemas/AdminUpdatePromotionRule"
|
||||
* delete:
|
||||
* type: array
|
||||
* description: The target rules to delete.
|
||||
|
||||
@@ -33,7 +33,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/CreateOrderReturnReason"
|
||||
* $ref: "#/components/schemas/AdminCreateReturnReason"
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
|
||||
@@ -39,7 +39,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/UpdateOrderReturnReason"
|
||||
* $ref: "#/components/schemas/AdminUpdateReturnReason"
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
|
||||
@@ -71,9 +71,9 @@
|
||||
* type: object
|
||||
* description: The shipping option's type.
|
||||
* required:
|
||||
* - label
|
||||
* - description
|
||||
* - code
|
||||
* - description
|
||||
* - label
|
||||
* properties:
|
||||
* label:
|
||||
* type: string
|
||||
|
||||
+2
-79
@@ -47,89 +47,12 @@
|
||||
* type: array
|
||||
* description: The shipping option rules to create.
|
||||
* items:
|
||||
* type: object
|
||||
* description: A shipping option's details.
|
||||
* required:
|
||||
* - operator
|
||||
* - attribute
|
||||
* - value
|
||||
* properties:
|
||||
* operator:
|
||||
* type: string
|
||||
* description: The operator used to check whether a rule applies.
|
||||
* enum:
|
||||
* - in
|
||||
* - eq
|
||||
* - ne
|
||||
* - gt
|
||||
* - gte
|
||||
* - lt
|
||||
* - lte
|
||||
* - nin
|
||||
* attribute:
|
||||
* type: string
|
||||
* title: attribute
|
||||
* description: The name of a property or table that the rule applies to.
|
||||
* example: customer_group
|
||||
* value:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: value
|
||||
* description: A value of the attribute that enables this rule.
|
||||
* example: cusgroup_123
|
||||
* - type: array
|
||||
* description: Values of the attribute that enable this rule.
|
||||
* items:
|
||||
* type: string
|
||||
* title: value
|
||||
* description: A value of the attribute that enables this rule.
|
||||
* example: cusgroup_123
|
||||
* $ref: "#/components/schemas/AdminCreateShippingOptionRule"
|
||||
* update:
|
||||
* type: array
|
||||
* description: The shipping option rules to update.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The properties to update in the shipping option rule.
|
||||
* required:
|
||||
* - id
|
||||
* - operator
|
||||
* - attribute
|
||||
* - value
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The rule's ID.
|
||||
* operator:
|
||||
* type: string
|
||||
* description: The operator used to check whether a rule applies.
|
||||
* enum:
|
||||
* - in
|
||||
* - eq
|
||||
* - ne
|
||||
* - gt
|
||||
* - gte
|
||||
* - lt
|
||||
* - lte
|
||||
* - nin
|
||||
* attribute:
|
||||
* type: string
|
||||
* title: attribute
|
||||
* description: The name of a property or table that the rule applies to.
|
||||
* example: customer_group
|
||||
* value:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: value
|
||||
* description: A value of the attribute that enables this rule.
|
||||
* example: cusgroup_123
|
||||
* - type: array
|
||||
* description: Values of the attribute that enable this rule.
|
||||
* items:
|
||||
* type: string
|
||||
* title: value
|
||||
* description: A value of the attribute that enables this rule.
|
||||
* example: cusgroup_123
|
||||
* $ref: "#/components/schemas/AdminUpdateShippingOptionRule"
|
||||
* delete:
|
||||
* type: array
|
||||
* description: The shipping option rules to delete.
|
||||
|
||||
+1
-1
@@ -43,8 +43,8 @@
|
||||
* type: object
|
||||
* description: The fulfillment set to create.
|
||||
* required:
|
||||
* - name
|
||||
* - type
|
||||
* - name
|
||||
* properties:
|
||||
* name:
|
||||
* type: string
|
||||
|
||||
-4
@@ -36,10 +36,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
-4
@@ -36,10 +36,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
-4
@@ -36,10 +36,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
+5
-2
@@ -24,8 +24,6 @@
|
||||
* tags:
|
||||
* - "[actor_type]"
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -39,6 +37,11 @@
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* x-workflow: generateResetPasswordTokenWorkflow
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/ResetPasswordRequest"
|
||||
*
|
||||
*/
|
||||
|
||||
-2
@@ -24,8 +24,6 @@
|
||||
* tags:
|
||||
* - "[actor_type]"
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
|
||||
@@ -23,10 +23,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -4,7 +4,6 @@
|
||||
* summary: Create Token
|
||||
* description: Create a token.
|
||||
* x-authenticated: false
|
||||
* parameters: []
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
@@ -12,8 +11,6 @@
|
||||
* tags:
|
||||
* - Token
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
|
||||
@@ -30,10 +30,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
+1
-1
@@ -71,7 +71,7 @@
|
||||
* type: string
|
||||
* title: object
|
||||
* description: The name of the deleted object.
|
||||
* default: "line-item"
|
||||
* default: line-item
|
||||
* deleted:
|
||||
* type: boolean
|
||||
* title: deleted
|
||||
|
||||
+1
-1
@@ -69,7 +69,7 @@
|
||||
* type: string
|
||||
* title: object
|
||||
* description: The name of the deleted object.
|
||||
* default: "address"
|
||||
* default: address
|
||||
* deleted:
|
||||
* type: boolean
|
||||
* title: deleted
|
||||
|
||||
@@ -883,14 +883,6 @@
|
||||
* externalDocs:
|
||||
* url: https://docs.medusajs.com/v2/resources/storefront-development/products/price/examples/tax-price
|
||||
* description: "Storefront guide: How to show product variants' prices with taxes."
|
||||
* - name: country_code
|
||||
* in: query
|
||||
* description: The country code the products are being viewed from. This is required if you're retrieving product variant prices with taxes.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: country_code
|
||||
* description: The country code the products are being viewed from. This is required if you're retrieving product variant prices with taxes.
|
||||
* - name: province
|
||||
* in: query
|
||||
* description: The province the products are being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes.
|
||||
@@ -899,14 +891,6 @@
|
||||
* type: string
|
||||
* title: province
|
||||
* description: The province the products are being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes.
|
||||
* - name: cart_id
|
||||
* in: query
|
||||
* description: The ID of the customer's cart. If set, the cart's region and shipping address's country code and province are used instead of the `region_id`, `country_code`, and `province` properties.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: cart_id
|
||||
* description: The ID of the customer's cart. If set, the cart's region and shipping address's country code and province are used instead of the `region_id`, `country_code`, and `province` properties.
|
||||
* - name: sales_channel_id
|
||||
* in: query
|
||||
* required: false
|
||||
@@ -935,6 +919,38 @@
|
||||
* type: string
|
||||
* title: category_id
|
||||
* description: A product category's ID.
|
||||
* - name: currency_code
|
||||
* in: query
|
||||
* description: The currency code to retrieve prices in.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: currency_code
|
||||
* description: The currency code to retrieve prices in.
|
||||
* - name: variants
|
||||
* in: query
|
||||
* description: Filter the products' variants.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: Filter the products' variants.
|
||||
* x-schemaName: StoreProductVariantParams
|
||||
* properties:
|
||||
* options:
|
||||
* type: object
|
||||
* description: Filter by the variants' options.
|
||||
* required:
|
||||
* - value
|
||||
* - option_id
|
||||
* properties:
|
||||
* option_id:
|
||||
* type: string
|
||||
* title: option_id
|
||||
* description: The ID of the option to filter by.
|
||||
* value:
|
||||
* type: string
|
||||
* title: value
|
||||
* description: Filter by a value of the option.
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
|
||||
@@ -34,8 +34,7 @@
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |-
|
||||
* curl '{backend_url}/store/regions/{id}'
|
||||
* source: curl '{backend_url}/store/regions/{id}'
|
||||
* tags:
|
||||
* - Regions
|
||||
* responses:
|
||||
|
||||
@@ -2,10 +2,9 @@
|
||||
* @oas [get] /store/shipping-options
|
||||
* operationId: GetShippingOptions
|
||||
* summary: List Shipping Options for Cart
|
||||
* description: >
|
||||
* description: |
|
||||
* Retrieve a list of shipping options for a cart. The cart's ID is set in the required `cart_id` query parameter.
|
||||
*
|
||||
*
|
||||
* The shipping options also be sorted or paginated.
|
||||
* externalDocs:
|
||||
* url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/shipping
|
||||
|
||||
@@ -96,8 +96,8 @@
|
||||
* type: string
|
||||
* title: type
|
||||
* description: >
|
||||
* The error's type. Can be a [MedusaError type](https://docs.medusajs.com/v2/advanced-development/api-routes/errors#medusaerror-types)
|
||||
* or `payment_authorization_error` or `payment_requires_more_error` for payment-related errors.
|
||||
* The error's type. Can be a [MedusaError type](https://docs.medusajs.com/v2/advanced-development/api-routes/errors#medusaerror-types) or `payment_authorization_error` or
|
||||
* `payment_requires_more_error` for payment-related errors.
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
|
||||
@@ -70,6 +70,9 @@
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* x-workflow: createCustomerAccountWorkflow
|
||||
* security:
|
||||
* - cookie_auth: []
|
||||
* - jwt_token: []
|
||||
*
|
||||
*/
|
||||
|
||||
+2
-1
@@ -3,7 +3,8 @@
|
||||
* operationId: PostPaymentCollectionsIdPaymentSessions
|
||||
* summary: Initialize Payment Session of a Payment Collection
|
||||
* x-sidebar-summary: Initialize Payment Session
|
||||
* description: Initialize and add a payment session to a payment collection. This is used during checkout, where you create a payment collection for the cart, then initialize a payment session for the payment provider that the customer chooses.
|
||||
* description: Initialize and add a payment session to a payment collection. This is used during checkout, where you create a payment collection for the cart, then initialize a payment session for the
|
||||
* payment provider that the customer chooses.
|
||||
* externalDocs:
|
||||
* url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment
|
||||
* description: "Storefront guide: How to implement payment during checkout."
|
||||
|
||||
@@ -1,15 +0,0 @@
|
||||
/**
|
||||
* @schema AdminArchiveOrder
|
||||
* type: object
|
||||
* description: The archive details.
|
||||
* x-schemaName: AdminArchiveOrder
|
||||
* required:
|
||||
* - order_id
|
||||
* properties:
|
||||
* order_id:
|
||||
* type: string
|
||||
* title: order_id
|
||||
* description: The order's order id.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -58,8 +58,8 @@
|
||||
* type:
|
||||
* type: string
|
||||
* description: >
|
||||
* The budget's type. `spend` means the limit is set on the total amount discounted by the campaign's promotions; `usage` means the limit is set on the total
|
||||
* number of times the campaign's promotions can be used.
|
||||
* The budget's type. `spend` means the limit is set on the total amount discounted by the campaign's promotions; `usage` means the limit is set on the total number of times the campaign's
|
||||
* promotions can be used.
|
||||
* enum:
|
||||
* - spend
|
||||
* - usage
|
||||
@@ -75,8 +75,8 @@
|
||||
* type: number
|
||||
* title: used
|
||||
* description: >
|
||||
* How much of the budget has been used. If the limit is `spend`, this property holds the total amount discounted so far. If the limit is `usage`, it holds
|
||||
* the number of times the campaign's promotions have been used so far.
|
||||
* How much of the budget has been used. If the limit is `spend`, this property holds the total amount discounted so far. If the limit is `usage`, it holds the number of times the campaign's
|
||||
* promotions have been used so far.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
* - claim
|
||||
* properties:
|
||||
* order_preview:
|
||||
* $ref: "#/components/schemas/OrderPreview"
|
||||
* $ref: "#/components/schemas/AdminOrderPreview"
|
||||
* claim:
|
||||
* $ref: "#/components/schemas/AdminClaim"
|
||||
*
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
* return:
|
||||
* $ref: "#/components/schemas/AdminReturn"
|
||||
* order_preview:
|
||||
* $ref: "#/components/schemas/OrderPreview"
|
||||
* $ref: "#/components/schemas/AdminOrderPreview"
|
||||
* claim:
|
||||
* $ref: "#/components/schemas/AdminClaim"
|
||||
*
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
* - return
|
||||
* properties:
|
||||
* order_preview:
|
||||
* $ref: "#/components/schemas/OrderPreview"
|
||||
* $ref: "#/components/schemas/AdminOrderPreview"
|
||||
* return:
|
||||
* $ref: "#/components/schemas/AdminReturn"
|
||||
*
|
||||
|
||||
@@ -1,66 +0,0 @@
|
||||
/**
|
||||
* @schema AdminCreateApplicationMethod
|
||||
* type: object
|
||||
* description: The application method's details.
|
||||
* x-schemaName: AdminCreateApplicationMethod
|
||||
* required:
|
||||
* - value
|
||||
* - type
|
||||
* - target_type
|
||||
* properties:
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The application method's description.
|
||||
* value:
|
||||
* type: number
|
||||
* title: value
|
||||
* description: The discounted amount applied by the associated promotion based on the `type`.
|
||||
* currency_code:
|
||||
* type: string
|
||||
* title: currency_code
|
||||
* description: The application method's currency code.
|
||||
* max_quantity:
|
||||
* type: number
|
||||
* title: max_quantity
|
||||
* description: The max quantity allowed in the cart for the associated promotion to be applied.
|
||||
* type:
|
||||
* type: string
|
||||
* description: The type of the application method indicating how the associated promotion is applied.
|
||||
* enum:
|
||||
* - fixed
|
||||
* - percentage
|
||||
* target_type:
|
||||
* type: string
|
||||
* description: The target type of the application method indicating whether the associated promotion is applied to the cart's items, shipping methods, or the whole order.
|
||||
* enum:
|
||||
* - items
|
||||
* - shipping_methods
|
||||
* - order
|
||||
* allocation:
|
||||
* type: string
|
||||
* description: The allocation value that indicates whether the associated promotion is applied on each item in a cart or split between the items in the cart.
|
||||
* enum:
|
||||
* - each
|
||||
* - across
|
||||
* target_rules:
|
||||
* type: array
|
||||
* description: The application method's target rules.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminCreatePromotionRule"
|
||||
* buy_rules:
|
||||
* type: array
|
||||
* description: The application method's buy rules.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminCreatePromotionRule"
|
||||
* apply_to_quantity:
|
||||
* type: number
|
||||
* title: apply_to_quantity
|
||||
* description: The quantity that results from matching the `buyget` promotion's condition. For example, if the promotion is a "Buy 2 shirts get 1 free", the value f this attribute is `1`.
|
||||
* buy_rules_min_quantity:
|
||||
* type: number
|
||||
* title: buy_rules_min_quantity
|
||||
* description: The minimum quantity required for a `buyget` promotion to be applied. For example, if the promotion is a "Buy 2 shirts get 1 free", the value of this attribute is `2`.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -4,15 +4,14 @@
|
||||
* description: The filfillment's details.
|
||||
* x-schemaName: AdminCreateFulfillment
|
||||
* required:
|
||||
* - data
|
||||
* - order_id
|
||||
* - metadata
|
||||
* - items
|
||||
* - location_id
|
||||
* - provider_id
|
||||
* - delivery_address
|
||||
* - items
|
||||
* - labels
|
||||
* - order
|
||||
* - order_id
|
||||
* - data
|
||||
* - metadata
|
||||
* properties:
|
||||
* location_id:
|
||||
* type: string
|
||||
@@ -77,8 +76,8 @@
|
||||
* description: An item to fulfill.
|
||||
* required:
|
||||
* - title
|
||||
* - sku
|
||||
* - quantity
|
||||
* - sku
|
||||
* - barcode
|
||||
* properties:
|
||||
* title:
|
||||
|
||||
@@ -50,8 +50,8 @@
|
||||
* description: A price's details.
|
||||
* required:
|
||||
* - currency_code
|
||||
* - amount
|
||||
* - variant_id
|
||||
* - amount
|
||||
* properties:
|
||||
* currency_code:
|
||||
* type: string
|
||||
|
||||
@@ -84,5 +84,11 @@
|
||||
* description: The variant's options, where the key is an option's name, and the value is the option's value.
|
||||
* example:
|
||||
* Color: Black
|
||||
* inventory_items:
|
||||
* type: array
|
||||
* description: The variant's inventory items to create.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminCreateProductVariantInventoryKit"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -12,13 +12,13 @@
|
||||
* type: string
|
||||
* description: The operator used to check whether the buy rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value.
|
||||
* enum:
|
||||
* - gte
|
||||
* - lte
|
||||
* - gt
|
||||
* - lt
|
||||
* - eq
|
||||
* - ne
|
||||
* - in
|
||||
* - lte
|
||||
* - gte
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
@@ -27,7 +27,7 @@
|
||||
* type: string
|
||||
* title: attribute
|
||||
* description: The attribute to compare against when checking whether a promotion can be applied on a cart.
|
||||
* example: item.product.id
|
||||
* example: items.product.id
|
||||
* values:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
/**
|
||||
* @schema AdminCreateReturnReason
|
||||
* type: object
|
||||
* description: The details of a return reason to create.
|
||||
* description: The details of the return reason to create.
|
||||
* x-schemaName: AdminCreateReturnReason
|
||||
* required:
|
||||
* - value
|
||||
|
||||
@@ -6,6 +6,7 @@
|
||||
* required:
|
||||
* - name
|
||||
* - tax_region_id
|
||||
* - code
|
||||
* properties:
|
||||
* name:
|
||||
* type: string
|
||||
|
||||
@@ -23,6 +23,7 @@
|
||||
* type: object
|
||||
* description: The tax region's default tax rate.
|
||||
* required:
|
||||
* - code
|
||||
* - name
|
||||
* properties:
|
||||
* rate:
|
||||
|
||||
@@ -4,8 +4,8 @@
|
||||
* description: The details of the variant-inventory item association.
|
||||
* x-schemaName: AdminCreateVariantInventoryItem
|
||||
* required:
|
||||
* - required_quantity
|
||||
* - inventory_item_id
|
||||
* - required_quantity
|
||||
* properties:
|
||||
* required_quantity:
|
||||
* type: number
|
||||
|
||||
@@ -10,7 +10,6 @@
|
||||
* - name
|
||||
* - decimal_digits
|
||||
* - rounding
|
||||
* - raw_rounding
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - deleted_at
|
||||
|
||||
@@ -5,6 +5,7 @@
|
||||
* x-schemaName: AdminCustomer
|
||||
* required:
|
||||
* - has_account
|
||||
* - addresses
|
||||
* - id
|
||||
* - email
|
||||
* - default_billing_address_id
|
||||
@@ -12,7 +13,6 @@
|
||||
* - company_name
|
||||
* - first_name
|
||||
* - last_name
|
||||
* - addresses
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
|
||||
@@ -4,9 +4,9 @@
|
||||
* description: The customer group's details.
|
||||
* x-schemaName: AdminCustomerGroup
|
||||
* required:
|
||||
* - customers
|
||||
* - id
|
||||
* - name
|
||||
* - customers
|
||||
* - metadata
|
||||
* - created_at
|
||||
* - updated_at
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
* - exchange
|
||||
* properties:
|
||||
* order_preview:
|
||||
* $ref: "#/components/schemas/OrderPreview"
|
||||
* $ref: "#/components/schemas/AdminOrderPreview"
|
||||
* exchange:
|
||||
* $ref: "#/components/schemas/AdminExchange"
|
||||
*
|
||||
|
||||
@@ -9,11 +9,9 @@
|
||||
* - exchange
|
||||
* properties:
|
||||
* return:
|
||||
* description: The associated return's details.
|
||||
* $ref: "#/components/schemas/AdminReturn"
|
||||
* order_preview:
|
||||
* description: A preview of the order once the exchange is applied.
|
||||
* $ref: "#/components/schemas/OrderPreview"
|
||||
* $ref: "#/components/schemas/AdminOrderPreview"
|
||||
* exchange:
|
||||
* $ref: "#/components/schemas/AdminExchange"
|
||||
*
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
* - return
|
||||
* properties:
|
||||
* order_preview:
|
||||
* $ref: "#/components/schemas/OrderPreview"
|
||||
* $ref: "#/components/schemas/AdminOrderPreview"
|
||||
* return:
|
||||
* $ref: "#/components/schemas/AdminReturn"
|
||||
*
|
||||
|
||||
@@ -1,8 +0,0 @@
|
||||
/**
|
||||
* @schema AdminExportProductRequest
|
||||
* type: object
|
||||
* description: The export's details
|
||||
* x-schemaName: AdminExportProductRequest
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -39,10 +39,8 @@
|
||||
* title: shipping_option_id
|
||||
* description: The ID of the shipping option this fulfillment is created for.
|
||||
* provider:
|
||||
* description: The details of the fulfillment provider using to handle this fulfillment.
|
||||
* $ref: "#/components/schemas/AdminFulfillmentProvider"
|
||||
* delivery_address:
|
||||
* description: The address to deliver the item to.
|
||||
* $ref: "#/components/schemas/AdminFulfillmentAddress"
|
||||
* items:
|
||||
* type: array
|
||||
|
||||
@@ -1,8 +0,0 @@
|
||||
/**
|
||||
* @schema AdminMarkOrderFulfillmentDelivered
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminMarkOrderFulfillmentDelivered
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -5,21 +5,20 @@
|
||||
* x-schemaName: AdminOrder
|
||||
* required:
|
||||
* - payment_collections
|
||||
* - items
|
||||
* - shipping_methods
|
||||
* - currency_code
|
||||
* - id
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - email
|
||||
* - version
|
||||
* - region_id
|
||||
* - customer_id
|
||||
* - sales_channel_id
|
||||
* - email
|
||||
* - currency_code
|
||||
* - items
|
||||
* - shipping_methods
|
||||
* - payment_status
|
||||
* - fulfillment_status
|
||||
* - summary
|
||||
* - metadata
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - original_item_total
|
||||
* - original_item_subtotal
|
||||
* - original_item_tax_total
|
||||
@@ -52,7 +51,7 @@
|
||||
* type: array
|
||||
* description: The order's fulfillments.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseOrderFulfillment"
|
||||
* $ref: "#/components/schemas/AdminOrderFulfillment"
|
||||
* sales_channel:
|
||||
* $ref: "#/components/schemas/AdminSalesChannel"
|
||||
* customer:
|
||||
@@ -98,12 +97,12 @@
|
||||
* type: array
|
||||
* description: The order's items.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseOrderLineItem"
|
||||
* $ref: "#/components/schemas/AdminOrderLineItem"
|
||||
* shipping_methods:
|
||||
* type: array
|
||||
* description: The order's shipping methods.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseOrderShippingMethod"
|
||||
* $ref: "#/components/schemas/AdminOrderShippingMethod"
|
||||
* payment_status:
|
||||
* type: string
|
||||
* description: The order's payment status.
|
||||
|
||||
@@ -1,154 +1,145 @@
|
||||
/**
|
||||
* @schema AdminOrderChange
|
||||
* type: object
|
||||
* description: The order preview's order change.
|
||||
* description: The order change's details.
|
||||
* x-schemaName: AdminOrderChange
|
||||
* required:
|
||||
* - order
|
||||
* - claim
|
||||
* - return
|
||||
* - return_order
|
||||
* - exchange
|
||||
* - id
|
||||
* - version
|
||||
* - actions
|
||||
* - status
|
||||
* - order_id
|
||||
* - metadata
|
||||
* - id
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - version
|
||||
* - canceled_at
|
||||
* - return_id
|
||||
* - exchange_id
|
||||
* - claim_id
|
||||
* - return_order
|
||||
* - actions
|
||||
* - status
|
||||
* - requested_by
|
||||
* - requested_at
|
||||
* - confirmed_by
|
||||
* - confirmed_at
|
||||
* - declined_by
|
||||
* - declined_reason
|
||||
* - metadata
|
||||
* - declined_at
|
||||
* - canceled_by
|
||||
* - canceled_at
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The order change's ID.
|
||||
* order_id:
|
||||
* type: string
|
||||
* title: order_id
|
||||
* description: The order change's order id.
|
||||
* actions:
|
||||
* type: array
|
||||
* description: The order change's actions.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseOrderChangeAction"
|
||||
* status:
|
||||
* type: string
|
||||
* title: status
|
||||
* description: The order change's status.
|
||||
* requested_by:
|
||||
* type: string
|
||||
* title: requested_by
|
||||
* description: The order change's requested by.
|
||||
* requested_at:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: requested_at
|
||||
* description: The order change's requested at.
|
||||
* - type: string
|
||||
* title: requested_at
|
||||
* description: The order change's requested at.
|
||||
* format: date-time
|
||||
* confirmed_by:
|
||||
* type: string
|
||||
* title: confirmed_by
|
||||
* description: The order change's confirmed by.
|
||||
* confirmed_at:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: confirmed_at
|
||||
* description: The order change's confirmed at.
|
||||
* - type: string
|
||||
* title: confirmed_at
|
||||
* description: The order change's confirmed at.
|
||||
* format: date-time
|
||||
* declined_by:
|
||||
* type: string
|
||||
* title: declined_by
|
||||
* description: The order change's declined by.
|
||||
* declined_reason:
|
||||
* type: string
|
||||
* title: declined_reason
|
||||
* description: The order change's declined reason.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The order change's metadata.
|
||||
* declined_at:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: declined_at
|
||||
* description: The order change's declined at.
|
||||
* - type: string
|
||||
* title: declined_at
|
||||
* description: The order change's declined at.
|
||||
* format: date-time
|
||||
* canceled_by:
|
||||
* type: string
|
||||
* title: canceled_by
|
||||
* description: The order change's canceled by.
|
||||
* canceled_at:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: canceled_at
|
||||
* description: The order change's canceled at.
|
||||
* - type: string
|
||||
* title: canceled_at
|
||||
* description: The order change's canceled at.
|
||||
* format: date-time
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: created_at
|
||||
* description: The order change's created at.
|
||||
* updated_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The order change's updated at.
|
||||
* version:
|
||||
* type: number
|
||||
* title: version
|
||||
* description: The order change's version.
|
||||
* description: The order change's version. This will be the order's version when the change is applied.
|
||||
* change_type:
|
||||
* type: string
|
||||
* description: The order change's change type.
|
||||
* description: The order change's type.
|
||||
* enum:
|
||||
* - return
|
||||
* - exchange
|
||||
* - claim
|
||||
* - edit
|
||||
* - return_request
|
||||
* order_id:
|
||||
* type: string
|
||||
* title: order_id
|
||||
* description: The ID of the order this change applies on.
|
||||
* return_id:
|
||||
* type: string
|
||||
* title: return_id
|
||||
* description: The order change's return id.
|
||||
* description: The ID of the associated return.
|
||||
* exchange_id:
|
||||
* type: string
|
||||
* title: exchange_id
|
||||
* description: The order change's exchange id.
|
||||
* description: The ID of the associated exchange.
|
||||
* claim_id:
|
||||
* type: string
|
||||
* title: claim_id
|
||||
* description: The order change's claim id.
|
||||
* description: The ID of the associated claim.
|
||||
* order:
|
||||
* $ref: "#/components/schemas/AdminOrder"
|
||||
* type: string
|
||||
* title: order
|
||||
* description: The order change's order.
|
||||
* externalDocs:
|
||||
* url: "#pagination"
|
||||
* return_order:
|
||||
* $ref: "#/components/schemas/AdminReturn"
|
||||
* exchange:
|
||||
* $ref: "#/components/schemas/AdminExchange"
|
||||
* claim:
|
||||
* $ref: "#/components/schemas/AdminClaim"
|
||||
* actions:
|
||||
* type: array
|
||||
* description: The order change's actions.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminOrderChangeAction"
|
||||
* status:
|
||||
* type: string
|
||||
* description: The order change's status.
|
||||
* enum:
|
||||
* - canceled
|
||||
* - requested
|
||||
* - pending
|
||||
* - confirmed
|
||||
* - declined
|
||||
* requested_by:
|
||||
* type: string
|
||||
* title: requested_by
|
||||
* description: The ID of the user that requested the change.
|
||||
* requested_at:
|
||||
* type: string
|
||||
* title: requested_at
|
||||
* description: The date the order change was requested.
|
||||
* format: date-time
|
||||
* confirmed_by:
|
||||
* type: string
|
||||
* title: confirmed_by
|
||||
* description: The ID of the user that confirmed the order change.
|
||||
* confirmed_at:
|
||||
* type: string
|
||||
* title: confirmed_at
|
||||
* description: The date the order change was confirmed.
|
||||
* format: date-time
|
||||
* declined_by:
|
||||
* type: string
|
||||
* title: declined_by
|
||||
* description: The ID of the user that declined the order change.
|
||||
* declined_reason:
|
||||
* type: string
|
||||
* title: declined_reason
|
||||
* description: The reason the order change was declined.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The order change's metadata, can hold custom key-value pairs.
|
||||
* declined_at:
|
||||
* type: string
|
||||
* title: declined_at
|
||||
* description: The date the order change was declined.
|
||||
* format: date-time
|
||||
* canceled_by:
|
||||
* type: string
|
||||
* title: canceled_by
|
||||
* description: The ID of the user that canceled the order change.
|
||||
* canceled_at:
|
||||
* type: string
|
||||
* title: canceled_at
|
||||
* description: The date the order change was canceled.
|
||||
* format: date-time
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: created_at
|
||||
* description: The date the order change was created.
|
||||
* updated_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The date the order change was updated.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,11 +1,25 @@
|
||||
/**
|
||||
* @schema AdminOrderChangeAction
|
||||
* type: object
|
||||
* description: The action's details.
|
||||
* description: The order change action's details.
|
||||
* x-schemaName: AdminOrderChangeAction
|
||||
* required:
|
||||
* - order_change
|
||||
* - order
|
||||
* - order_id
|
||||
* - internal_note
|
||||
* - id
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - return_id
|
||||
* - exchange_id
|
||||
* - claim_id
|
||||
* - order_change_id
|
||||
* - reference
|
||||
* - reference_id
|
||||
* - action
|
||||
* - details
|
||||
* properties:
|
||||
* order_change:
|
||||
* $ref: "#/components/schemas/AdminOrderChange"
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
@@ -13,11 +27,31 @@
|
||||
* order_change_id:
|
||||
* type: string
|
||||
* title: order_change_id
|
||||
* description: The ID of the order change this action belongs to.
|
||||
* description: The ID of the order change that the action belongs to.
|
||||
* order_change:
|
||||
* $ref: "#/components/schemas/AdminOrderChange"
|
||||
* order_id:
|
||||
* type: string
|
||||
* title: order_id
|
||||
* description: The ID of the associated order.
|
||||
* description: The ID of the order the associated change is for.
|
||||
* 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:
|
||||
* type: string
|
||||
* title: order
|
||||
* description: The order change's order.
|
||||
* externalDocs:
|
||||
* url: "#pagination"
|
||||
* reference:
|
||||
* type: string
|
||||
* title: reference
|
||||
@@ -33,8 +67,23 @@
|
||||
* description: The ID of the record in the referenced table.
|
||||
* action:
|
||||
* type: string
|
||||
* title: action
|
||||
* description: The applied action.
|
||||
* enum:
|
||||
* - CANCEL_RETURN_ITEM
|
||||
* - FULFILL_ITEM
|
||||
* - DELIVER_ITEM
|
||||
* - CANCEL_ITEM_FULFILLMENT
|
||||
* - ITEM_ADD
|
||||
* - ITEM_REMOVE
|
||||
* - ITEM_UPDATE
|
||||
* - RECEIVE_DAMAGED_RETURN_ITEM
|
||||
* - RECEIVE_RETURN_ITEM
|
||||
* - RETURN_ITEM
|
||||
* - SHIPPING_ADD
|
||||
* - SHIPPING_REMOVE
|
||||
* - SHIP_ITEM
|
||||
* - WRITE_OFF_ITEM
|
||||
* - REINSTATE_ITEM
|
||||
* details:
|
||||
* type: object
|
||||
* description: The action's details.
|
||||
@@ -44,47 +93,17 @@
|
||||
* internal_note:
|
||||
* type: string
|
||||
* title: internal_note
|
||||
* description: A note viewed only by admin users.
|
||||
* description: A note that's viewed only by admin users.
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: created_at
|
||||
* description: The date the order change action was created.
|
||||
* description: The date the 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
|
||||
* description: The date the action was updated.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
* type: array
|
||||
* description: An order's changes.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseOrderChange"
|
||||
* $ref: "#/components/schemas/AdminOrderChange"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
* - order_preview
|
||||
* properties:
|
||||
* order_preview:
|
||||
* $ref: "#/components/schemas/OrderPreview"
|
||||
* $ref: "#/components/schemas/AdminOrderPreview"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
* - order_change
|
||||
* properties:
|
||||
* order_change:
|
||||
* $ref: "#/components/schemas/OrderChange"
|
||||
* $ref: "#/components/schemas/AdminOrderChange"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -4,10 +4,24 @@
|
||||
* description: The item's details.
|
||||
* x-schemaName: AdminOrderLineItem
|
||||
* required:
|
||||
* - id
|
||||
* - title
|
||||
* - metadata
|
||||
* - id
|
||||
* - subtitle
|
||||
* - thumbnail
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - item_total
|
||||
* - item_subtotal
|
||||
* - item_tax_total
|
||||
* - original_total
|
||||
* - original_subtotal
|
||||
* - original_tax_total
|
||||
* - total
|
||||
* - subtotal
|
||||
* - tax_total
|
||||
* - discount_total
|
||||
* - discount_tax_total
|
||||
* - variant_id
|
||||
* - product_id
|
||||
* - product_title
|
||||
@@ -26,20 +40,6 @@
|
||||
* - unit_price
|
||||
* - quantity
|
||||
* - detail
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - metadata
|
||||
* - original_total
|
||||
* - original_subtotal
|
||||
* - original_tax_total
|
||||
* - item_total
|
||||
* - item_subtotal
|
||||
* - item_tax_total
|
||||
* - total
|
||||
* - subtotal
|
||||
* - tax_total
|
||||
* - discount_total
|
||||
* - discount_tax_total
|
||||
* - refundable_total
|
||||
* - refundable_total_per_unit
|
||||
* properties:
|
||||
@@ -66,7 +66,7 @@
|
||||
* title: variant_id
|
||||
* description: The ID of the associated variant.
|
||||
* product:
|
||||
* $ref: "#/components/schemas/BaseProduct"
|
||||
* $ref: "#/components/schemas/AdminProduct"
|
||||
* product_id:
|
||||
* type: string
|
||||
* title: product_id
|
||||
|
||||
@@ -87,11 +87,11 @@
|
||||
* type: array
|
||||
* description: The details of payment refunds.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseRefund"
|
||||
* $ref: "#/components/schemas/AdminRefund"
|
||||
* payment_collection:
|
||||
* $ref: "#/components/schemas/BasePaymentCollection"
|
||||
* $ref: "#/components/schemas/AdminPaymentCollection"
|
||||
* payment_session:
|
||||
* $ref: "#/components/schemas/BasePaymentSession"
|
||||
* $ref: "#/components/schemas/AdminPaymentSession"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -4,12 +4,12 @@
|
||||
* description: The payment collection's details.
|
||||
* x-schemaName: AdminPaymentCollection
|
||||
* required:
|
||||
* - payment_providers
|
||||
* - id
|
||||
* - currency_code
|
||||
* - region_id
|
||||
* - amount
|
||||
* - status
|
||||
* - payment_providers
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
@@ -70,17 +70,17 @@
|
||||
* type: array
|
||||
* description: The payment provider used to process the collection's payments and sessions.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BasePaymentProvider"
|
||||
* $ref: "#/components/schemas/AdminPaymentProvider"
|
||||
* payment_sessions:
|
||||
* type: array
|
||||
* description: The payment collection's payment sessions.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BasePaymentSession"
|
||||
* $ref: "#/components/schemas/AdminPaymentSession"
|
||||
* payments:
|
||||
* type: array
|
||||
* description: The payment collection's payments.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BasePayment"
|
||||
* $ref: "#/components/schemas/AdminPayment"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -37,7 +37,7 @@
|
||||
* type: string
|
||||
* title: object
|
||||
* description: The name of the deleted object.
|
||||
* default: "price"
|
||||
* default: price
|
||||
* deleted:
|
||||
* type: boolean
|
||||
* title: deleted
|
||||
|
||||
@@ -71,7 +71,7 @@
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: deleted_at
|
||||
* description: The date the price was deleted.
|
||||
* description: The date the price was deleted.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -4,15 +4,15 @@
|
||||
* description: The product's details.
|
||||
* x-schemaName: AdminProduct
|
||||
* required:
|
||||
* - variants
|
||||
* - type
|
||||
* - options
|
||||
* - images
|
||||
* - length
|
||||
* - title
|
||||
* - status
|
||||
* - options
|
||||
* - description
|
||||
* - id
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - handle
|
||||
* - subtitle
|
||||
* - is_giftcard
|
||||
@@ -26,9 +26,10 @@
|
||||
* - material
|
||||
* - collection_id
|
||||
* - type_id
|
||||
* - images
|
||||
* - discountable
|
||||
* - external_id
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - deleted_at
|
||||
* properties:
|
||||
* collection:
|
||||
@@ -75,7 +76,7 @@
|
||||
* type: array
|
||||
* description: The product's options.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseProductOption"
|
||||
* $ref: "#/components/schemas/AdminProductOption"
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
@@ -153,7 +154,7 @@
|
||||
* type: array
|
||||
* description: The product's images.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseProductImage"
|
||||
* $ref: "#/components/schemas/AdminProductImage"
|
||||
* discountable:
|
||||
* type: boolean
|
||||
* title: discountable
|
||||
|
||||
@@ -25,7 +25,7 @@
|
||||
* type: array
|
||||
* description: The product option's values.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseProductOptionValue"
|
||||
* $ref: "#/components/schemas/AdminProductOptionValue"
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The product option's metadata, can hold custom key-value pairs.
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
* type: string
|
||||
* title: object
|
||||
* description: The name of the deleted object.
|
||||
* default: "product_option"
|
||||
* default: product_option
|
||||
* deleted:
|
||||
* type: boolean
|
||||
* title: deleted
|
||||
|
||||
@@ -5,6 +5,7 @@
|
||||
* x-schemaName: AdminProductVariant
|
||||
* required:
|
||||
* - prices
|
||||
* - options
|
||||
* - id
|
||||
* - title
|
||||
* - sku
|
||||
@@ -21,7 +22,6 @@
|
||||
* - length
|
||||
* - height
|
||||
* - width
|
||||
* - options
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - deleted_at
|
||||
@@ -107,7 +107,7 @@
|
||||
* type: array
|
||||
* description: The variant's option values.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseProductOptionValue"
|
||||
* $ref: "#/components/schemas/AdminProductOptionValue"
|
||||
* product:
|
||||
* $ref: "#/components/schemas/AdminProduct"
|
||||
* product_id:
|
||||
|
||||
@@ -20,7 +20,7 @@
|
||||
* type: boolean
|
||||
* title: deleted
|
||||
* description: Whether the product variant was deleted.
|
||||
* default: "variant"
|
||||
* default: variant
|
||||
* parent:
|
||||
* $ref: "#/components/schemas/AdminProduct"
|
||||
*
|
||||
|
||||
+1
-1
@@ -15,7 +15,7 @@
|
||||
* type: string
|
||||
* title: object
|
||||
* description: The name of the deleted object.
|
||||
* default: "variant-inventory-item-link"
|
||||
* default: variant-inventory-item-link
|
||||
* deleted:
|
||||
* type: boolean
|
||||
* title: deleted
|
||||
|
||||
@@ -6,6 +6,13 @@
|
||||
* required:
|
||||
* - id
|
||||
* properties:
|
||||
* application_method:
|
||||
* $ref: "#/components/schemas/AdminApplicationMethod"
|
||||
* rules:
|
||||
* type: array
|
||||
* description: The promotion's rules.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminPromotionRule"
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
@@ -25,13 +32,6 @@
|
||||
* type: boolean
|
||||
* title: is_automatic
|
||||
* description: Whether the promotion is applied on a cart automatically if it matches the promotion's rules.
|
||||
* application_method:
|
||||
* $ref: "#/components/schemas/BaseApplicationMethod"
|
||||
* rules:
|
||||
* type: array
|
||||
* description: The promotion's rules.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BasePromotionRule"
|
||||
* campaign_id:
|
||||
* type: string
|
||||
* title: campaign_id
|
||||
|
||||
@@ -22,7 +22,7 @@
|
||||
* example: customer_group_id
|
||||
* operator:
|
||||
* type: string
|
||||
* description: The updated's operator.
|
||||
* description: The rule's operator.
|
||||
* enum:
|
||||
* - gt
|
||||
* - lt
|
||||
@@ -33,7 +33,7 @@
|
||||
* - gte
|
||||
* values:
|
||||
* type: array
|
||||
* description: The updated's values.
|
||||
* description: The rule's values.
|
||||
* example:
|
||||
* - "cusgroup_123"
|
||||
* items:
|
||||
|
||||
@@ -4,9 +4,9 @@
|
||||
* description: The region's details.
|
||||
* x-schemaName: AdminRegion
|
||||
* required:
|
||||
* - id
|
||||
* - name
|
||||
* - currency_code
|
||||
* - id
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
|
||||
@@ -11,7 +11,6 @@
|
||||
* - external_id
|
||||
* - description
|
||||
* - inventory_item_id
|
||||
* - inventory_item
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
@@ -42,8 +41,7 @@
|
||||
* title: inventory_item_id
|
||||
* description: The ID of the inventory item this reservation is associated with.
|
||||
* inventory_item:
|
||||
* type: object
|
||||
* description: The associated inventory item.
|
||||
* $ref: "#/components/schemas/AdminInventoryItem"
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The reservation's metadata, can hold custom key-value pairs.
|
||||
|
||||
@@ -7,25 +7,23 @@
|
||||
* - id
|
||||
* - value
|
||||
* - label
|
||||
* - field_type
|
||||
* - required
|
||||
* - operators
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The rule attribute's ID, which is a rule's `attribute` it refers to.
|
||||
* example: "customer_group"
|
||||
* example: customer_group
|
||||
* value:
|
||||
* type: string
|
||||
* title: value
|
||||
* description: The rule attribute's value.
|
||||
* example: "customer.groups.id"
|
||||
* example: customer.groups.id
|
||||
* label:
|
||||
* type: string
|
||||
* title: label
|
||||
* description: The rule attribute option's label.
|
||||
* example: "Customer Group"
|
||||
* example: Customer Group
|
||||
* operators:
|
||||
* type: array
|
||||
* description: The attribute's operators.
|
||||
|
||||
@@ -11,12 +11,12 @@
|
||||
* type: string
|
||||
* title: value
|
||||
* description: The rule value's value.
|
||||
* example: "reg_123"
|
||||
* example: reg_123
|
||||
* label:
|
||||
* type: string
|
||||
* title: label
|
||||
* description: The rule value's label.
|
||||
* example: "Europe Region"
|
||||
* example: Europe Region
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
* type: string
|
||||
* title: object
|
||||
* description: The name of the deleted object.
|
||||
* default: "service_zone"
|
||||
* default: service_zone
|
||||
* deleted:
|
||||
* type: boolean
|
||||
* title: deleted
|
||||
|
||||
@@ -33,7 +33,8 @@
|
||||
* description: The shipping option's name.
|
||||
* price_type:
|
||||
* type: string
|
||||
* description: The shipping option's price type. If it's `flat`, the price is fixed and is set in the `prices` property. If it's `calculated`, the price is calculated on checkout by the associated fulfillment provider.
|
||||
* description: The shipping option's price type. If it's `flat`, the price is fixed and is set in the `prices` property. If it's `calculated`, the price is calculated on checkout by the associated
|
||||
* fulfillment provider.
|
||||
* enum:
|
||||
* - calculated
|
||||
* - flat
|
||||
@@ -54,7 +55,7 @@
|
||||
* title: shipping_option_type_id
|
||||
* description: The ID of the associated shipping option type.
|
||||
* type:
|
||||
* $ref: "#/components/schemas/AdminShippingOption"
|
||||
* $ref: "#/components/schemas/AdminShippingOptionType"
|
||||
* shipping_profile_id:
|
||||
* type: string
|
||||
* title: shipping_profile_id
|
||||
|
||||
@@ -0,0 +1,53 @@
|
||||
/**
|
||||
* @schema AdminShippingOptionType
|
||||
* type: object
|
||||
* description: The shipping option's details.
|
||||
* x-schemaName: AdminShippingOptionType
|
||||
* required:
|
||||
* - id
|
||||
* - label
|
||||
* - description
|
||||
* - code
|
||||
* - shipping_option_id
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - deleted_at
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The shipping option's ID.
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: created_at
|
||||
* description: The date the shipping option was created.
|
||||
* updated_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The date the shipping option was updated.
|
||||
* deleted_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: deleted_at
|
||||
* description: The date the shipping option was deleted.
|
||||
* label:
|
||||
* type: string
|
||||
* title: label
|
||||
* description: The type's label.
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The type's description.
|
||||
* code:
|
||||
* type: string
|
||||
* title: code
|
||||
* description: The type's code.
|
||||
* shipping_option_id:
|
||||
* type: string
|
||||
* title: shipping_option_id
|
||||
* description: The type's shipping option id.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -37,6 +37,7 @@
|
||||
* description: The price list's rules.
|
||||
* example:
|
||||
* customer_group_id:
|
||||
* - "cusgrp_123"
|
||||
* - cusgrp_123
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,49 @@
|
||||
/**
|
||||
* @schema AdminUpdatePromotionRule
|
||||
* type: object
|
||||
* description: The properties to update in a buy rule.
|
||||
* required:
|
||||
* - id
|
||||
* - values
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The buy rule's ID.
|
||||
* operator:
|
||||
* type: string
|
||||
* description: The operator used to check whether the buy rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value.
|
||||
* enum:
|
||||
* - gte
|
||||
* - lte
|
||||
* - gt
|
||||
* - lt
|
||||
* - eq
|
||||
* - ne
|
||||
* - in
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The buy rule's description.
|
||||
* attribute:
|
||||
* type: string
|
||||
* title: attribute
|
||||
* description: The attribute to compare against when checking whether a promotion can be applied on a cart.
|
||||
* example: items.product.id
|
||||
* values:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: values
|
||||
* description: The attribute's value.
|
||||
* example: prod_123
|
||||
* - type: array
|
||||
* description: The allowed attribute values.
|
||||
* items:
|
||||
* type: string
|
||||
* title: values
|
||||
* description: An attribute value.
|
||||
* example: prod_123
|
||||
* x-schemaName: AdminUpdatePromotionRule
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,48 @@
|
||||
/**
|
||||
* @schema AdminUpdateShippingOptionRule
|
||||
* type: object
|
||||
* description: The properties to update in the shipping option rule.
|
||||
* required:
|
||||
* - id
|
||||
* - operator
|
||||
* - attribute
|
||||
* - value
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The rule's ID.
|
||||
* operator:
|
||||
* type: string
|
||||
* description: The operator used to check whether a rule applies.
|
||||
* enum:
|
||||
* - in
|
||||
* - eq
|
||||
* - ne
|
||||
* - gt
|
||||
* - gte
|
||||
* - lt
|
||||
* - lte
|
||||
* - nin
|
||||
* attribute:
|
||||
* type: string
|
||||
* title: attribute
|
||||
* description: The name of a property or table that the rule applies to.
|
||||
* example: customer_group
|
||||
* value:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: value
|
||||
* description: A value of the attribute that enables this rule.
|
||||
* example: cusgroup_123
|
||||
* - type: array
|
||||
* description: Values of the attribute that enable this rule.
|
||||
* items:
|
||||
* type: string
|
||||
* title: value
|
||||
* description: A value of the attribute that enables this rule.
|
||||
* example: cusgroup_123
|
||||
* x-schemaName: AdminUpdateShippingOptionRule
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -9,7 +9,8 @@
|
||||
* required_quantity:
|
||||
* type: number
|
||||
* title: required_quantity
|
||||
* description: The number of units a single quantity is equivalent to. For example, if a customer orders one quantity of the variant, Medusa checks the availability of the quantity multiplied by the value set for `required_quantity`. When the customer orders the quantity, Medusa reserves the ordered quantity multiplied by the value set for `required_quantity`.
|
||||
* description: The number of units a single quantity is equivalent to. For example, if a customer orders one quantity of the variant, Medusa checks the availability of the quantity multiplied by the
|
||||
* value set for `required_quantity`. When the customer orders the quantity, Medusa reserves the ordered quantity multiplied by the value set for `required_quantity`.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,67 +0,0 @@
|
||||
/**
|
||||
* @schema BaseApplicationMethod
|
||||
* type: object
|
||||
* description: The application method's details.
|
||||
* x-schemaName: BaseApplicationMethod
|
||||
* required:
|
||||
* - id
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The application method's ID.
|
||||
* type:
|
||||
* type: string
|
||||
* description: How the associated promotion is applied. `fixed` means a fixed amount is discounted; `percentage` means a percentage of the original amount is discounted.
|
||||
* enum:
|
||||
* - fixed
|
||||
* - 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.
|
||||
* enum:
|
||||
* - items
|
||||
* - shipping_methods
|
||||
* - order
|
||||
* allocation:
|
||||
* type: string
|
||||
* description: How is the promotion amount discounted. `each` means the discounted amount is applied on each applicable item; `across` means the discounted amount is split accross the applicable items.
|
||||
* enum:
|
||||
* - each
|
||||
* - across
|
||||
* value:
|
||||
* type: number
|
||||
* title: value
|
||||
* description: The amount to be discounted.
|
||||
* currency_code:
|
||||
* type: string
|
||||
* title: currency_code
|
||||
* description: The application method's currency code.
|
||||
* example: usd
|
||||
* max_quantity:
|
||||
* type: number
|
||||
* title: max_quantity
|
||||
* description: The max quantity allowed in the cart for the associated promotion to be applied.
|
||||
* buy_rules_min_quantity:
|
||||
* type: number
|
||||
* title: buy_rules_min_quantity
|
||||
* description: The minimum quantity required for a `buyget` promotion to be applied. For example, if the promotion is a "Buy 2 shirts get 1 free", the value of this attribute is `2`.
|
||||
* apply_to_quantity:
|
||||
* type: number
|
||||
* title: apply_to_quantity
|
||||
* description: The quantity that results from matching the `buyget` promotion's condition. For example, if the promotion is a "Buy 2 shirts get 1 free", the value of this attribute is `1`.
|
||||
* promotion:
|
||||
* $ref: "#/components/schemas/BasePromotion"
|
||||
* target_rules:
|
||||
* type: array
|
||||
* description: The application method's target rules. These rules indicate which items / shipping methods the promotion applies to.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BasePromotionRule"
|
||||
* buy_rules:
|
||||
* type: array
|
||||
* description: The application method's buy rules. These rules indicate which items are part of the "Buy X" rule.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BasePromotionRule"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -20,7 +20,7 @@
|
||||
* is_calculated_price_tax_inclusive:
|
||||
* type: boolean
|
||||
* title: is_calculated_price_tax_inclusive
|
||||
* description: Whether the calculated price is tax inclusive.
|
||||
* description: Whether the calculated price is tax inclusive.
|
||||
* calculated_amount:
|
||||
* type: number
|
||||
* title: calculated_amount
|
||||
|
||||
@@ -1,103 +0,0 @@
|
||||
/**
|
||||
* @schema BaseClaim
|
||||
* type: object
|
||||
* description: The claim's details.
|
||||
* x-schemaName: BaseClaim
|
||||
* required:
|
||||
* - id
|
||||
* - type
|
||||
* - order_id
|
||||
* - display_id
|
||||
* - order_version
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - canceled_at
|
||||
* - additional_items
|
||||
* - claim_items
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The claim's ID.
|
||||
* type:
|
||||
* type: string
|
||||
* description: The claim's type. If `refund`, the customer is refunded for the damaged item. If `replace`, new items are sent to the customer.
|
||||
* enum:
|
||||
* - refund
|
||||
* - replace
|
||||
* order_id:
|
||||
* type: string
|
||||
* title: order_id
|
||||
* description: The ID of the order the claim is created for.
|
||||
* return_id:
|
||||
* type: string
|
||||
* title: return_id
|
||||
* description: The ID of the returned used to return the items from the customer.
|
||||
* display_id:
|
||||
* type: string
|
||||
* title: display_id
|
||||
* description: The claim's display ID.
|
||||
* order_version:
|
||||
* type: string
|
||||
* title: order_version
|
||||
* description: The version of the order when the claim is applied.
|
||||
* refund_amount:
|
||||
* type: number
|
||||
* title: refund_amount
|
||||
* description: The amount to be refunded.
|
||||
* created_by:
|
||||
* type: string
|
||||
* title: created_by
|
||||
* description: The ID of the user that created the claim.
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: created_at
|
||||
* description: The date the claim was created.
|
||||
* updated_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The date the claim was updated.
|
||||
* canceled_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The date the claim was canceled.
|
||||
* deleted_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: deleted_at
|
||||
* description: The date the claim was deleted.
|
||||
* additional_items:
|
||||
* type: array
|
||||
* description: The items sent to the customer if the claim's type is `replace`.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseClaimItem"
|
||||
* claim_items:
|
||||
* type: array
|
||||
* description: The claim items from the original order.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseClaimItem"
|
||||
* no_notification:
|
||||
* type: boolean
|
||||
* title: no_notification
|
||||
* description: Whether to send the customer notifications on the claim's updates.
|
||||
* order:
|
||||
* $ref: "#/components/schemas/BaseOrder"
|
||||
* shipping_methods:
|
||||
* type: array
|
||||
* description: The claim's shipping methods, used to send the new items.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseOrderShippingMethod"
|
||||
* transactions:
|
||||
* type: array
|
||||
* description: The claim's transactions, such as the refunds made.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseOrderTransaction"
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The claim's metadata, can hold custom key-value pairs.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -43,6 +43,17 @@
|
||||
* raw_quantity:
|
||||
* type: object
|
||||
* description: The quantity claimed.
|
||||
* properties:
|
||||
* value:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: value
|
||||
* description: The raw quantity's value.
|
||||
* - type: number
|
||||
* title: value
|
||||
* description: The raw quantity's value.
|
||||
* required:
|
||||
* - value
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The item's metadata, can hold custom key-value pairs.
|
||||
|
||||
@@ -3,50 +3,6 @@
|
||||
* type: object
|
||||
* description: The collection's details.
|
||||
* x-schemaName: BaseCollection
|
||||
* required:
|
||||
* - id
|
||||
* - title
|
||||
* - handle
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - deleted_at
|
||||
* - metadata
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The collection's ID.
|
||||
* title:
|
||||
* type: string
|
||||
* title: title
|
||||
* description: The collection's title.
|
||||
* handle:
|
||||
* type: string
|
||||
* title: handle
|
||||
* description: The collection's handle.
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: created_at
|
||||
* description: The date the collection is created.
|
||||
* updated_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The date the collection is updated.
|
||||
* deleted_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: deleted_at
|
||||
* description: The date the collection is deleted.
|
||||
* products:
|
||||
* type: array
|
||||
* description: The collection's products.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminProduct"
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The collection's metadata, can hold custom key-value pairs.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,78 +0,0 @@
|
||||
/**
|
||||
* @schema BaseCustomer
|
||||
* type: object
|
||||
* description: The customer's details.
|
||||
* x-schemaName: BaseCustomer
|
||||
* required:
|
||||
* - id
|
||||
* - email
|
||||
* - default_billing_address_id
|
||||
* - default_shipping_address_id
|
||||
* - company_name
|
||||
* - first_name
|
||||
* - last_name
|
||||
* - addresses
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The customer's ID.
|
||||
* email:
|
||||
* type: string
|
||||
* title: email
|
||||
* description: The customer's email.
|
||||
* format: email
|
||||
* default_billing_address_id:
|
||||
* type: string
|
||||
* title: default_billing_address_id
|
||||
* description: The ID of the address used as the default billing address.
|
||||
* default_shipping_address_id:
|
||||
* type: string
|
||||
* title: default_shipping_address_id
|
||||
* description: The ID of the address used as the default shipping address.
|
||||
* company_name:
|
||||
* type: string
|
||||
* title: company_name
|
||||
* description: The customer's company name.
|
||||
* first_name:
|
||||
* type: string
|
||||
* title: first_name
|
||||
* description: The customer's first name.
|
||||
* last_name:
|
||||
* type: string
|
||||
* title: last_name
|
||||
* description: The customer's last name.
|
||||
* addresses:
|
||||
* type: array
|
||||
* description: The customer's addresses.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseCustomerAddress"
|
||||
* phone:
|
||||
* type: string
|
||||
* title: phone
|
||||
* description: The customer's phone.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The customer's metadata, used to store custom key-value pairs.
|
||||
* created_by:
|
||||
* type: string
|
||||
* title: created_by
|
||||
* description: The ID of the user that created this customer, if available.
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: created_at
|
||||
* description: The customer's creation date.
|
||||
* updated_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The customer's update date.
|
||||
* deleted_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: deleted_at
|
||||
* description: The customer's deletion date.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,154 +0,0 @@
|
||||
/**
|
||||
* @schema BaseOrderChange
|
||||
* type: object
|
||||
* description: The order preview's order change.
|
||||
* x-schemaName: BaseOrderChange
|
||||
* required:
|
||||
* - order
|
||||
* - claim
|
||||
* - return
|
||||
* - exchange
|
||||
* - id
|
||||
* - version
|
||||
* - order_id
|
||||
* - return_id
|
||||
* - exchange_id
|
||||
* - claim_id
|
||||
* - return_order
|
||||
* - actions
|
||||
* - status
|
||||
* - requested_by
|
||||
* - requested_at
|
||||
* - confirmed_by
|
||||
* - confirmed_at
|
||||
* - declined_by
|
||||
* - declined_reason
|
||||
* - metadata
|
||||
* - declined_at
|
||||
* - canceled_by
|
||||
* - canceled_at
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The order change's ID.
|
||||
* order_id:
|
||||
* type: string
|
||||
* title: order_id
|
||||
* description: The order change's order id.
|
||||
* actions:
|
||||
* type: array
|
||||
* description: The order change's actions.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseOrderChangeAction"
|
||||
* status:
|
||||
* type: string
|
||||
* title: status
|
||||
* description: The order change's status.
|
||||
* requested_by:
|
||||
* type: string
|
||||
* title: requested_by
|
||||
* description: The order change's requested by.
|
||||
* requested_at:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: requested_at
|
||||
* description: The order change's requested at.
|
||||
* - type: string
|
||||
* title: requested_at
|
||||
* description: The order change's requested at.
|
||||
* format: date-time
|
||||
* confirmed_by:
|
||||
* type: string
|
||||
* title: confirmed_by
|
||||
* description: The order change's confirmed by.
|
||||
* confirmed_at:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: confirmed_at
|
||||
* description: The order change's confirmed at.
|
||||
* - type: string
|
||||
* title: confirmed_at
|
||||
* description: The order change's confirmed at.
|
||||
* format: date-time
|
||||
* declined_by:
|
||||
* type: string
|
||||
* title: declined_by
|
||||
* description: The order change's declined by.
|
||||
* declined_reason:
|
||||
* type: string
|
||||
* title: declined_reason
|
||||
* description: The order change's declined reason.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The order change's metadata.
|
||||
* declined_at:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: declined_at
|
||||
* description: The order change's declined at.
|
||||
* - type: string
|
||||
* title: declined_at
|
||||
* description: The order change's declined at.
|
||||
* format: date-time
|
||||
* canceled_by:
|
||||
* type: string
|
||||
* title: canceled_by
|
||||
* description: The order change's canceled by.
|
||||
* canceled_at:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: canceled_at
|
||||
* description: The order change's canceled at.
|
||||
* - type: string
|
||||
* title: canceled_at
|
||||
* description: The order change's canceled at.
|
||||
* format: date-time
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: created_at
|
||||
* description: The order change's created at.
|
||||
* updated_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The order change's updated at.
|
||||
* version:
|
||||
* type: number
|
||||
* title: version
|
||||
* description: The order change's version.
|
||||
* change_type:
|
||||
* type: string
|
||||
* description: The order change's change type.
|
||||
* enum:
|
||||
* - return
|
||||
* - exchange
|
||||
* - claim
|
||||
* - edit
|
||||
* - return_request
|
||||
* return_id:
|
||||
* type: string
|
||||
* title: return_id
|
||||
* description: The order change's return id.
|
||||
* exchange_id:
|
||||
* type: string
|
||||
* title: exchange_id
|
||||
* description: The order change's exchange id.
|
||||
* claim_id:
|
||||
* type: string
|
||||
* title: claim_id
|
||||
* description: The order change's claim id.
|
||||
* order:
|
||||
* $ref: "#/components/schemas/AdminOrder"
|
||||
* return_order:
|
||||
* $ref: "#/components/schemas/AdminReturn"
|
||||
* exchange:
|
||||
* $ref: "#/components/schemas/AdminExchange"
|
||||
* claim:
|
||||
* $ref: "#/components/schemas/AdminClaim"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -6,6 +6,7 @@
|
||||
* required:
|
||||
* - id
|
||||
* - item_id
|
||||
* - item
|
||||
* - quantity
|
||||
* - fulfilled_quantity
|
||||
* - delivered_quantity
|
||||
@@ -27,7 +28,7 @@
|
||||
* title: id
|
||||
* description: the ID of the associated line item.
|
||||
* item:
|
||||
* $ref: "#/components/schemas/AdminOrderLineItem"
|
||||
* $ref: "#/components/schemas/BaseOrderLineItem"
|
||||
* quantity:
|
||||
* type: number
|
||||
* title: quantity
|
||||
@@ -74,5 +75,6 @@
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The date the detail was updated.
|
||||
*
|
||||
*/
|
||||
|
||||
Loaded 100 of 894 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user