chore(docs): Generated API Reference (v2) (#8890)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
committed by
GitHub
GitHub
parent
891037081d
commit
524be62312
@@ -0,0 +1,60 @@
|
||||
type: object
|
||||
description: The api key's details.
|
||||
x-schemaName: AdminApiKey
|
||||
required:
|
||||
- id
|
||||
- token
|
||||
- redacted
|
||||
- title
|
||||
- type
|
||||
- last_used_at
|
||||
- created_by
|
||||
- created_at
|
||||
- revoked_by
|
||||
- revoked_at
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The api key's ID.
|
||||
token:
|
||||
type: string
|
||||
title: token
|
||||
description: The api key's token.
|
||||
redacted:
|
||||
type: string
|
||||
title: redacted
|
||||
description: The api key's redacted.
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The api key's title.
|
||||
type:
|
||||
type: string
|
||||
description: The api key's type.
|
||||
enum:
|
||||
- secret
|
||||
- publishable
|
||||
last_used_at:
|
||||
type: string
|
||||
title: last_used_at
|
||||
description: The api key's last used at.
|
||||
format: date-time
|
||||
created_by:
|
||||
type: string
|
||||
title: created_by
|
||||
description: The api key's created by.
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: created_at
|
||||
description: The api key's created at.
|
||||
revoked_by:
|
||||
type: string
|
||||
title: revoked_by
|
||||
description: The api key's revoked by.
|
||||
revoked_at:
|
||||
type: string
|
||||
title: revoked_at
|
||||
description: The api key's revoked at.
|
||||
format: date-time
|
||||
@@ -5,4 +5,4 @@ required:
|
||||
- api_key
|
||||
properties:
|
||||
api_key:
|
||||
$ref: ./ApiKeyResponse.yaml
|
||||
$ref: ./AdminApiKey.yaml
|
||||
|
||||
+3
-3
@@ -18,7 +18,7 @@ properties:
|
||||
$ref: ./AdminProduct.yaml
|
||||
deleted:
|
||||
type: object
|
||||
description: The product's deleted.
|
||||
description: SUMMARY
|
||||
required:
|
||||
- ids
|
||||
- object
|
||||
@@ -34,8 +34,8 @@ properties:
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The deleted's object.
|
||||
description: SUMMARY
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The deleted's details.
|
||||
description: SUMMARY
|
||||
|
||||
+3
-3
@@ -18,7 +18,7 @@ properties:
|
||||
$ref: ./AdminProductVariant.yaml
|
||||
deleted:
|
||||
type: object
|
||||
description: The product's deleted.
|
||||
description: SUMMARY
|
||||
required:
|
||||
- ids
|
||||
- object
|
||||
@@ -34,8 +34,8 @@ properties:
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The deleted's object.
|
||||
description: SUMMARY
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The deleted's details.
|
||||
description: SUMMARY
|
||||
|
||||
@@ -0,0 +1,73 @@
|
||||
type: object
|
||||
description: The campaign's details.
|
||||
x-schemaName: AdminCampaign
|
||||
required:
|
||||
- id
|
||||
- name
|
||||
- description
|
||||
- currency
|
||||
- campaign_identifier
|
||||
- starts_at
|
||||
- ends_at
|
||||
- budget
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The campaign's ID.
|
||||
name:
|
||||
type: string
|
||||
title: name
|
||||
description: The campaign's name.
|
||||
description:
|
||||
type: string
|
||||
title: description
|
||||
description: The campaign's description.
|
||||
currency:
|
||||
type: string
|
||||
title: currency
|
||||
description: The campaign's currency.
|
||||
campaign_identifier:
|
||||
type: string
|
||||
title: campaign_identifier
|
||||
description: The campaign's campaign identifier.
|
||||
starts_at:
|
||||
type: string
|
||||
title: starts_at
|
||||
description: The campaign's starts at.
|
||||
ends_at:
|
||||
type: string
|
||||
title: ends_at
|
||||
description: The campaign's ends at.
|
||||
budget:
|
||||
type: object
|
||||
description: The campaign's budget.
|
||||
required:
|
||||
- id
|
||||
- type
|
||||
- currency_code
|
||||
- limit
|
||||
- used
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The budget's ID.
|
||||
type:
|
||||
type: string
|
||||
description: The budget's type.
|
||||
enum:
|
||||
- spend
|
||||
- usage
|
||||
currency_code:
|
||||
type: string
|
||||
title: currency_code
|
||||
description: The budget's currency code.
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The budget's limit.
|
||||
used:
|
||||
type: number
|
||||
title: used
|
||||
description: The budget's used.
|
||||
@@ -5,4 +5,4 @@ required:
|
||||
- campaign
|
||||
properties:
|
||||
campaign:
|
||||
$ref: ./CampaignResponse.yaml
|
||||
$ref: ./AdminCampaign.yaml
|
||||
|
||||
@@ -113,6 +113,7 @@ properties:
|
||||
$ref: ./BasePaymentCollection.yaml
|
||||
payment_status:
|
||||
type: string
|
||||
description: The claim's payment status.
|
||||
enum:
|
||||
- canceled
|
||||
- not_paid
|
||||
@@ -131,6 +132,7 @@ properties:
|
||||
$ref: ./BaseOrderFulfillment.yaml
|
||||
fulfillment_status:
|
||||
type: string
|
||||
description: The claim's fulfillment status.
|
||||
enum:
|
||||
- canceled
|
||||
- not_fulfilled
|
||||
|
||||
@@ -13,12 +13,12 @@ properties:
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The claim's object.
|
||||
description: The name of the deleted object.
|
||||
default: claim
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The claim's deleted.
|
||||
description: Whether the Claim was deleted.
|
||||
parent:
|
||||
type: object
|
||||
description: The claim's parent.
|
||||
|
||||
+2
-2
@@ -13,12 +13,12 @@ properties:
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The collection's object.
|
||||
description: The name of the deleted object.
|
||||
default: collection
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The collection's deleted.
|
||||
description: Whether the Collection was deleted.
|
||||
parent:
|
||||
type: object
|
||||
description: The collection's parent.
|
||||
|
||||
@@ -11,6 +11,7 @@ properties:
|
||||
description: The api key's title.
|
||||
type:
|
||||
type: string
|
||||
description: The api key's type.
|
||||
enum:
|
||||
- publishable
|
||||
- secret
|
||||
|
||||
@@ -25,11 +25,13 @@ properties:
|
||||
description: The price list's ends at.
|
||||
status:
|
||||
type: string
|
||||
description: The price list's status.
|
||||
enum:
|
||||
- active
|
||||
- draft
|
||||
type:
|
||||
type: string
|
||||
description: The price list's type.
|
||||
enum:
|
||||
- sale
|
||||
- override
|
||||
|
||||
@@ -47,6 +47,7 @@ properties:
|
||||
description: The create's handle.
|
||||
status:
|
||||
type: string
|
||||
description: The create's status.
|
||||
enum:
|
||||
- draft
|
||||
- proposed
|
||||
|
||||
+1
@@ -17,6 +17,7 @@ properties:
|
||||
compensate_input: {}
|
||||
action:
|
||||
type: string
|
||||
description: The workflows execution's action.
|
||||
enum:
|
||||
- invoke
|
||||
- compensate
|
||||
|
||||
@@ -114,6 +114,7 @@ properties:
|
||||
$ref: ./BasePaymentCollection.yaml
|
||||
payment_status:
|
||||
type: string
|
||||
description: The exchange's payment status.
|
||||
enum:
|
||||
- canceled
|
||||
- not_paid
|
||||
@@ -132,6 +133,7 @@ properties:
|
||||
$ref: ./BaseOrderFulfillment.yaml
|
||||
fulfillment_status:
|
||||
type: string
|
||||
description: The exchange's fulfillment status.
|
||||
enum:
|
||||
- canceled
|
||||
- not_fulfilled
|
||||
|
||||
+2
-2
@@ -13,12 +13,12 @@ properties:
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The fulfillment set's object.
|
||||
description: The name of the deleted object.
|
||||
default: fulfillment_set
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The fulfillment set's deleted.
|
||||
description: Whether the Fulfillment Set was deleted.
|
||||
parent:
|
||||
type: object
|
||||
description: The fulfillment set's parent.
|
||||
|
||||
@@ -34,11 +34,11 @@ properties:
|
||||
description: The invite's metadata.
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: created_at
|
||||
description: The invite's created at.
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: updated_at
|
||||
description: The invite's updated at.
|
||||
format: date-time
|
||||
|
||||
@@ -100,6 +100,7 @@ properties:
|
||||
$ref: ./BaseOrderShippingMethod.yaml
|
||||
payment_status:
|
||||
type: string
|
||||
description: The order's payment status.
|
||||
enum:
|
||||
- canceled
|
||||
- not_paid
|
||||
@@ -113,6 +114,7 @@ properties:
|
||||
- requires_action
|
||||
fulfillment_status:
|
||||
type: string
|
||||
description: The order's fulfillment status.
|
||||
enum:
|
||||
- canceled
|
||||
- not_fulfilled
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminOrderChangesResponse
|
||||
required:
|
||||
- order_changes
|
||||
properties:
|
||||
order_changes:
|
||||
type: array
|
||||
description: The order's order changes.
|
||||
items:
|
||||
$ref: ./BaseOrderChange.yaml
|
||||
@@ -200,14 +200,14 @@ properties:
|
||||
$ref: ./BaseOrderItemDetail.yaml
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: created_at
|
||||
description: The item's created at.
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: updated_at
|
||||
description: The item's updated at.
|
||||
format: date-time
|
||||
metadata:
|
||||
type: object
|
||||
description: The item's metadata.
|
||||
@@ -505,6 +505,7 @@ properties:
|
||||
$ref: ./AdminPaymentCollection.yaml
|
||||
payment_status:
|
||||
type: string
|
||||
description: The order preview's payment status.
|
||||
enum:
|
||||
- canceled
|
||||
- not_paid
|
||||
@@ -523,6 +524,7 @@ properties:
|
||||
$ref: ./BaseOrderFulfillment.yaml
|
||||
fulfillment_status:
|
||||
type: string
|
||||
description: The order preview's fulfillment status.
|
||||
enum:
|
||||
- canceled
|
||||
- not_fulfilled
|
||||
|
||||
@@ -93,6 +93,7 @@ properties:
|
||||
description: The payment collection's metadata.
|
||||
status:
|
||||
type: string
|
||||
description: The payment collection's status.
|
||||
enum:
|
||||
- canceled
|
||||
- not_paid
|
||||
|
||||
+1
@@ -22,6 +22,7 @@ properties:
|
||||
description: The item's quantity.
|
||||
reason:
|
||||
type: string
|
||||
description: The item's reason.
|
||||
enum:
|
||||
- missing_item
|
||||
- wrong_item
|
||||
|
||||
+1
@@ -9,6 +9,7 @@ required:
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
description: The claim's type.
|
||||
enum:
|
||||
- refund
|
||||
- replace
|
||||
|
||||
@@ -40,11 +40,13 @@ properties:
|
||||
description: The price list's ends at.
|
||||
status:
|
||||
type: string
|
||||
description: The price list's status.
|
||||
enum:
|
||||
- draft
|
||||
- active
|
||||
type:
|
||||
type: string
|
||||
description: The price list's type.
|
||||
enum:
|
||||
- sale
|
||||
- override
|
||||
|
||||
+3
-3
@@ -18,7 +18,7 @@ properties:
|
||||
$ref: ./AdminPrice.yaml
|
||||
deleted:
|
||||
type: object
|
||||
description: The price list's deleted.
|
||||
description: SUMMARY
|
||||
required:
|
||||
- ids
|
||||
- object
|
||||
@@ -34,8 +34,8 @@ properties:
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The deleted's object.
|
||||
description: SUMMARY
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The deleted's details.
|
||||
description: SUMMARY
|
||||
|
||||
+2
-2
@@ -13,12 +13,12 @@ properties:
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The price list's object.
|
||||
description: The name of the deleted object.
|
||||
default: price_list
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The price list's deleted.
|
||||
description: Whether the Price List was deleted.
|
||||
parent:
|
||||
type: object
|
||||
description: The price list's parent.
|
||||
|
||||
+2
-2
@@ -13,12 +13,12 @@ properties:
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The price preference's object.
|
||||
description: The name of the deleted object.
|
||||
default: price_preference
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The price preference's deleted.
|
||||
description: Whether the Price Preference was deleted.
|
||||
parent:
|
||||
type: object
|
||||
description: The price preference's parent.
|
||||
|
||||
@@ -47,7 +47,7 @@ properties:
|
||||
items:
|
||||
$ref: ./AdminProductVariant.yaml
|
||||
type:
|
||||
type: object
|
||||
$ref: ./AdminProductType.yaml
|
||||
tags:
|
||||
type: array
|
||||
description: The parent's tags.
|
||||
@@ -59,6 +59,7 @@ properties:
|
||||
description: The parent's title.
|
||||
status:
|
||||
type: string
|
||||
description: The parent's status.
|
||||
enum:
|
||||
- draft
|
||||
- proposed
|
||||
|
||||
@@ -40,6 +40,9 @@ properties:
|
||||
type: string
|
||||
title: id
|
||||
description: The category's ID.
|
||||
metadata:
|
||||
type: object
|
||||
description: The category's metadata.
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
|
||||
+2
-2
@@ -13,12 +13,12 @@ properties:
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The product category's object.
|
||||
description: The name of the deleted object.
|
||||
default: product_category
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The product category's deleted.
|
||||
description: Whether the Product Category was deleted.
|
||||
parent:
|
||||
type: object
|
||||
description: The product category's parent.
|
||||
|
||||
+2
-2
@@ -13,12 +13,12 @@ properties:
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The product's object.
|
||||
description: The name of the deleted object.
|
||||
default: product
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The product's deleted.
|
||||
description: Whether the Product was deleted.
|
||||
parent:
|
||||
type: object
|
||||
description: The product's parent.
|
||||
|
||||
+2
-2
@@ -13,11 +13,11 @@ properties:
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The product's object.
|
||||
description: The name of the deleted object.
|
||||
default: product_option
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The product's deleted.
|
||||
description: Whether the Product was deleted.
|
||||
parent:
|
||||
$ref: ./AdminProduct.yaml
|
||||
|
||||
+2
-2
@@ -13,12 +13,12 @@ properties:
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The product tag's object.
|
||||
description: The name of the deleted object.
|
||||
default: product_tag
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The product tag's deleted.
|
||||
description: Whether the Product Tag was deleted.
|
||||
parent:
|
||||
type: object
|
||||
description: The product tag's parent.
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
type: object
|
||||
description: The parent's type.
|
||||
x-schemaName: AdminProductType
|
||||
required:
|
||||
- id
|
||||
- value
|
||||
- created_at
|
||||
- updated_at
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The type's ID.
|
||||
value:
|
||||
type: string
|
||||
title: value
|
||||
description: The type's value.
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: created_at
|
||||
description: The type's created at.
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: updated_at
|
||||
description: The type's updated at.
|
||||
deleted_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: deleted_at
|
||||
description: The type's deleted at.
|
||||
metadata:
|
||||
type: object
|
||||
description: The type's metadata.
|
||||
+2
-2
@@ -13,12 +13,12 @@ properties:
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The product type's object.
|
||||
description: The name of the deleted object.
|
||||
default: product_type
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The product type's deleted.
|
||||
description: Whether the Product Type was deleted.
|
||||
parent:
|
||||
type: object
|
||||
description: The product type's parent.
|
||||
|
||||
+1
-1
@@ -23,4 +23,4 @@ properties:
|
||||
type: array
|
||||
description: The product type's product types.
|
||||
items:
|
||||
$ref: ./AdminProduct.yaml
|
||||
$ref: ./AdminProductType.yaml
|
||||
|
||||
@@ -5,4 +5,4 @@ required:
|
||||
- product_type
|
||||
properties:
|
||||
product_type:
|
||||
$ref: ./AdminProduct.yaml
|
||||
$ref: ./AdminProductType.yaml
|
||||
|
||||
+2
-2
@@ -13,11 +13,11 @@ properties:
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The product's object.
|
||||
description: The name of the deleted object.
|
||||
default: variant
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The product's deleted.
|
||||
description: Whether the Product was deleted.
|
||||
parent:
|
||||
$ref: ./AdminProduct.yaml
|
||||
|
||||
+2
-2
@@ -76,10 +76,10 @@ properties:
|
||||
oneOf:
|
||||
- $ref: ./AdminProductVariantInventoryLink.yaml
|
||||
- type: array
|
||||
description: The product's deleted.
|
||||
description: SUMMARY
|
||||
items:
|
||||
type: object
|
||||
description: The deleted's details.
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminProductVariantInventoryLink
|
||||
required:
|
||||
- productService
|
||||
|
||||
+2
-2
@@ -12,10 +12,10 @@ properties:
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The product's object.
|
||||
description: The name of the deleted object.
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The product's deleted.
|
||||
description: Whether the Product was deleted.
|
||||
parent:
|
||||
$ref: ./AdminProductVariant.yaml
|
||||
|
||||
+4
-10
@@ -62,17 +62,11 @@ properties:
|
||||
type: array
|
||||
description: The variant's $and.
|
||||
items:
|
||||
type: array
|
||||
description: The $and's details.
|
||||
items:
|
||||
type: object
|
||||
title: $and
|
||||
type: object
|
||||
title: $and
|
||||
$or:
|
||||
type: array
|
||||
description: The variant's $or.
|
||||
items:
|
||||
type: array
|
||||
description: The $or's details.
|
||||
items:
|
||||
type: object
|
||||
title: $or
|
||||
type: object
|
||||
title: $or
|
||||
|
||||
@@ -14,6 +14,7 @@ properties:
|
||||
description: The promotion's code.
|
||||
type:
|
||||
type: string
|
||||
description: The promotion's type.
|
||||
enum:
|
||||
- standard
|
||||
- buyget
|
||||
@@ -33,4 +34,4 @@ properties:
|
||||
title: campaign_id
|
||||
description: The promotion's campaign id.
|
||||
campaign:
|
||||
$ref: ./CampaignResponse.yaml
|
||||
$ref: ./AdminCampaign.yaml
|
||||
|
||||
@@ -19,6 +19,7 @@ properties:
|
||||
description: The updated's attribute.
|
||||
operator:
|
||||
type: string
|
||||
description: The updated's operator.
|
||||
enum:
|
||||
- gt
|
||||
- lt
|
||||
|
||||
@@ -0,0 +1,66 @@
|
||||
type: object
|
||||
description: The reservation's details.
|
||||
x-schemaName: AdminReservation
|
||||
required:
|
||||
- id
|
||||
- line_item_id
|
||||
- location_id
|
||||
- quantity
|
||||
- external_id
|
||||
- description
|
||||
- inventory_item_id
|
||||
- inventory_item
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The reservation's ID.
|
||||
line_item_id:
|
||||
type: string
|
||||
title: line_item_id
|
||||
description: The reservation's line item id.
|
||||
location_id:
|
||||
type: string
|
||||
title: location_id
|
||||
description: The reservation's location id.
|
||||
quantity:
|
||||
type: string
|
||||
title: quantity
|
||||
description: The reservation's quantity.
|
||||
external_id:
|
||||
type: string
|
||||
title: external_id
|
||||
description: The reservation's external id.
|
||||
description:
|
||||
type: string
|
||||
title: description
|
||||
description: The reservation's description.
|
||||
inventory_item_id:
|
||||
type: string
|
||||
title: inventory_item_id
|
||||
description: The reservation's inventory item id.
|
||||
inventory_item:
|
||||
type: object
|
||||
description: The reservation's inventory item.
|
||||
metadata:
|
||||
type: object
|
||||
description: The reservation's metadata.
|
||||
created_by:
|
||||
type: string
|
||||
title: created_by
|
||||
description: The reservation's created by.
|
||||
deleted_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: deleted_at
|
||||
description: The reservation's deleted at.
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: created_at
|
||||
description: The reservation's created at.
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: updated_at
|
||||
description: The reservation's updated at.
|
||||
@@ -5,4 +5,4 @@ required:
|
||||
- reservation
|
||||
properties:
|
||||
reservation:
|
||||
$ref: ./ReservationResponse.yaml
|
||||
$ref: ./AdminReservation.yaml
|
||||
|
||||
@@ -9,6 +9,7 @@ required:
|
||||
- items
|
||||
- received_at
|
||||
- created_at
|
||||
- canceled_at
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
@@ -64,3 +65,7 @@ properties:
|
||||
format: date-time
|
||||
title: created_at
|
||||
description: The return's created at.
|
||||
canceled_at:
|
||||
type: string
|
||||
title: canceled_at
|
||||
description: The return's canceled at.
|
||||
|
||||
@@ -5,6 +5,7 @@ required:
|
||||
- id
|
||||
- quantity
|
||||
- received_quantity
|
||||
- damaged_quantity
|
||||
- item_id
|
||||
- return_id
|
||||
properties:
|
||||
@@ -20,6 +21,10 @@ properties:
|
||||
type: number
|
||||
title: received_quantity
|
||||
description: The return item's received quantity.
|
||||
damaged_quantity:
|
||||
type: number
|
||||
title: damaged_quantity
|
||||
description: The return item's damaged quantity.
|
||||
reason_id:
|
||||
type: string
|
||||
title: reason_id
|
||||
|
||||
+2
-2
@@ -13,12 +13,12 @@ properties:
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The sales channel's object.
|
||||
description: The name of the deleted object.
|
||||
default: sales-channel
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The sales channel's deleted.
|
||||
description: Whether the Sales Channel was deleted.
|
||||
parent:
|
||||
type: object
|
||||
description: The sales channel's parent.
|
||||
|
||||
+2
-2
@@ -13,12 +13,12 @@ properties:
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The shipping option's object.
|
||||
description: The name of the deleted object.
|
||||
default: shipping_option
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The shipping option's deleted.
|
||||
description: Whether the Shipping Option was deleted.
|
||||
parent:
|
||||
type: object
|
||||
description: The shipping option's parent.
|
||||
|
||||
+2
-2
@@ -13,12 +13,12 @@ properties:
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The shipping profile's object.
|
||||
description: The name of the deleted object.
|
||||
default: shipping_profile
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The shipping profile's deleted.
|
||||
description: Whether the Shipping Profile was deleted.
|
||||
parent:
|
||||
type: object
|
||||
description: The shipping profile's parent.
|
||||
|
||||
+2
-2
@@ -13,12 +13,12 @@ properties:
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The stock location's object.
|
||||
description: The name of the deleted object.
|
||||
default: stock_location
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The stock location's deleted.
|
||||
description: Whether the Stock Location was deleted.
|
||||
parent:
|
||||
type: object
|
||||
description: The stock location's parent.
|
||||
|
||||
+2
-2
@@ -13,12 +13,12 @@ properties:
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The tax rate's object.
|
||||
description: The name of the deleted object.
|
||||
default: tax_rate
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The tax rate's deleted.
|
||||
description: Whether the Tax Rate was deleted.
|
||||
parent:
|
||||
type: object
|
||||
description: The tax rate's parent.
|
||||
|
||||
+2
-2
@@ -13,12 +13,12 @@ properties:
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The tax region's object.
|
||||
description: The name of the deleted object.
|
||||
default: tax_region
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The tax region's deleted.
|
||||
description: Whether the Tax Region was deleted.
|
||||
parent:
|
||||
type: object
|
||||
description: The tax region's parent.
|
||||
|
||||
@@ -24,11 +24,13 @@ properties:
|
||||
description: The price list's ends at.
|
||||
status:
|
||||
type: string
|
||||
description: The price list's status.
|
||||
enum:
|
||||
- active
|
||||
- draft
|
||||
type:
|
||||
type: string
|
||||
description: The price list's type.
|
||||
enum:
|
||||
- sale
|
||||
- override
|
||||
|
||||
@@ -45,6 +45,7 @@ properties:
|
||||
description: The update's handle.
|
||||
status:
|
||||
type: string
|
||||
description: The update's status.
|
||||
enum:
|
||||
- draft
|
||||
- proposed
|
||||
|
||||
@@ -13,12 +13,12 @@ properties:
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The user's object.
|
||||
description: The name of the deleted object.
|
||||
default: user
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The user's deleted.
|
||||
description: Whether the User was deleted.
|
||||
parent:
|
||||
type: object
|
||||
description: The user's parent.
|
||||
|
||||
@@ -10,7 +10,6 @@ required:
|
||||
- state
|
||||
- created_at
|
||||
- updated_at
|
||||
- deleted_at
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
@@ -25,26 +24,32 @@ properties:
|
||||
title: transaction_id
|
||||
description: The workflow execution's transaction id.
|
||||
execution:
|
||||
type: string
|
||||
title: execution
|
||||
description: The workflow execution's execution.
|
||||
$ref: ./AdminWorkflowExecutionExecution.yaml
|
||||
context:
|
||||
$ref: ./WorkflowExecutionContext.yaml
|
||||
state:
|
||||
type: string
|
||||
title: context
|
||||
description: The workflow execution's context.
|
||||
state: {}
|
||||
description: The workflow execution's state.
|
||||
enum:
|
||||
- not_started
|
||||
- invoking
|
||||
- waiting_to_compensate
|
||||
- compensating
|
||||
- done
|
||||
- reverted
|
||||
- failed
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: created_at
|
||||
description: The workflow execution's created at.
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: updated_at
|
||||
description: The workflow execution's updated at.
|
||||
format: date-time
|
||||
deleted_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: deleted_at
|
||||
description: The workflow execution's deleted at.
|
||||
format: date-time
|
||||
|
||||
+9
@@ -0,0 +1,9 @@
|
||||
type: object
|
||||
description: The workflow execution's execution.
|
||||
x-schemaName: AdminWorkflowExecutionExecution
|
||||
required:
|
||||
- steps
|
||||
properties:
|
||||
steps:
|
||||
type: object
|
||||
description: The execution's steps.
|
||||
@@ -10,17 +10,20 @@ properties:
|
||||
description: The application method's ID.
|
||||
type:
|
||||
type: string
|
||||
description: The application method's type.
|
||||
enum:
|
||||
- fixed
|
||||
- percentage
|
||||
target_type:
|
||||
type: string
|
||||
description: The application method's target type.
|
||||
enum:
|
||||
- items
|
||||
- shipping_methods
|
||||
- order
|
||||
allocation:
|
||||
type: string
|
||||
description: The application method's allocation.
|
||||
enum:
|
||||
- each
|
||||
- across
|
||||
|
||||
@@ -159,19 +159,19 @@ properties:
|
||||
description: The item's metadata.
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: created_at
|
||||
description: The item's created at.
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: updated_at
|
||||
description: The item's updated at.
|
||||
format: date-time
|
||||
deleted_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: deleted_at
|
||||
description: The item's deleted at.
|
||||
format: date-time
|
||||
original_total:
|
||||
oneOf:
|
||||
- type: string
|
||||
|
||||
@@ -32,6 +32,7 @@ properties:
|
||||
description: The claim item's quantity.
|
||||
reason:
|
||||
type: string
|
||||
description: The claim item's reason.
|
||||
enum:
|
||||
- missing_item
|
||||
- wrong_item
|
||||
|
||||
@@ -119,6 +119,7 @@ properties:
|
||||
description: The order change's version.
|
||||
change_type:
|
||||
type: string
|
||||
description: The order change's change type.
|
||||
enum:
|
||||
- return
|
||||
- exchange
|
||||
|
||||
@@ -59,11 +59,11 @@ properties:
|
||||
description: The fulfillment's metadata.
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: created_at
|
||||
description: The fulfillment's created at.
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: updated_at
|
||||
description: The fulfillment's updated at.
|
||||
format: date-time
|
||||
|
||||
@@ -146,14 +146,14 @@ properties:
|
||||
$ref: ./BaseOrderItemDetail.yaml
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: created_at
|
||||
description: The item's created at.
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: updated_at
|
||||
description: The item's updated at.
|
||||
format: date-time
|
||||
metadata:
|
||||
type: object
|
||||
description: The item's metadata.
|
||||
|
||||
@@ -93,6 +93,7 @@ properties:
|
||||
description: The payment collection's metadata.
|
||||
status:
|
||||
type: string
|
||||
description: The payment collection's status.
|
||||
enum:
|
||||
- canceled
|
||||
- not_paid
|
||||
|
||||
@@ -55,6 +55,7 @@ properties:
|
||||
description: The product's is giftcard.
|
||||
status:
|
||||
type: string
|
||||
description: The product's status.
|
||||
enum:
|
||||
- draft
|
||||
- proposed
|
||||
|
||||
@@ -19,6 +19,7 @@ properties:
|
||||
description: The rule's attribute.
|
||||
operator:
|
||||
type: string
|
||||
description: The rule's operator.
|
||||
enum:
|
||||
- gt
|
||||
- lt
|
||||
|
||||
@@ -37,6 +37,7 @@ properties:
|
||||
description: The order change's version.
|
||||
change_type:
|
||||
type: string
|
||||
description: The order change's change type.
|
||||
enum:
|
||||
- return
|
||||
- exchange
|
||||
|
||||
@@ -212,14 +212,14 @@ properties:
|
||||
$ref: ./OrderItem.yaml
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: created_at
|
||||
description: The item's created at.
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: updated_at
|
||||
description: The item's updated at.
|
||||
format: date-time
|
||||
metadata:
|
||||
type: object
|
||||
description: The item's metadata.
|
||||
@@ -659,6 +659,7 @@ properties:
|
||||
x-schemaName: OrderChangeAction
|
||||
status:
|
||||
type: string
|
||||
description: The order preview's status.
|
||||
enum:
|
||||
- canceled
|
||||
- requires_action
|
||||
|
||||
@@ -0,0 +1,77 @@
|
||||
type: object
|
||||
description: The cart's billing address.
|
||||
x-schemaName: StoreCartAddress
|
||||
required:
|
||||
- id
|
||||
- created_at
|
||||
- updated_at
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The billing address's ID.
|
||||
customer_id:
|
||||
type: string
|
||||
title: customer_id
|
||||
description: The billing address's customer id.
|
||||
first_name:
|
||||
type: string
|
||||
title: first_name
|
||||
description: The billing address's first name.
|
||||
last_name:
|
||||
type: string
|
||||
title: last_name
|
||||
description: The billing address's last name.
|
||||
phone:
|
||||
type: string
|
||||
title: phone
|
||||
description: The billing address's phone.
|
||||
company:
|
||||
type: string
|
||||
title: company
|
||||
description: The billing address's company.
|
||||
address_1:
|
||||
type: string
|
||||
title: address_1
|
||||
description: The billing address's address 1.
|
||||
address_2:
|
||||
type: string
|
||||
title: address_2
|
||||
description: The billing address's address 2.
|
||||
city:
|
||||
type: string
|
||||
title: city
|
||||
description: The billing address's city.
|
||||
country_code:
|
||||
type: string
|
||||
title: country_code
|
||||
description: The billing address's country code.
|
||||
province:
|
||||
type: string
|
||||
title: province
|
||||
description: The billing address's province.
|
||||
postal_code:
|
||||
type: string
|
||||
title: postal_code
|
||||
description: The billing address's postal code.
|
||||
metadata:
|
||||
type: object
|
||||
description: The billing address's metadata.
|
||||
created_at:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: created_at
|
||||
description: The billing address's created at.
|
||||
- type: string
|
||||
title: created_at
|
||||
description: The billing address's created at.
|
||||
format: date-time
|
||||
updated_at:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: updated_at
|
||||
description: The billing address's updated at.
|
||||
- type: string
|
||||
title: updated_at
|
||||
description: The billing address's updated at.
|
||||
format: date-time
|
||||
@@ -0,0 +1,306 @@
|
||||
type: object
|
||||
description: The item's items.
|
||||
x-schemaName: StoreCartLineItem
|
||||
required:
|
||||
- id
|
||||
- title
|
||||
- quantity
|
||||
- requires_shipping
|
||||
- is_discountable
|
||||
- is_tax_inclusive
|
||||
- unit_price
|
||||
- cart
|
||||
- cart_id
|
||||
- original_total
|
||||
- original_subtotal
|
||||
- original_tax_total
|
||||
- item_total
|
||||
- item_subtotal
|
||||
- item_tax_total
|
||||
- total
|
||||
- subtotal
|
||||
- tax_total
|
||||
- discount_total
|
||||
- discount_tax_total
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The item's ID.
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The item's title.
|
||||
subtitle:
|
||||
type: string
|
||||
title: subtitle
|
||||
description: The item's subtitle.
|
||||
thumbnail:
|
||||
type: string
|
||||
title: thumbnail
|
||||
description: The item's thumbnail.
|
||||
quantity:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: quantity
|
||||
description: The item's quantity.
|
||||
- type: number
|
||||
title: quantity
|
||||
description: The item's quantity.
|
||||
- type: string
|
||||
title: quantity
|
||||
description: The item's quantity.
|
||||
- $ref: ./IBigNumber.yaml
|
||||
product:
|
||||
$ref: ./BaseProduct.yaml
|
||||
product_id:
|
||||
type: string
|
||||
title: product_id
|
||||
description: The item's product id.
|
||||
product_title:
|
||||
type: string
|
||||
title: product_title
|
||||
description: The item's product title.
|
||||
product_description:
|
||||
type: string
|
||||
title: product_description
|
||||
description: The item's product description.
|
||||
product_subtitle:
|
||||
type: string
|
||||
title: product_subtitle
|
||||
description: The item's product subtitle.
|
||||
product_type:
|
||||
type: string
|
||||
title: product_type
|
||||
description: The item's product type.
|
||||
product_collection:
|
||||
type: string
|
||||
title: product_collection
|
||||
description: The item's product collection.
|
||||
product_handle:
|
||||
type: string
|
||||
title: product_handle
|
||||
description: The item's product handle.
|
||||
variant:
|
||||
$ref: ./BaseProductVariant.yaml
|
||||
variant_id:
|
||||
type: string
|
||||
title: variant_id
|
||||
description: The item's variant id.
|
||||
variant_sku:
|
||||
type: string
|
||||
title: variant_sku
|
||||
description: The item's variant sku.
|
||||
variant_barcode:
|
||||
type: string
|
||||
title: variant_barcode
|
||||
description: The item's variant barcode.
|
||||
variant_title:
|
||||
type: string
|
||||
title: variant_title
|
||||
description: The item's variant title.
|
||||
variant_option_values:
|
||||
type: object
|
||||
description: The item's variant option values.
|
||||
requires_shipping:
|
||||
type: boolean
|
||||
title: requires_shipping
|
||||
description: The item's requires shipping.
|
||||
is_discountable:
|
||||
type: boolean
|
||||
title: is_discountable
|
||||
description: The item's is discountable.
|
||||
is_tax_inclusive:
|
||||
type: boolean
|
||||
title: is_tax_inclusive
|
||||
description: The item's is tax inclusive.
|
||||
compare_at_unit_price:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: compare_at_unit_price
|
||||
description: The item's compare at unit price.
|
||||
- type: number
|
||||
title: compare_at_unit_price
|
||||
description: The item's compare at unit price.
|
||||
- type: string
|
||||
title: compare_at_unit_price
|
||||
description: The item's compare at unit price.
|
||||
- $ref: ./IBigNumber.yaml
|
||||
unit_price:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: unit_price
|
||||
description: The item's unit price.
|
||||
- type: number
|
||||
title: unit_price
|
||||
description: The item's unit price.
|
||||
- type: string
|
||||
title: unit_price
|
||||
description: The item's unit price.
|
||||
- $ref: ./IBigNumber.yaml
|
||||
tax_lines:
|
||||
type: array
|
||||
description: The item's tax lines.
|
||||
items:
|
||||
$ref: ./BaseLineItemTaxLine.yaml
|
||||
adjustments:
|
||||
type: array
|
||||
description: The item's adjustments.
|
||||
items:
|
||||
$ref: ./BaseLineItemAdjustment.yaml
|
||||
cart:
|
||||
$ref: ./BaseCart.yaml
|
||||
cart_id:
|
||||
type: string
|
||||
title: cart_id
|
||||
description: The item's cart id.
|
||||
metadata:
|
||||
type: object
|
||||
description: The item's metadata.
|
||||
created_at:
|
||||
type: string
|
||||
title: created_at
|
||||
description: The item's created at.
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
title: updated_at
|
||||
description: The item's updated at.
|
||||
format: date-time
|
||||
deleted_at:
|
||||
type: string
|
||||
title: deleted_at
|
||||
description: The item's deleted at.
|
||||
format: date-time
|
||||
original_total:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: original_total
|
||||
description: The item's original total.
|
||||
- type: number
|
||||
title: original_total
|
||||
description: The item's original total.
|
||||
- type: string
|
||||
title: original_total
|
||||
description: The item's original total.
|
||||
- $ref: ./IBigNumber.yaml
|
||||
original_subtotal:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: original_subtotal
|
||||
description: The item's original subtotal.
|
||||
- type: number
|
||||
title: original_subtotal
|
||||
description: The item's original subtotal.
|
||||
- type: string
|
||||
title: original_subtotal
|
||||
description: The item's original subtotal.
|
||||
- $ref: ./IBigNumber.yaml
|
||||
original_tax_total:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: original_tax_total
|
||||
description: The item's original tax total.
|
||||
- type: number
|
||||
title: original_tax_total
|
||||
description: The item's original tax total.
|
||||
- type: string
|
||||
title: original_tax_total
|
||||
description: The item's original tax total.
|
||||
- $ref: ./IBigNumber.yaml
|
||||
item_total:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: item_total
|
||||
description: The item's item total.
|
||||
- type: number
|
||||
title: item_total
|
||||
description: The item's item total.
|
||||
- type: string
|
||||
title: item_total
|
||||
description: The item's item total.
|
||||
- $ref: ./IBigNumber.yaml
|
||||
item_subtotal:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: item_subtotal
|
||||
description: The item's item subtotal.
|
||||
- type: number
|
||||
title: item_subtotal
|
||||
description: The item's item subtotal.
|
||||
- type: string
|
||||
title: item_subtotal
|
||||
description: The item's item subtotal.
|
||||
- $ref: ./IBigNumber.yaml
|
||||
item_tax_total:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: item_tax_total
|
||||
description: The item's item tax total.
|
||||
- type: number
|
||||
title: item_tax_total
|
||||
description: The item's item tax total.
|
||||
- type: string
|
||||
title: item_tax_total
|
||||
description: The item's item tax total.
|
||||
- $ref: ./IBigNumber.yaml
|
||||
total:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: total
|
||||
description: The item's total.
|
||||
- type: number
|
||||
title: total
|
||||
description: The item's total.
|
||||
- type: string
|
||||
title: total
|
||||
description: The item's total.
|
||||
- $ref: ./IBigNumber.yaml
|
||||
subtotal:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: subtotal
|
||||
description: The item's subtotal.
|
||||
- type: number
|
||||
title: subtotal
|
||||
description: The item's subtotal.
|
||||
- type: string
|
||||
title: subtotal
|
||||
description: The item's subtotal.
|
||||
- $ref: ./IBigNumber.yaml
|
||||
tax_total:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: tax_total
|
||||
description: The item's tax total.
|
||||
- type: number
|
||||
title: tax_total
|
||||
description: The item's tax total.
|
||||
- type: string
|
||||
title: tax_total
|
||||
description: The item's tax total.
|
||||
- $ref: ./IBigNumber.yaml
|
||||
discount_total:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: discount_total
|
||||
description: The item's discount total.
|
||||
- type: number
|
||||
title: discount_total
|
||||
description: The item's discount total.
|
||||
- type: string
|
||||
title: discount_total
|
||||
description: The item's discount total.
|
||||
- $ref: ./IBigNumber.yaml
|
||||
discount_tax_total:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: discount_tax_total
|
||||
description: The item's discount tax total.
|
||||
- type: number
|
||||
title: discount_tax_total
|
||||
description: The item's discount tax total.
|
||||
- type: string
|
||||
title: discount_tax_total
|
||||
description: The item's discount tax total.
|
||||
- $ref: ./IBigNumber.yaml
|
||||
@@ -94,6 +94,7 @@ properties:
|
||||
$ref: ./BasePaymentCollection.yaml
|
||||
payment_status:
|
||||
type: string
|
||||
description: The order's payment status.
|
||||
enum:
|
||||
- canceled
|
||||
- not_paid
|
||||
@@ -112,6 +113,7 @@ properties:
|
||||
$ref: ./BaseOrderFulfillment.yaml
|
||||
fulfillment_status:
|
||||
type: string
|
||||
description: The order's fulfillment status.
|
||||
enum:
|
||||
- canceled
|
||||
- not_fulfilled
|
||||
|
||||
@@ -93,6 +93,7 @@ properties:
|
||||
description: The payment collection's metadata.
|
||||
status:
|
||||
type: string
|
||||
description: The payment collection's status.
|
||||
enum:
|
||||
- canceled
|
||||
- not_paid
|
||||
|
||||
@@ -42,6 +42,7 @@ properties:
|
||||
description: The product's title.
|
||||
status:
|
||||
type: string
|
||||
description: The product's status.
|
||||
enum:
|
||||
- draft
|
||||
- proposed
|
||||
|
||||
@@ -60,6 +60,9 @@ properties:
|
||||
description: The category's category children.
|
||||
items:
|
||||
$ref: ./BaseProductCategory.yaml
|
||||
metadata:
|
||||
type: object
|
||||
description: The category's metadata.
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
|
||||
@@ -9,6 +9,7 @@ required:
|
||||
- items
|
||||
- received_at
|
||||
- created_at
|
||||
- canceled_at
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
@@ -64,3 +65,7 @@ properties:
|
||||
format: date-time
|
||||
title: created_at
|
||||
description: The return's created at.
|
||||
canceled_at:
|
||||
type: string
|
||||
title: canceled_at
|
||||
description: The return's canceled at.
|
||||
|
||||
@@ -26,6 +26,7 @@ properties:
|
||||
description: The shipping option's name.
|
||||
price_type:
|
||||
type: string
|
||||
description: The shipping option's price type.
|
||||
enum:
|
||||
- flat
|
||||
- calculated
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
type: object
|
||||
description: The workflow execution's context.
|
||||
x-schemaName: WorkflowExecutionContext
|
||||
required:
|
||||
- compensate
|
||||
- errors
|
||||
properties:
|
||||
data:
|
||||
type: object
|
||||
description: The context's data.
|
||||
compensate:
|
||||
type: object
|
||||
description: The context's compensate.
|
||||
errors:
|
||||
type: array
|
||||
description: The context's errors.
|
||||
items:
|
||||
type: object
|
||||
description: The error's errors.
|
||||
Reference in New Issue
Block a user