chore(docs): Generated API Reference (#3262)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-02-14 20:32:28 +02:00
committed by GitHub
co-authored by olivermrbl
parent 67f9429293
commit 4fb22e8ba5
122 changed files with 8682 additions and 3866 deletions
@@ -9,32 +9,52 @@ description: >-
Fulfillments.
type: object
required:
- canceled_at
- claim_order_id
- created_at
- data
- id
- idempotency_key
- location_id
- metadata
- no_notification
- order_id
- provider_id
- shipped_at
- swap_id
- tracking_numbers
- updated_at
properties:
id:
description: The fulfillment's ID
type: string
description: The cart's ID
example: ful_01G8ZRTMQCA76TXNAT81KPJZRF
claim_order_id:
description: The id of the Claim that the Fulfillment belongs to.
nullable: true
type: string
example: null
claim_order:
description: A claim order object. Available if the relation `claim_order` is expanded.
nullable: true
type: object
swap_id:
description: The id of the Swap that the Fulfillment belongs to.
nullable: true
type: string
example: null
swap:
description: A swap object. Available if the relation `swap` is expanded.
nullable: true
type: object
order_id:
description: The id of the Order that the Fulfillment belongs to.
nullable: true
type: string
example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
order:
description: An order object. Available if the relation `order` is expanded.
nullable: true
type: object
provider_id:
description: >-
@@ -42,13 +62,15 @@ properties:
fulfillment
type: string
example: manual
location_id:
description: The id of the stock location the fulfillment will be shipped from
type: string
example: sloc_01G8TJSYT9M6AVS5N4EMNFS1EK
provider:
description: Available if the relation `provider` is expanded.
nullable: true
$ref: ./FulfillmentProvider.yaml
location_id:
description: The id of the stock location the fulfillment will be shipped from
nullable: true
type: string
example: sloc_01G8TJSYT9M6AVS5N4EMNFS1EK
items:
description: >-
The Fulfillment Items in the Fulfillment - these hold information about
@@ -66,10 +88,10 @@ properties:
items:
$ref: ./TrackingLink.yaml
tracking_numbers:
deprecated: true
description: >-
The tracking numbers that can be used to track the status of the
fulfillment.
deprecated: true
type: array
items:
type: string
@@ -81,41 +103,42 @@ properties:
example: {}
shipped_at:
description: The date with timezone at which the Fulfillment was shipped.
nullable: true
type: string
format: date-time
no_notification:
description: >-
Flag for describing whether or not notifications related to this should be
send.
sent.
nullable: true
type: boolean
example: false
canceled_at:
description: The date with timezone at which the Fulfillment was canceled.
nullable: true
type: string
format: date-time
idempotency_key:
type: string
description: >-
Randomly generated key used to continue the completion of the fulfillment
in case of failure.
nullable: true
type: string
externalDocs:
url: >-
https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
description: Learn more how to use the idempotency key.
created_at:
type: string
description: The date with timezone at which the resource was created.
type: string
format: date-time
updated_at:
type: string
description: The date with timezone at which the resource was updated.
format: date-time
deleted_at:
type: string
description: The date with timezone at which the resource was deleted.
format: date-time
metadata:
type: object
description: An optional key-value map with additional details
nullable: true
type: object
example:
car: white