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:
github-actions[bot]
2024-11-11 12:30:22 +00:00
committed by GitHub
parent bc2d556c2c
commit 82fd93da17
28 changed files with 60 additions and 167 deletions

View File

@@ -215,4 +215,4 @@ properties:
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.

View File

@@ -215,4 +215,4 @@ properties:
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.

View File

@@ -210,4 +210,4 @@ properties:
display_id:
type: number
title: display_id
description: The order's display id.
description: The order's display ID.

View File

@@ -23,19 +23,8 @@ properties:
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

View File

@@ -197,4 +197,4 @@ properties:
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.

View File

@@ -22,19 +22,8 @@ properties:
- 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

View File

@@ -4013,4 +4013,4 @@ properties:
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.

View File

@@ -20,4 +20,4 @@ properties:
description: The customer's phone.
metadata:
type: object
description: The customer's metadata.
description: The customer's metadata, can hold custom key-value pairs.