chore(docs): Updated API Reference (v2) (#9148)
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>
This commit is contained in:
committed by
GitHub
parent
a63f6910d0
commit
56ee4d6aad
@@ -27,18 +27,20 @@ properties:
|
||||
location_id:
|
||||
type: string
|
||||
title: location_id
|
||||
description: The fulfillment's location id.
|
||||
description: The ID of the location the fulfillment's items are shipped from.
|
||||
provider_id:
|
||||
type: string
|
||||
title: provider_id
|
||||
description: The fulfillment's provider id.
|
||||
description: The ID of the fulfillment provider handling this fulfillment.
|
||||
shipping_option_id:
|
||||
type: string
|
||||
title: shipping_option_id
|
||||
description: The fulfillment's shipping option id.
|
||||
description: The ID of the shipping option this fulfillment is created for.
|
||||
provider:
|
||||
description: The details of the fulfillment provider using to handle this fulfillment.
|
||||
$ref: ./AdminFulfillmentProvider.yaml
|
||||
delivery_address:
|
||||
description: The address to deliver the item to.
|
||||
$ref: ./AdminFulfillmentAddress.yaml
|
||||
items:
|
||||
type: array
|
||||
@@ -47,43 +49,48 @@ properties:
|
||||
$ref: ./AdminFulfillmentItem.yaml
|
||||
labels:
|
||||
type: array
|
||||
description: The fulfillment's labels.
|
||||
description: The fulfillment's shipment labels.
|
||||
items:
|
||||
$ref: ./AdminFulfillmentLabel.yaml
|
||||
packed_at:
|
||||
type: string
|
||||
title: packed_at
|
||||
description: The fulfillment's packed at.
|
||||
description: The date the fulfillment was packed at.
|
||||
shipped_at:
|
||||
type: string
|
||||
title: shipped_at
|
||||
description: The fulfillment's shipped at.
|
||||
description: The date the fulfillment was shipped at.
|
||||
delivered_at:
|
||||
type: string
|
||||
title: delivered_at
|
||||
description: The fulfillment's delivered at.
|
||||
description: The date the fulfillment was delivered at.
|
||||
canceled_at:
|
||||
type: string
|
||||
title: canceled_at
|
||||
description: The fulfillment's canceled at.
|
||||
description: The date the fulfillment was canceled at.
|
||||
data:
|
||||
type: object
|
||||
description: The fulfillment's data.
|
||||
description: >-
|
||||
The fulfillment's data, useful for the third-party provider handling the
|
||||
fulfillment.
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property
|
||||
metadata:
|
||||
type: object
|
||||
description: The fulfillment's metadata.
|
||||
description: The fulfillment's metadata, can hold custom key-value pairs.
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: created_at
|
||||
description: The fulfillment's created at.
|
||||
description: The date the fulfillment was created at.
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: updated_at
|
||||
description: The fulfillment's updated at.
|
||||
description: The date the fulfillment was updated at.
|
||||
deleted_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: deleted_at
|
||||
description: The fulfillment's deleted at.
|
||||
description: The date the fulfillment was deleted at.
|
||||
|
||||
Reference in New Issue
Block a user