The yayloh Open API lets your developers connect yayloh to your own systems, such as an ERP, BI tool or warehouse system. They can read orders and returns, track shipments, pull reports, and register webhooks.
Two versions, side by side
V2 (new): our expanded API. Read the V2 documentation.
V1: our original API. Existing integrations keep working as before. Read the V1 documentation.
What's new in V2
Returns: report warehouse inspection results, list the exchanges on an order, and read your return reasons.
Manage: read your return requests the same way they appear in Manage.
Shipments: track a returning parcel, and find which order a tracking number belongs to.
Finance: list the refunds and store credit on an order.
Reporting: refunds per brand or staff member, top return reasons per brand, category or product, and return volumes and staff processing per period.
Account and shipping: read your configuration and return policy, carriers, shipping routes and failed labels.
Webhooks: register endpoints that receive order events.
Get started
Create an API key under Settings > Api keys. See Create and manage yayloh API keys.
Share the key and the documentation link with your developer. Every request sends the key in an
x-api-keyheader.
Tip: create a separate key for each integration and give it a clear name. You can then delete one key without affecting your other integrations.