Files
medusa-store/docs/api/admin/components/schemas/AdminOrdersListRes.yaml
2023-04-04 21:02:44 +03:00

124 lines
3.1 KiB
YAML

type: object
x-expanded-relations:
field: orders
relations:
- billing_address
- claims
- claims.additional_items
- claims.additional_items.variant
- claims.claim_items
- claims.claim_items.images
- claims.claim_items.item
- claims.fulfillments
- claims.fulfillments.tracking_links
- claims.return_order
- claims.return_order.shipping_method
- claims.return_order.shipping_method.tax_lines
- claims.shipping_address
- claims.shipping_methods
- customer
- discounts
- discounts.rule
- fulfillments
- fulfillments.items
- fulfillments.tracking_links
- gift_card_transactions
- gift_cards
- items
- payments
- refunds
- region
- returns
- returns.items
- returns.items.reason
- returns.shipping_method
- returns.shipping_method.tax_lines
- shipping_address
- shipping_methods
eager:
- fulfillments.items
- region.fulfillment_providers
- region.payment_providers
- returns.items
- shipping_methods.shipping_option
implicit:
- claims
- claims.additional_items
- claims.additional_items.adjustments
- claims.additional_items.refundable
- claims.additional_items.tax_lines
- discounts
- discounts.rule
- gift_card_transactions
- gift_card_transactions.gift_card
- gift_cards
- items
- items.adjustments
- items.refundable
- items.tax_lines
- items.variant
- items.variant.product
- refunds
- region
- shipping_methods
- shipping_methods.tax_lines
- swaps
- swaps.additional_items
- swaps.additional_items.adjustments
- swaps.additional_items.refundable
- swaps.additional_items.tax_lines
totals:
- discount_total
- gift_card_tax_total
- gift_card_total
- paid_total
- refundable_amount
- refunded_total
- shipping_total
- subtotal
- tax_total
- total
- claims.additional_items.discount_total
- claims.additional_items.gift_card_total
- claims.additional_items.original_tax_total
- claims.additional_items.original_total
- claims.additional_items.refundable
- claims.additional_items.subtotal
- claims.additional_items.tax_total
- claims.additional_items.total
- items.discount_total
- items.gift_card_total
- items.original_tax_total
- items.original_total
- items.refundable
- items.subtotal
- items.tax_total
- items.total
- swaps.additional_items.discount_total
- swaps.additional_items.gift_card_total
- swaps.additional_items.original_tax_total
- swaps.additional_items.original_total
- swaps.additional_items.refundable
- swaps.additional_items.subtotal
- swaps.additional_items.tax_total
- swaps.additional_items.total
required:
- orders
- count
- offset
- limit
properties:
orders:
type: array
items:
$ref: ./Order.yaml
count:
type: integer
description: The total number of items available
offset:
type: integer
description: The number of items skipped before these items
limit:
type: integer
description: The number of items per page