Skip to main content
The API sandbox lets you explore available JSON:API resources and perform API requests directly from your Oro application instance.

​
Sandbox URLs

ApplicationSandbox URL
OroCommerce storefronthttp://<hostname>/api/doc
OroCommerce back-officehttp://<hostname>/admin/api/doc
OroPlatformhttp://<hostname>/api/doc
The admin prefix is the default back-office prefix and can be changed by your administrator.
The sandbox page displays a list of all available JSON:API resources.
  • Click a resource row or the List Operations link to see the available HTTP methods grouped by resource URI.
  • Click a method row to expand the documentation and sandbox form for that method.
  • Click Expand Operations to see all methods for a resource at once.
  • Click Show/hide to toggle the collapsed/expanded state of a resource.
  • Use the type selector at the top to switch between different API types.

​
OroCommerce: JSON:API (SKU) type

On the OroCommerce storefront sandbox, you can select the JSON:API (SKU) type to use product SKUs instead of product IDs. To enable this in API requests, include the X-Product-ID: sku request header.

​
Retrieve a single record

1

Expand the resource

Click the API resource row on the sandbox page.
2

Find the GET method

Locate the /api/your_resource/{id} block and click the GET method row.
3

Open the Sandbox tab

Click the Sandbox tab to open the request form.
4

Enter the record ID

Specify the record ID in the id field of the Requirements section.
5

Send the request

Click Try! to send the request to the server.
The response includes:
  • Request URL — the full URL sent to the server.
  • Response Headers — status code and headers. Expand to see all headers.
  • Response Body — the entity data in JSON:API format.
  • Curl Command Line — an equivalent curl command to reproduce the request.

​
Edit a record

1

Expand the resource

Click the API resource row on the sandbox page.
2

Find the PATCH method

Locate the /api/your_resource/{id} block and click the PATCH method row.
3

Open the Sandbox tab

Click the Sandbox tab.
4

Enter the record ID

Specify the record ID in the id field of the Requirements section.
5

Provide the request body

In the Content section, provide the changes to apply. For example, to update the firstName field of a user:
{
  "data": {
    "type": "users",
    "id": "1",
    "attributes": {
      "firstName": "John"
    }
  }
}
6

Send the request

Click Try! to send the request. The updated data appears in the Response Body section if you have edit permission.

Build docs developers (and LLMs) love

Get started for freeTalk to us