Skip to main content
GET
List Order Line Items

Authorizations

X-Authorization
string
header
required

Headers

X-Shop-Id
integer

The unique identifier of the shop associated with the draft return.

This header is not required, as the merchant's shop is identified by the API key present in the request.

Accept
enum<string>

Optional. Responses use Content-Type: application/prs.hal-forms+json.

Available options:
application/prs.hal-forms+json
X-Loop-Locale
string

The shopper's locale: a two-letter language code with an optional two-letter region, for example fr or fr-CA.

When the value is valid and product translations are enabled for the shop, the response includes translated product text in the operation's translated fields. Otherwise those fields are not populated.

Example:

"fr-CA"

Path Parameters

draft_return_id
integer
required

The unique identifier of the draft return.

Query Parameters

page
integer
default:1

The page number to return (default 1).

Required range: x >= 1
limit
integer
default:250

Number of order line items per page. Must be between 1 and 250 (inclusive). Defaults to 250, so leaving it out returns up to 250 line items in one page.

Required range: 1 <= x <= 250

Response

OK

HAL _links object. Always includes self. Other keys are relation names corresponding to available actions for the current draft return state.

_embedded
object