---
title: "aid_orders_get"
method: GET
path: "/accounts/{aid}/shopping/orders"
tags: ["order.list"]
---

# aid_orders_get

`GET /accounts/{aid}/shopping/orders`

Retrieve a list of orders

scopes:
- admin:shopping
- read:shopping

## Path parameters

- `aid` string, ^[PT]{1}\d{8}$, required

## Query parameters

- `starting_after` string, checkout-id
- `limit` integer
- `status` string[]
- `payment_status` string[]
- `created_at.gte` string, date
- `created_at.lte` string, date
- `include_events` string[]
- `card_brand` string[]
- `card_number` string[]
- `psp` string[]
- `payment_product` string[]
- `payment_product_type` string[]
- `net_amount.gte` integer
- `net_amount.lte` integer
- `currency` string[]
- `search` string
- `itinerary_travel_mode` string[]
- `itinerary_arrival_address` string
- `itinerary_departure_address` string
- `items_discount_lines_discount_type` string[]

## Response `200`

order collection

- object
  - `orders` object[], required
    - `id` string, uuid — An UUID that uniquely identifies the resource
    - `created_at` string, date-time — The date-time when the resource was created
    - `created_by` string — The ID of the user/client created the resource
    - `updated_at` string, date-time — The date-time when the resource was last updated
    - `deleted_by` string — The ID of the user/client created the resource
    - `deleted_at` string, date-time
    - `cancelled_reason` string — The reason why the order was canceled. - **customer**: The customer cancelled the order - **declined**: The payment was declined - **other**: Any reson
    - `cancelled_by` string — The resource ID. Defaults to UUID v4
    - `cancelled_at` string, date-time — Read-only timestamp, automatically assigned on back-end.
    - `closed_by` string — The resource ID. Defaults to UUID v4
    - `closed_at` string, date-time — Read-only timestamp, automatically assigned on back-end.
    - `status` 'open' | 'closed' | 'cancelled' — Order status
    - `payment_status` 'pending' | 'partially_paid' | 'paid' | 'partially_refunded' | 'refunded' — The status of payments associated with the order - **pending**: The payments are pending - **paid**: The payments has been paid - **partially_refunded**: The payments has been partially refunded - **refunded**: The payments has been partially refunded
    - `customer` Customer
      - `metadata` object — A set of key/value pairs that you can attach to a customer object. It can be useful for storing additional information about the customer in a structured format. You can unset an individual key by setting its value to null and then saving. To clear all keys, set metadata to null
      - `id` string, uuid — An UUID that uniquely identifies the resource
      - `created_at` string, date-time — The date-time when the resource was created
      - `created_by` string — The ID of the user/client created the resource
      - `updated_at` string, date-time — The date-time when the resource was last updated
      - `deleted_by` string — The ID of the user/client created the resource
      - `deleted_at` string, date-time
      - `first_name` string, nullable
      - `last_name` string, nullable
      - `email` string, nullable — customer email, case insensitive duplication control prevents multiple user with same `type` to have equal email customer@example.com is equal to CUStOMer@EXAMPLE.com
      - `phone_number` string, ^\+?[1-9]\d{1,14}$, nullable — A phone number in E.164 number formatting.
      - `attributes` object — Custom attributes
      - `status` string, nullable — Status of the customer
      - `favorite_store` string, nullable — customer favorite store
      - `enrolled_by` object — The source that recruited the customer
        - `type` string — Enrollment type, e.g. `url`, `store`, `qr_code`, any string
        - `value` string, nullable, required
      - `marketing_consent` object — Customers consent for marketing in different channels
        - `sms` UserConsent
          - `consent` boolean
          - `updated_at` string, date-time — The date-time when the resource was last updated:
        - `email` UserConsent
          - `consent` boolean
          - `updated_at` string, date-time — The date-time when the resource was last updated:
      - `type` 'customer' | 'company' | 'contact' | 'employee' | 'other', required — Describe type of a user. - `company` property is required when using the type `company` - `company` property is only supported for users with type `other` or `company` - Creating or updating user with type `employee` or `other` requires `admin:customers` or `write:customers` scope. - User login is only available for users with type `customer` or `company`
      - `addresses` CustomerAddress[]
        - `address_line` string, required
        - `address_line_2` string
        - `postal_code` string
        - `postal_place` string, required
        - `country` string, iso-3166-1, required — ISO 3166-1 country code
        - `latitude` number
        - `longitude` number
        - `type` 'custom' | 'home' | 'other' | 'work' — The address type
        - `custom_type` string — If the address `type` is `custom`, this property contains the custom value
        - `comment` string — Comment about the address
      - `term` CustomerTerm
        - `id` string, uuid
        - `accepted_at` string, date-time
      - `company` object — Company details, supported when type is Company
        - `organization_number` string — Companys identification number
        - `bussiness_name` string, required
        - `department` string — companys department
        - `industry` string
        - `website` string
        - `number_of_employees` string
      - `gender` string, nullable
      - `date_of_birth` string, date, nullable
      - `contact_for` object[] — The users that it is a contact for, supported when type is `contact`
        - `customer_id` string, required — The customer id that it is a contact for
    - `gross_amount` integer — Monetary amount in smallest unit for the currency before discounts
    - `net_amount` integer — Monetary amount in smallest unit for the currency after discounts
    - `total_discount` integer — Monetary amount in smallest unit for the currency
    - `total_manual_discount_amount` integer — Monetary amount in smallest unit for the currency
    - `shipping_address` ContactObject
      - `address_line` string, required
      - `address_line_2` string
      - `postal_code` string
      - `postal_place` string, required
      - `country` string, iso-3166-1, required — ISO 3166-1 country code
      - `first_name` string
      - `last_name` string
      - `comment` string — Comment about the address
    - `billing_address` ContactObject
      - `address_line` string, required
      - `address_line_2` string
      - `postal_code` string
      - `postal_place` string, required
      - `country` string, iso-3166-1, required — ISO 3166-1 country code
      - `first_name` string
      - `last_name` string
      - `comment` string — Comment about the address
    - `metadata` object — Additional data related to the order
    - `comment` string — Comment on the order
    - `salesperson_id` string — Id of the sales person if other then the operator
    - `salesperson_name` string — Name of the sales person
    - `delivery_at` string, date-time — Requested delivery time by the customer, default value is ASAP relative to when the order was created.
    - `pickup_at` string, date-time — Requested pickup time for the courier
    - `courier_id` string — Id of the courier responsible for the delivery
    - `pre_order` boolean — Customer requested the delivery to be later, i.e not ASAP, see delivery_at for when the delivery should be completed.
    - `time_to_live` integer — Time-To-Live (TTL) for the order created in seconds. The value is interpreted as a delta from the time that an order was last modified (update_at). All drafts related to an order will be deleted when the TTL expires and the order will be emptied for all data except - order_number - order_id - external_ids - created_at - updated_at - deleted_at
    - `itinerary` OrderTravelItinerary[]
      - `id` string
      - `operator` string
      - `arrival_address` OrderItineraryAddress
        - `id` string
        - `name` string
        - `address_line` string
        - `address_line_2` string
        - `postal_code` string
        - `postal_place` string
        - `latitude` number
        - `longitude` number
        - `country` string, iso3166-alpha2 — ISO 3166-1 country code
        - `external_ids` object[] — External IDs related to the address.
          - `id` string, required
          - `source` string, required
          - `description` string
      - `arrival_at` string, datetime
      - `departure_address` OrderItineraryAddress
        - `id` string
        - `name` string
        - `address_line` string
        - `address_line_2` string
        - `postal_code` string
        - `postal_place` string
        - `latitude` number
        - `longitude` number
        - `country` string, iso3166-alpha2 — ISO 3166-1 country code
        - `external_ids` object[] — External IDs related to the address.
          - `id` string, required
          - `source` string, required
          - `description` string
      - `departure_at` string, datetime
      - `travel_mode` 'BUS' | 'CAR' | 'FERRY' | 'METRO' | 'TAXI' | 'TRAIN' | 'TRAM' | 'WALK' | 'WAIT' | 'CUSTOM'
      - `route_id` string
      - `vehicle_id` string
      - `summary` string
      - `distance` object
        - `value` integer, required
      - `duration` object
        - `value` integer, required
      - `tickets` object[]
        - `class` string
        - `line` string
        - `seat` string
        - `zone` string
        - `passenger_id` string[]
      - `line_ids` integer[] — related order items
      - `waypoints` object[]
        - `display_name` string
        - `latitude` number, required
        - `longitude` number, required
        - `arrival_schedule_at` string, datetime
        - `departure_schedule_at` string, datetime
    - `external_ids` OrderExternalId[]
      - `id` string, required
      - `source` string, required
      - `description` string
    - `items` object[] — Update status on order items
      - `status` string — The item status
      - `id` string — The ID or SKU of the product on the line
      - `metadata` object — Additional details about the item, key values will be included as `extra_info` in the receipt.
      - `groups` object[] — The groups the product on the line belongs to
        - `id` string, required — group id
        - `name` string — group name
      - `line_id` integer — The number of the line (or id), must be unique between all items.
      - `quantity` number — The quantity of the product in the item line.
      - `gross_amount` integer, required — Monetary amount in smallest unit for the currency before discounts
      - `net_amount` integer — Monetary amount in smallest unit for the currency after discounts
      - `tax_lines` TaxItem[], required
        - `amount` integer — Monetary amount in smallest unit for the currency
        - `amount_dwh` string — Monetary value with decimal
        - `exempt` boolean
        - `included_in_price` boolean
        - `percentage` number
        - `tax_basis` integer — Total monetary value without tax
        - `tax_basis_dwh` string — Total monetary value without tax in decimal
        - `tax_code` string
        - `tax_group` string
      - `description` string
      - `description_alias` string — Short description / title of the product
      - `is_changed` boolean — Discount applied to gross amount
      - `eligible_for_discount` boolean
      - `dimension` Dimension — Identify item attributes, such as size and color
        - `color` string
        - `size` string
        - `style` string
        - `config` string
        - `variant` string
      - `discount_lines` DiscountItem[]
        - `amount` integer — Monetary amount in smallest unit for the currency
        - `percentage` number — Optional, set if the amount given was from a percentage discount
        - `discount_type` 'customer' | 'periodic' | 'manual' | 'loyalty' | 'total' | 'employee' | 'external'
        - `discount_id` string
        - `description` string
        - `line_id` integer
      - `additions` object[] — Additions, customization of the item. The gross_amount for an `addition` should be included in the item `gross_amount` and included in the `tax_lines` if applicable.
        - `id` string
        - `description` string
        - `quantity` number — The quantity of the addition
        - `gross_amount` integer — Monetary amount in smallest unit for the currency
        - `groups` object[] — The groups the product on the line belongs to
          - `id` string, required — group id
          - `name` string — group name
      - `store` object
        - `id` string, required
        - `organization_number` string
        - `name` string — name of the store, aka trade name of the store
        - `business_name` string — Official name of the person or entity that owns the store.
        - `comment` string — Comment to the sales location
      - `external_id` string — External ID related to the item.
      - `related_item` object — Relationship with another line item. An item with a `required` relationship with another line item will be removed from the order if the related item is removed An item with `optional` relationship will remain in the order if the related line is removed, the `related_item` will be cleared as the line it relates to does not exist anymore An item with `reversed` relationship is an item that is reversing another item. An item with the `reversed` relationship we be removed from the order if the related item is removed
        - `line_id` integer, required
        - `type` 'required' | 'optional' | 'reversed', required
      - `salesperson_id` string — Id of the sales person if other then the operator
      - `salesperson_name` string — Name of the sales person
      - `comment` string — comment on the item
      - `version` number
      - `reversed_reason` string — Reverse the item from an order Applicable only if the draft is created to update an existing order
      - `dynamic_payout` object — Specify the payout rule that should be used when calculating the payout split for this item.
        - `rule_type` string, required
        - `rule_id` string, required
      - `payout` SplitPayout — A Payout rule describes how a payout should be splitted between multiple destinations.
        - `account_id` string, ^[PT]{1}\d{8}$ — An id that uniquely identifies the account.
        - `rule_type` string, required
        - `rule_id` string, required — Unique ID given the rule type.
        - `rule_version` number
        - `destinations` BillingPayoutRuleDestination[], required — Destinations for the payout splits tree. The splitting is done in the order of the destinations. - A destination must include a `destination` or `destinations`. - The destination `value` is required for destinations with type `percentage` and `flat_amount`
          - `type` 'percentage' | 'flat_amount' | 'remaining_amount', required
          - `value` string, numeric — The value that will be used for the payout to the destination or destinations.
          - `destination` string
          - `destinations` BillingPayoutRuleDestinationNested[] — Array of sub destinations.
            - `type` 'percentage' | 'flat_amount' | 'remaining_amount', required
            - `value` string, numeric — The value that will be used for the payout to the destination or destinations.
            - `destination` string
            - `destinations` object[] — Array of sub destinations.
              - …
            - `amount` integer — The split payout calculated for this destination or list of destinations.
          - `amount` integer
        - `metadata` object — Additional metadata about the payout rule
      - `original_currency` string, iso-4217 — Representing the currency in which the item was originally priced
      - `original_gross_amount` integer — Monetary amount in smallest unit for the original currency
      - `conversion_rate_ppm` integer — Scaled integer (parts per million) representing the conversion rate used to translate `original_currency` gross amount into the orders `currency`. Example: If 1 SEK = 1.099 NOK, then `conversion_rate_ppm = 1099000`
      - `conversion_rate_timestamp` string, date-time — The timestamp indicating when the exchange rate was determined.
      - `conversion_rate_source` string — Identifier of the source of the exchange rate
    - `version` integer — The version of the order. Incremented when the order is updated.
    - `type` string — Describe the type of an order.
    - `order_number` string
    - `currency` string, iso-4217, required — The tree-character ISO-4217 currency
    - `order_id` string — The order id, defaults to the resource id, UUID. > Requires split_draft option to be disabled.
    - `time_to_live_expires_at` string, data-time — The date-time when the resource expires.
    - `multiple_authorizations` boolean — Allow multiple authorizations per order item
    - `payment_details` object
      - `remaining_capture_amount` integer — Monetary amount in smallest unit for the currency
      - `remaining_refund_amount` integer — Monetary amount in smallest unit for the currency
      - `remaining_cancellation_amount` integer — Monetary amount in smallest unit for the currency
      - `amount_due` integer — The amount due. The value will be negative if a refund is required to close the order. Monetary amount in smallest unit for the currency
      - `remaining_authorization_amount` integer — Monetary amount in smallest unit for the currency
    - `sessions` OrderSession[] — A list of sessions for this order
      - `id` string — The resource ID. Defaults to UUID v4
      - `created_at` string, date-time — Read-only timestamp, automatically assigned on back-end.
      - `created_by` string — The resource ID. Defaults to UUID v4
      - `amount` integer — Monetary amount in smallest unit for the currency success: description: | The result from the operation. type: boolean
      - `items` object[], required — Selected items from the order
        - `amount` integer — Monetary amount in smallest unit for the currency
        - `line_id` string, required — Selected order items to include in the session
      - `processed_at` string, date-time — The date and time when the capture was processed by payment gateway
      - `metadata` object — Additional details about the operation
      - `_links` Link[] — The links related to resource
        - `href` string, required — The link URL
        - `rel` 'draft' | 'events' | 'order' | 'receipt' | 'self' | 'session' | 'session-checkout' | 'transaction', required — The link type
    - `authorizations` OrderAuthorization[] — A list of authorizations for this order
      - `items` object[], required — Selected items from the order
        - `original_currency` string, iso-4217 — Representing the currency in which the item was originally priced
        - `original_gross_amount` integer — Monetary amount in smallest unit for the original currency
        - `conversion_rate_ppm` integer — Scaled integer (parts per million) representing the conversion rate used to translate `original_currency` gross amount into the orders `currency`. Example: If 1 SEK = 1.099 NOK, then `conversion_rate_ppm = 1099000`
        - `conversion_rate_timestamp` string, date-time — The timestamp indicating when the exchange rate was determined.
        - `conversion_rate_source` string — Identifier of the source of the exchange rate
        - `amount` integer, required — Monetary amount in smallest unit for the currency
        - `line_id` integer, required
        - `payout` object — Describe the payout for the operation item
          - `rule_id` string, required
          - `rule_type` string, required
          - `destinations` object[], required — How the operation monetary amount should be split given the payout rule. The items are aggregated by destination
            - `destination` string, required — The destination reciving the payout
            - `amount` integer, required — The monetary amount reserved for the destination
      - `processed_at` string, date-time — The date and time when the payment operation was processed by payment gateway
      - `processed_by` string — The gateway the processed the payment operation
      - `payment_details` object
        - `psp` string
        - `payment_id` string
        - `payment_product` string
        - `payment_product_type` string
        - `card` OrderOperationCard
          - `masked_pan` string
          - `type` string
          - `brand` string
          - `metadata` object — Additional details about the payment
      - `metadata` object — Additional details about the operation
      - `id` string — The resource ID. Defaults to UUID v4
      - `created_at` string, date-time — Read-only timestamp, automatically assigned on back-end.
      - `created_by` string — The resource ID. Defaults to UUID v4
      - `amount` integer — Total monetary amount for the operation in smallest unit for the currency
      - `success` boolean — The result from the operation.
      - `_links` Link[] — The links related to resource
        - `href` string, required — The link URL
        - `rel` 'draft' | 'events' | 'order' | 'receipt' | 'self' | 'session' | 'session-checkout' | 'transaction', required — The link type
      - `authorization_id` string — The resource ID. Defaults to UUID v4
    - `captures` OrderCapture[] — A list of captures for this order
      - `items` object[], required — Selected items from the order
        - `original_currency` string, iso-4217 — Representing the currency in which the item was originally priced
        - `original_gross_amount` integer — Monetary amount in smallest unit for the original currency
        - `conversion_rate_ppm` integer — Scaled integer (parts per million) representing the conversion rate used to translate `original_currency` gross amount into the orders `currency`. Example: If 1 SEK = 1.099 NOK, then `conversion_rate_ppm = 1099000`
        - `conversion_rate_timestamp` string, date-time — The timestamp indicating when the exchange rate was determined.
        - `conversion_rate_source` string — Identifier of the source of the exchange rate
        - `amount` integer, required — Monetary amount in smallest unit for the currency
        - `line_id` integer, required
        - `payout` object — Describe the payout for the operation item
          - `rule_id` string, required
          - `rule_type` string, required
          - `destinations` object[], required — How the operation monetary amount should be split given the payout rule. The items are aggregated by destination
            - `destination` string, required — The destination reciving the payout
            - `amount` integer, required — The monetary amount reserved for the destination
      - `processed_at` string, date-time — The date and time when the payment operation was processed by payment gateway
      - `processed_by` string — The gateway the processed the payment operation
      - `payment_details` object
        - `psp` string
        - `payment_id` string
        - `payment_product` string
        - `payment_product_type` string
        - `card` OrderOperationCard
          - `masked_pan` string
          - `type` string
          - `brand` string
          - `metadata` object — Additional details about the payment
      - `metadata` object — Additional details about the operation
      - `id` string — The resource ID. Defaults to UUID v4
      - `created_at` string, date-time — Read-only timestamp, automatically assigned on back-end.
      - `created_by` string — The resource ID. Defaults to UUID v4
      - `amount` integer — Total monetary amount for the operation in smallest unit for the currency
      - `success` boolean — The result from the operation.
      - `_links` Link[] — The links related to resource
        - `href` string, required — The link URL
        - `rel` 'draft' | 'events' | 'order' | 'receipt' | 'self' | 'session' | 'session-checkout' | 'transaction', required — The link type
      - `authorization_id` string — The resource ID. Defaults to UUID v4
    - `refunds` OrderRefund[] — A list of refunds for this order
      - `items` object[], required — Selected items from the order
        - `original_currency` string, iso-4217 — Representing the currency in which the item was originally priced
        - `original_gross_amount` integer — Monetary amount in smallest unit for the original currency
        - `conversion_rate_ppm` integer — Scaled integer (parts per million) representing the conversion rate used to translate `original_currency` gross amount into the orders `currency`. Example: If 1 SEK = 1.099 NOK, then `conversion_rate_ppm = 1099000`
        - `conversion_rate_timestamp` string, date-time — The timestamp indicating when the exchange rate was determined.
        - `conversion_rate_source` string — Identifier of the source of the exchange rate
        - `amount` integer, required — Monetary amount in smallest unit for the currency
        - `line_id` integer, required
        - `payout` object — Describe the payout for the operation item
          - `rule_id` string, required
          - `rule_type` string, required
          - `destinations` object[], required — How the operation monetary amount should be split given the payout rule. The items are aggregated by destination
            - `destination` string, required — The destination reciving the payout
            - `amount` integer, required — The monetary amount reserved for the destination
      - `processed_at` string, date-time — The date and time when the payment operation was processed by payment gateway
      - `processed_by` string — The gateway the processed the payment operation
      - `payment_details` object
        - `psp` string
        - `payment_id` string
        - `payment_product` string
        - `payment_product_type` string
        - `card` OrderOperationCard
          - `masked_pan` string
          - `type` string
          - `brand` string
          - `metadata` object — Additional details about the payment
      - `metadata` object — Additional details about the operation
      - `id` string — The resource ID. Defaults to UUID v4
      - `created_at` string, date-time — Read-only timestamp, automatically assigned on back-end.
      - `created_by` string — The resource ID. Defaults to UUID v4
      - `amount` integer — Total monetary amount for the operation in smallest unit for the currency
      - `success` boolean — The result from the operation.
      - `_links` Link[] — The links related to resource
        - `href` string, required — The link URL
        - `rel` 'draft' | 'events' | 'order' | 'receipt' | 'self' | 'session' | 'session-checkout' | 'transaction', required — The link type
      - `authorization_id` string — The resource ID. Defaults to UUID v4
    - `cancellations` OrderCancellation[] — A list of cancellations for this order
      - `items` object[], required — Selected items from the order
        - `original_currency` string, iso-4217 — Representing the currency in which the item was originally priced
        - `original_gross_amount` integer — Monetary amount in smallest unit for the original currency
        - `conversion_rate_ppm` integer — Scaled integer (parts per million) representing the conversion rate used to translate `original_currency` gross amount into the orders `currency`. Example: If 1 SEK = 1.099 NOK, then `conversion_rate_ppm = 1099000`
        - `conversion_rate_timestamp` string, date-time — The timestamp indicating when the exchange rate was determined.
        - `conversion_rate_source` string — Identifier of the source of the exchange rate
        - `amount` integer, required — Monetary amount in smallest unit for the currency
        - `line_id` integer, required
        - `payout` object — Describe the payout for the operation item
          - `rule_id` string, required
          - `rule_type` string, required
          - `destinations` object[], required — How the operation monetary amount should be split given the payout rule. The items are aggregated by destination
            - `destination` string, required — The destination reciving the payout
            - `amount` integer, required — The monetary amount reserved for the destination
      - `processed_at` string, date-time — The date and time when the payment operation was processed by payment gateway
      - `processed_by` string — The gateway the processed the payment operation
      - `payment_details` object
        - `psp` string
        - `payment_id` string
        - `payment_product` string
        - `payment_product_type` string
        - `card` OrderOperationCard
          - `masked_pan` string
          - `type` string
          - `brand` string
          - `metadata` object — Additional details about the payment
      - `metadata` object — Additional details about the operation
      - `id` string — The resource ID. Defaults to UUID v4
      - `created_at` string, date-time — Read-only timestamp, automatically assigned on back-end.
      - `created_by` string — The resource ID. Defaults to UUID v4
      - `amount` integer — Total monetary amount for the operation in smallest unit for the currency
      - `success` boolean — The result from the operation.
      - `_links` Link[] — The links related to resource
        - `href` string, required — The link URL
        - `rel` 'draft' | 'events' | 'order' | 'receipt' | 'self' | 'session' | 'session-checkout' | 'transaction', required — The link type
      - `authorization_id` string — The resource ID. Defaults to UUID v4
    - `discounts` object[]
      - `id` string
      - `refs` object[]
        - `id` string
        - `amount` number
        - `statistics` object
          - `amount` number
          - `stamp` number
          - `usage` number
        - `stamp` number
        - `usages` number
        - `items` object[]
          - `line_id` number
          - `amount` number
    - `store` object
      - `id` string, required
      - `organization_number` string
      - `name` string — name of the store, aka trade name of the store
      - `business_name` string — Official name of the person or entity that owns the store.
      - `comments` string[] — List of all sales location comments
    - `external_links` OrderExternalLink[]
      - `text` string, required — The Link text that will be visible to the reader
      - `href` string, uri, required — The URL to the external resource
      - `public` boolean — The external resources is public and requires no aditional authorization.
    - `attachments` object[]
      - `id` string
      - `bus_reservation` LineItemReservationAttachment
        - `booking_id` string — Trip booking number
        - `line_ids` integer[] — related order items
        - `passengers` object[]
          - `id` string
          - `title` string
          - `first_name` string
          - `last_name` string
        - `itinerary` object[] — Itineray data, one item per segment
          - `departure_address` Address
            - `address_line` string, required
            - `address_line_2` string
            - `postal_code` string
            - `postal_place` string, required
            - `country` string, iso-3166-1, required — ISO 3166-1 country code
          - `departure_at` string, date-time
          - `arrival_address` Address
            - `address_line` string, required
            - `address_line_2` string
            - `postal_code` string
            - `postal_place` string, required
            - `country` string, iso-3166-1, required — ISO 3166-1 country code
          - `arrival_at` string, date-time
          - `operator` string
          - `class` string
          - `line` string
          - `seat` string
          - `zone` string
          - `expires_at` string, date-time
          - `activates_at` string, date-time
          - `passenger_id` string[]
        - `insurance` LineItemIsuranceAttachment[] — Insurance data
          - `insurance_company` string
          - `insurance_type` string
      - `car_reservation` LineItemReservationCarAttachment
        - `booking_id` string — Trip booking number
        - `line_ids` integer[] — related order items
        - `itinerary` object[] — Car itineray data
          - `rental_company` string
          - `drivers_id` string[]
          - `pick_up_address` Address
            - `address_line` string, required
            - `address_line_2` string
            - `postal_code` string
            - `postal_place` string, required
            - `country` string, iso-3166-1, required — ISO 3166-1 country code
          - `pick_up_at` string, date-time
          - `drop_off_address` Address
            - `address_line` string, required
            - `address_line_2` string
            - `postal_code` string
            - `postal_place` string, required
            - `country` string, iso-3166-1, required — ISO 3166-1 country code
          - `drop_off_at` string, date-time
          - `class` string
        - `drivers` string[]
        - `insurance` LineItemIsuranceAttachment[] — Insurance data
          - `insurance_company` string
          - `insurance_type` string
      - `ferry_reservation` LineItemReservationAttachment
        - `booking_id` string — Trip booking number
        - `line_ids` integer[] — related order items
        - `passengers` object[]
          - `id` string
          - `title` string
          - `first_name` string
          - `last_name` string
        - `itinerary` object[] — Itineray data, one item per segment
          - `departure_address` Address
            - `address_line` string, required
            - `address_line_2` string
            - `postal_code` string
            - `postal_place` string, required
            - `country` string, iso-3166-1, required — ISO 3166-1 country code
          - `departure_at` string, date-time
          - `arrival_address` Address
            - `address_line` string, required
            - `address_line_2` string
            - `postal_code` string
            - `postal_place` string, required
            - `country` string, iso-3166-1, required — ISO 3166-1 country code
          - `arrival_at` string, date-time
          - `operator` string
          - `class` string
          - `line` string
          - `seat` string
          - `zone` string
          - `expires_at` string, date-time
          - `activates_at` string, date-time
          - `passenger_id` string[]
        - `insurance` LineItemIsuranceAttachment[] — Insurance data
          - `insurance_company` string
          - `insurance_type` string
      - `metro_reservation` LineItemReservationAttachment
        - `booking_id` string — Trip booking number
        - `line_ids` integer[] — related order items
        - `passengers` object[]
          - `id` string
          - `title` string
          - `first_name` string
          - `last_name` string
        - `itinerary` object[] — Itineray data, one item per segment
          - `departure_address` Address
            - `address_line` string, required
            - `address_line_2` string
            - `postal_code` string
            - `postal_place` string, required
            - `country` string, iso-3166-1, required — ISO 3166-1 country code
          - `departure_at` string, date-time
          - `arrival_address` Address
            - `address_line` string, required
            - `address_line_2` string
            - `postal_code` string
            - `postal_place` string, required
            - `country` string, iso-3166-1, required — ISO 3166-1 country code
          - `arrival_at` string, date-time
          - `operator` string
          - `class` string
          - `line` string
          - `seat` string
          - `zone` string
          - `expires_at` string, date-time
          - `activates_at` string, date-time
          - `passenger_id` string[]
        - `insurance` LineItemIsuranceAttachment[] — Insurance data
          - `insurance_company` string
          - `insurance_type` string
      - `taxi_reservation` LineItemReservationAttachment
        - `booking_id` string — Trip booking number
        - `line_ids` integer[] — related order items
        - `passengers` object[]
          - `id` string
          - `title` string
          - `first_name` string
          - `last_name` string
        - `itinerary` object[] — Itineray data, one item per segment
          - `departure_address` Address
            - `address_line` string, required
            - `address_line_2` string
            - `postal_code` string
            - `postal_place` string, required
            - `country` string, iso-3166-1, required — ISO 3166-1 country code
          - `departure_at` string, date-time
          - `arrival_address` Address
            - `address_line` string, required
            - `address_line_2` string
            - `postal_code` string
            - `postal_place` string, required
            - `country` string, iso-3166-1, required — ISO 3166-1 country code
          - `arrival_at` string, date-time
          - `operator` string
          - `class` string
          - `line` string
          - `seat` string
          - `zone` string
          - `expires_at` string, date-time
          - `activates_at` string, date-time
          - `passenger_id` string[]
        - `insurance` LineItemIsuranceAttachment[] — Insurance data
          - `insurance_company` string
          - `insurance_type` string
      - `train_reservation` LineItemReservationAttachment
        - `booking_id` string — Trip booking number
        - `line_ids` integer[] — related order items
        - `passengers` object[]
          - `id` string
          - `title` string
          - `first_name` string
          - `last_name` string
        - `itinerary` object[] — Itineray data, one item per segment
          - `departure_address` Address
            - `address_line` string, required
            - `address_line_2` string
            - `postal_code` string
            - `postal_place` string, required
            - `country` string, iso-3166-1, required — ISO 3166-1 country code
          - `departure_at` string, date-time
          - `arrival_address` Address
            - `address_line` string, required
            - `address_line_2` string
            - `postal_code` string
            - `postal_place` string, required
            - `country` string, iso-3166-1, required — ISO 3166-1 country code
          - `arrival_at` string, date-time
          - `operator` string
          - `class` string
          - `line` string
          - `seat` string
          - `zone` string
          - `expires_at` string, date-time
          - `activates_at` string, date-time
          - `passenger_id` string[]
        - `insurance` LineItemIsuranceAttachment[] — Insurance data
          - `insurance_company` string
          - `insurance_type` string
      - `tram_reservation` LineItemReservationAttachment
        - `booking_id` string — Trip booking number
        - `line_ids` integer[] — related order items
        - `passengers` object[]
          - `id` string
          - `title` string
          - `first_name` string
          - `last_name` string
        - `itinerary` object[] — Itineray data, one item per segment
          - `departure_address` Address
            - `address_line` string, required
            - `address_line_2` string
            - `postal_code` string
            - `postal_place` string, required
            - `country` string, iso-3166-1, required — ISO 3166-1 country code
          - `departure_at` string, date-time
          - `arrival_address` Address
            - `address_line` string, required
            - `address_line_2` string
            - `postal_code` string
            - `postal_place` string, required
            - `country` string, iso-3166-1, required — ISO 3166-1 country code
          - `arrival_at` string, date-time
          - `operator` string
          - `class` string
          - `line` string
          - `seat` string
          - `zone` string
          - `expires_at` string, date-time
          - `activates_at` string, date-time
          - `passenger_id` string[]
        - `insurance` LineItemIsuranceAttachment[] — Insurance data
          - `insurance_company` string
          - `insurance_type` string
    - `comments` OrderComment[]
      - `id` string — An id that uniquely identifies the resource
      - `created_at` string, date-time — The date-time when the resource was created
      - `created_by` string — The ID of the user/client created the resource
      - `deleted_by` string — The ID of the user/client created the resource
      - `deleted_at` string, date-time
      - `body` string, required
      - `visibility` 'private' | 'public' — The comment is private, hidden from the [customer](#tag/customer.order)
    - `delivery_id` string
    - `_links` Link[] — The links related to resource
      - `href` string, required — The link URL
      - `rel` 'draft' | 'events' | 'order' | 'receipt' | 'self' | 'session' | 'session-checkout' | 'transaction', required — The link type
    - `state` string — The combined state of all events - **failure** if any of the events reports as `error` or `failure` - **pending** if there is no events or if the latest status for any service is `pending` - **success** if the latest status for all services is `success`
    - `events` OrderEvent[], required
      - union
        - ApiEvent
          - `event_type` 'api-event', required — The type corresponding to this event
          - `id` string — The resource ID. Defaults to UUID v4
          - `created_at` string, date-time — Read-only timestamp, automatically assigned on back-end.
          - `created_by` string — The resource ID. Defaults to UUID v4
          - `version` number — The version of the resource when the request was done.
          - `request` object — Included in events that was created when the resource was updated.
            - `path` string
            - `method` string
            - `body` string
          - `draft_id` string — Included in audit events where the order was created or updated by a draft.
        - OrderStatusEvent
          - `event_type` 'service-event', required — The type corresponding to this event
          - `id` string — The resource ID. Defaults to UUID v4
          - `created_at` string, date-time — Read-only timestamp, automatically assigned on back-end.
          - `created_by` string — The resource ID. Defaults to UUID v4
          - `state` 'error' | 'failure' | 'success' | 'pending', required — The state of the event
          - `description` string — A short description of the reason for the status
          - `service` string, required — The type of service used, used to differentiate this status from other services
          - `service_status` string, required — The status reported by the service
          - `metadata` object — Additional service data related to the event
          - `_links` Link[] — The links related to resource
            - `href` string, required — The link URL
            - `rel` 'draft' | 'events' | 'order' | 'receipt' | 'self' | 'session' | 'session-checkout' | 'transaction', required — The link type

## Other responses

- `400` — Bad / Invalid request
- `401` — Access forbidden, invalid JWT token was used
- `403` — Forbidden
- `500` — Unexpected Error

---

[API](https://skmtc.net/dintero/apis/account-management-api.md) · [All operations](https://skmtc.net/dintero/apis/account-management-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/dintero/account-management-api/revisions/9b83a4199008/schema)