HTTP Headers

We look at several headers to change the response of the api. Here are some of the common ones you may use:

Header

Required

Description

Default Value

Content-Type

yes

Tells the server what kind of data you are sending it.

None, application/hal+json is the recommended value

Accept

yes

Tells the server what kind of data you will accept back.

None, application/hal+json is the recommended value here

Accept-Version

yes

The version of the API that you are requesting.

1.0 .
3.0 is recommended as it is the current version of the API.

Accept-Language

no

Locale value that tells the server which language you expect content to be returned in.

en

X-Display-Currency

no

The currency to show all price values.

USD.

Valid values can be found at /api/currencies/display

X-Shipping-Region

no

Show only listings that ship to this region

None, will show everything.

Valid valid values can be found at /api/shipping/regions .