API export

Etals can set up an export that sends produced content directly to an API endpoint you control. This is handled through the Custom API integration and configured by Etals for you.

How exports are sent

When a task is exported through the Custom API integration, Etals sends a POST request to your configured endpoint. The request uses Content-Type: application/json.

Authorization

Etals can adapt the export request to match the authorization requirements of your endpoint. If your endpoint requires authentication, share the endpoint details, authentication method, required headers, and any other requirements with your Etals point of contact.

Etals will configure the export so requests can authenticate correctly when sending produced or enriched data to your system.

How you receive the data

Understanding the payload structure is important so your endpoint can process it correctly.

The payload is grouped by content type. Each content type group contains the items that were exported, and each item contains its identifier and the properties that were produced or enriched.

1
{
2
  "attributables": [
3
    {
4
      "attributable_type": {
5
        "id": 1,
6
        "system_code": "products"
7
      },
8
      "items": [
9
        {
10
          "id": 123,
11
          "identifiers": {
12
            "identifier": "SKU-1001"
13
          },
14
          "properties": [
15
            {
16
              "property_id": 45,
17
              "system_code": "product_description",
18
              "values": [
19
                {
20
                  "brand": "etals",
21
                  "market": "sweden",
22
                  "front": "storefront",
23
                  "language": "sv",
24
                  "value_id": 9876,
25
                  "value": "<p>En återfuktande ansiktskräm för daglig användning.</p>"
26
                }
27
              ]
28
            },
29
            {
30
              "property_id": 46,
31
              "system_code": "categories",
32
              "values": [
33
                {
34
                  "value": ["Skincare", "Face care"]
35
                }
36
              ]
37
            }
38
          ]
39
        }
40
      ]
41
    }
42
  ]
43
}

How your endpoint should respond

Etals reads the HTTP status code of your response to decide whether the export succeeded.

• A 2xx response marks the exported items as completed.
• A 422 response is treated as a payload format error.
• Any other non-2xx response marks the items as failed, and the error is stored on the export status so it can be reviewed.

Export behavior

Etals sends exports in batches. The default batch size is 1000 items, but this can be configured.

If multiple API URLs are configured, Etals sends the same payload to each URL. Only the response from the primary URL determines the export status; the additional URLs are treated as mirrors.

Feedback on exported values

Your system can send feedback about exported values back to Etals by using the value_id included in the export payload. Feedback can be stored for review, or used to automatically create a new task that regenerates the affected values.

See API Feedback for the endpoint, payload format, and automatic regeneration behavior.

Customizing your export

The structure above is the default. Etals can customize the export to match your needs, for example adjusting the batch size, including all property values rather than only the produced ones, or shaping the payload to fit your system.

To set up an export to your endpoint, or to customize an existing export, reach out to your Etals point of contact and they will configure it for you.