--- title: "Retrieve order items" method: GET path: "/order/{order_slug}/items" tags: ["Order"] --- # Retrieve order items `GET /order/{order_slug}/items` Retrieves the line items belonging to the order identified by the specified slug. ## Query parameters - `page` string - `per_page` string ## Headers - `Accept` 'application/vnd.Creative Force.v2.3+json' | 'application/vnd.Creative Force.v2.3+xml', required - `x-api-language` string[] ## Response `200` Order items retrieved. - OrderItemList — Pagination envelope returned by every list endpoint. Wraps the result set with positional fields (`current_page`, `from`, `to`, `total`) and navigation URLs (`first_page_url`, `last_page_url`, `next_page_url`, `prev_page_url`) for traversing the full list. The records themselves are returned in a sibling `data` array supplied by the wrapping schema. - `current_page` integer — Number of the page returned by this response. The first page is `1`. - `first_page_url` string, uri — URL of the first page in the result set. - `from` integer — Position of the first record on this page within the full result set. The first record is at position `1`. - `last_page` integer — Number of the last page. Equals the total number of pages. - `last_page_url` string, uri — URL of the last page in the result set. - `next_page_url` string — URL of the next page in the result set. Empty string when the current page is the last page. - `path` string, uri — Canonical URL of the endpoint, without query parameters. - `per_page` integer — Maximum number of records returned per page. - `prev_page_url` string — URL of the previous page in the result set. Empty string when the current page is the first page. - `to` integer — Position of the last record on this page within the full result set. - `total` integer — Total number of records across all pages. - `data` OrderItem[] — Line items for the current page. - `address` string — Billing street address supplied for the order. - `category` object, nullable — Category the entry for the line item belongs to. `null` for line items that are not associated with an entry. - `slug` string — Short URL-safe identifier for the category. - `link` string, uri — Canonical URL for the category resource. - `name` object — Map keyed by locale code (for example, `en_GB` or `fr_FR`). Keys are drawn from the languages enabled on the account. Values are the translated string. - `chapter` object, nullable — Chapter the entry for the line item belongs to. `null` for line items that are not associated with an entry. - `slug` string — Short URL-safe identifier for the chapter. - `link` string, uri — Canonical URL for the chapter resource. - `name` object — Map keyed by locale code (for example, `en_GB` or `fr_FR`). Keys are drawn from the languages enabled on the account. Values are the translated string. - `city` string — Billing city supplied for the order. - `company` string — Billing company name supplied for the order. - `country` string — Billing country supplied for the order. - `created_at` string, date-time — Date and time the order was created, in ISO 8601 format. - `currency` string — Currency the order amounts are denominated in, as an ISO 4217 code. - `description` string — Human-readable description of the line item. - `discount` number — Discount applied to the line item, in the order currency. - `discount_code` string — Discount code applied to the order. Empty string when no code was applied. - `entry_name` string — Title of the entry the line item relates to. Empty string for line items that are not associated with an entry. - `entry_slug` string — Short URL-safe identifier for the entry the line item relates to. Empty string for line items that are not associated with an entry. - `invoice_number` string — Invoice number assigned to the order. - `ip_address` string, ip-address — IP address the order was placed from. - `member_number` string — Membership number recorded against the order. - `parent_category` object, nullable — Parent of the category for the line item. `null` when the category has no parent or the line item is not associated with an entry. - `slug` string — Short URL-safe identifier for the parent category. - `link` string, uri — Canonical URL for the parent category resource. - `name` object — Map keyed by locale code (for example, `en_GB` or `fr_FR`). Keys are drawn from the languages enabled on the account. Values are the translated string. - `payment_method` string — Method used to pay for the order. - `payment_status` string — Payment status of the order. - `postcode` string — Billing postcode supplied for the order. - `price` string — Name of the price the line item was charged at. - `region` string — Billing region supplied for the order. - `season` object, nullable — Season the entry for the line item belongs to. `null` for line items that are not associated with an entry. - `slug` string — Short URL-safe identifier for the season. - `link` string, uri — Canonical URL for the season resource. - `name` object — Map keyed by locale code (for example, `en_GB` or `fr_FR`). Keys are drawn from the languages enabled on the account. Values are the translated string. - `slug` string — Short URL-safe identifier for the order. - `state` string — Billing state supplied for the order. - `subtotal` number — Line item subtotal before tax and fees, in the order currency. - `tax_term` string — Display term used for tax on the order, such as `VAT` or `GST`. - `transaction_date` string, date-time, nullable — Date and time of the payment transaction, in ISO 8601 format. `null` when the order has no recorded payment transaction. - `transaction_provider` string — Payment provider that processed the transaction. - `transaction_reference` string — Reference assigned to the transaction by the payment provider. - `transaction_status` string — Status of the payment transaction. - `type` 'Entry' | 'Entrant' | 'Tag' | 'Ticket' — Type of the line item. - `user` object — User who placed the order. - `slug` string — Short URL-safe identifier for the user. - `link` string, uri — Canonical URL for the user resource. - `name` string — Display name of the user. - `first_name` string — First name of the user. - `last_name` string — Last name of the user. - `email` string, email — Email address of the user. - `vat_number` string — VAT number supplied for the order. ## Other responses - `400` — Request was rejected before the endpoint could process it. Common causes: invalid `Accept` header, unsupported `x-api-language` code, empty request body on `POST` / `PUT`, or invalid JSON in the request body. - `401` — Missing `x-api-key` header. - `403` — Authenticated request denied. Common causes: invalid or unknown API key, suspended account, or `api` feature not enabled for the account. - `404` — Resource identified by the path slug does not exist. Returned when the slug is well-formed but no record matches it. - `429` — Rate limit of 60 requests per minute exceeded. - `503` — Service is temporarily unavailable due to regional maintenance. --- [API](https://skmtc.dev/tectonic/apis/award-force-api.md) · [All operations](https://skmtc.dev/tectonic/apis/award-force-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/tectonic/award-force-api/revisions/21f74cd75a05/schema)