chore(docs): Updated API Reference (automated) (#10017)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
bc2d556c2c
commit
82fd93da17
@@ -15,8 +15,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
|
||||
|
||||
@@ -217,7 +217,7 @@
|
||||
* product_type_id:
|
||||
* type: string
|
||||
* title: product_type_id
|
||||
* description: The item's product type id.
|
||||
* description: The ID of the associated product's type.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -217,7 +217,7 @@
|
||||
* product_type_id:
|
||||
* type: string
|
||||
* title: product_type_id
|
||||
* description: The item's product type id.
|
||||
* description: The ID of the associated product's type.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -212,7 +212,7 @@
|
||||
* display_id:
|
||||
* type: number
|
||||
* title: display_id
|
||||
* description: The order's display id.
|
||||
* description: The order's display ID.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -25,19 +25,8 @@
|
||||
* title: no_notification
|
||||
* description: Whether to send the customer notifications when the exchange is updated.
|
||||
* difference_due:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: difference_due
|
||||
* description: The exchange's difference due.
|
||||
* - type: number
|
||||
* title: difference_due
|
||||
* description: The exchange's difference due.
|
||||
* - type: string
|
||||
* title: difference_due
|
||||
* description: The exchange's difference due.
|
||||
* - type: number
|
||||
* title: difference_due
|
||||
* description: The exchange's difference due.
|
||||
* type: number
|
||||
* title: difference_due
|
||||
* description: The amount to be exchanged or refunded. If the amount is negative, it must be refunded. If positive, additional payment is required from the customer.
|
||||
* return:
|
||||
* $ref: "#/components/schemas/Return"
|
||||
|
||||
@@ -197,7 +197,7 @@
|
||||
* product_type_id:
|
||||
* type: string
|
||||
* title: product_type_id
|
||||
* description: The item's product type id.
|
||||
* description: The ID of the associated product's type.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -24,19 +24,8 @@
|
||||
* - received
|
||||
* - partially_received
|
||||
* refund_amount:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: refund_amount
|
||||
* description: The return order's refund amount.
|
||||
* - type: number
|
||||
* title: refund_amount
|
||||
* description: The return order's refund amount.
|
||||
* - type: string
|
||||
* title: refund_amount
|
||||
* description: The return order's refund amount.
|
||||
* - type: number
|
||||
* title: refund_amount
|
||||
* description: The return order's refund amount.
|
||||
* type: number
|
||||
* title: refund_amount
|
||||
* description: The amount refunded by this return.
|
||||
* order_id:
|
||||
* type: string
|
||||
|
||||
@@ -4015,7 +4015,7 @@
|
||||
* product_type_id:
|
||||
* type: string
|
||||
* title: product_type_id
|
||||
* description: The item's product type id.
|
||||
* description: The ID of the associated product's type.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -22,7 +22,7 @@
|
||||
* description: The customer's phone.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The customer's metadata.
|
||||
* description: The customer's metadata, can hold custom key-value pairs.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
Reference in New Issue
Block a user