Skip to content

Commit 4bdfad4

Browse files
authored
BAP-20442: Create documentation for X-Localization-ID and X-Currency headers for Storefront API (#29433)
1 parent a591a0c commit 4bdfad4

File tree

2 files changed

+20
-3
lines changed

2 files changed

+20
-3
lines changed

api/http-header-specifics.rst

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ HTTP Header Specifics
55

66
As mentioned in the :ref:`Client Requirements <web-services-api--client-requirements>`
77
and :ref:`Authentication <web-services-api--authentication>` sections, to perform
8-
an JSON:API request successfully, it is important to provide the correct **Accept*, ***Content-Type**
8+
an JSON:API request successfully, it is important to provide the correct **Accept**, **Content-Type**
99
and **Authentication** parameters, e.g.,:
1010

1111
.. code-block:: http
@@ -21,7 +21,6 @@ for the DELETE method. The **X-Include** request header can be used for such pur
2121

2222
The following table describes all existing keys for the X-Include header.
2323

24-
2524
+-------------+-----------------+---------------------------+------------------------------------------------------+
2625
| HTTP Method | X-Include key | Response Header | Description |
2726
+=============+=================+===========================+======================================================+
@@ -99,3 +98,21 @@ Request query string contains a filter that specifies conditions for deletion op
9998
Keep-Alive: timeout=5, max=100
10099
Connection: Keep-Alive
101100
101+
102+
The following request headers are available for the storefront API.
103+
104+
+-------------+-------------------+---------------------------------------------------------------------------------+
105+
| HTTP Method | Request Header | Description |
106+
+=============+===================+=================================================================================+
107+
| any | X-Localization-ID | By default, all locale sensitive data are received and returned in the locale |
108+
| | | selected for the current website. This header can be used to specify another |
109+
| | | locale. The list of available localization IDs can be received via the |
110+
| | | ``/api/localizations`` resource. |
111+
+-------------+-------------------+---------------------------------------------------------------------------------+
112+
| any | X-Currency | By default, all currency-related data are received and returned in the currency |
113+
| | | selected for the current website. This header can be used to specify another |
114+
| | | currency. The list of available currency codes can be received via the |
115+
| | | ``/api/currencies`` resource. |
116+
| | | |
117+
| | | **Note:** This header is available for OroCommerce Enterprise Edition only. |
118+
+-------------+-------------------+---------------------------------------------------------------------------------+

api/resource-fields.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Common Resource Fields
2525
| | organization | |
2626
+--------------+---------------+-----------------------------------------------------------------------------------------------------+
2727
| organization | organization | An organization record represents a real enterprise, business, firm, company or another |
28-
| | | organization to which the users belong. Available only in Enterprise Edition instances. |
28+
| | | organization to which the users belong. It is available for Enterprise Edition only. |
2929
+--------------+---------------+-----------------------------------------------------------------------------------------------------+
3030

3131

0 commit comments

Comments
 (0)