chore(docs): Updated API Reference (automated) (#10685)

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-12-23 08:35:12 +00:00
committed by GitHub
co-authored by Oli Juhl Shahed Nasser
parent 326f190b73
commit 198fa53120
19 changed files with 621 additions and 0 deletions
@@ -9584,6 +9584,49 @@ components:
description: The list of fulfillment providers.
items:
$ref: '#/components/schemas/AdminFulfillmentProvider'
AdminFulfillmentProviderOption:
type: object
description: The fulfillment option's details.
x-schemaName: AdminFulfillmentProviderOption
required:
- id
- is_return
properties:
id:
type: string
title: id
description: The fulfillment option's ID.
is_return:
type: boolean
title: is_return
description: Whether the fulfillment option is used for returns.
AdminFulfillmentProviderOptionsListResponse:
type: object
description: The paginated list of fulfillment options.
x-schemaName: AdminFulfillmentProviderOptionsListResponse
required:
- limit
- offset
- count
- fulfillment_options
properties:
limit:
type: number
title: limit
description: The maximum number of items returned.
offset:
type: number
title: offset
description: The number of items skipped before retrieving the returned items.
count:
type: number
title: count
description: The total number of items.
fulfillment_options:
type: array
description: The list of fulfillment options.
items:
$ref: '#/components/schemas/AdminFulfillmentProviderOption'
AdminFulfillmentResponse:
type: object
description: A fulfillment's details.
@@ -21183,6 +21226,11 @@ components:
type: number
title: display_id
description: The order's display ID.
credit_lines:
type: array
description: The order's credit lines, useful to add additional payment amounts for an order.
items:
$ref: '#/components/schemas/OrderCreditLine'
OrderAddress:
type: object
description: The address's details.
@@ -21608,6 +21656,51 @@ components:
title: canceled_at
description: The date the claim was canceled.
format: date-time
OrderCreditLine:
type: object
description: The credit line's details.
x-schemaName: OrderCreditLine
required:
- id
- order_id
- order
- reference
- reference_id
- metadata
- created_at
- updated_at
properties:
id:
type: string
title: id
description: The credit line's ID.
order_id:
type: string
title: order_id
description: The ID of the associated order.
order:
type: object
reference:
type: string
title: reference
description: The table that this credit line references. For example, `payment_collection`.
reference_id:
type: string
title: reference_id
description: The ID of the record in the referenced table. For example, `paycol_123`.
metadata:
type: object
description: The credit line's metadata, can hold custom key-value pairs.
created_at:
type: string
format: date-time
title: created_at
description: The date the credit line was created.
updated_at:
type: string
format: date-time
title: updated_at
description: The date the credit line was updated.
OrderExchange:
type: object
description: The order change's exchange.