chore(docs): Generated API Reference (#3262)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
67f9429293
commit
4fb22e8ba5
@@ -5,15 +5,23 @@ description: >-
|
||||
status of the shipment.
|
||||
type: object
|
||||
required:
|
||||
- tracking_number
|
||||
- created_at
|
||||
- deleted_at
|
||||
- fulfillment_id
|
||||
- id
|
||||
- idempotency_key
|
||||
- metadata
|
||||
- tracking_number
|
||||
- updated_at
|
||||
- url
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The tracking link's ID
|
||||
type: string
|
||||
example: tlink_01G8ZH853Y6TFXWPG5EYE81X63
|
||||
url:
|
||||
description: The URL at which the status of the shipment can be tracked.
|
||||
nullable: true
|
||||
type: string
|
||||
format: uri
|
||||
tracking_number:
|
||||
@@ -21,35 +29,39 @@ properties:
|
||||
type: string
|
||||
format: RH370168054CN
|
||||
fulfillment_id:
|
||||
type: string
|
||||
description: The id of the Fulfillment that the Tracking Link references.
|
||||
type: string
|
||||
example: ful_01G8ZRTMQCA76TXNAT81KPJZRF
|
||||
fulfillment:
|
||||
description: Available if the relation `fulfillment` is expanded.
|
||||
nullable: true
|
||||
$ref: ./Fulfillment.yaml
|
||||
idempotency_key:
|
||||
type: string
|
||||
description: >-
|
||||
Randomly generated key used to continue the completion of a process 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.
|
||||
type: string
|
||||
format: date-time
|
||||
deleted_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was deleted.
|
||||
nullable: true
|
||||
type: string
|
||||
format: date-time
|
||||
metadata:
|
||||
type: object
|
||||
description: An optional key-value map with additional details
|
||||
nullable: true
|
||||
type: object
|
||||
example:
|
||||
car: white
|
||||
|
||||
Reference in New Issue
Block a user