Skip to main content

[Order Intake - GCW] How to Use the Customer-Agnostic Order API Endpoints

S
Written by Styrbjörn Holmberg
Updated over a week ago

You can fetch and search all customer orders using the API endpoints — not just orders for a specific customer. Here's how:

1. Create a Connector

  1. Go to Order Intake → Connectors.

  2. Create a New Connector.

  3. Choose API Connector.

  4. Select All Customers.

  5. Give it a name, e.g., Customer-Agnostic Connector.

  6. Copy your X-API-KEY.

  7. Click Create.

Now you have your endpoints ready.


2. Set Up Your API Requests

A. Get a Single Order

  • Method: GET

  • Endpoint: Use the Get Order endpoint from your connector.

  • Headers:

    • X-API-KEY: [your copied key]

  • Body: None required.

  • Steps:

    1. Replace the {orderId} in the URL with an actual order ID.

    2. Click Send.

    3. You’ll receive the order details.

B. Search for Multiple Orders

  • Method: POST

  • Endpoint: Use the Search Orders endpoint from your connector.

  • Headers:

    • X-API-Key: [your copied key]

  • Body: Include your search filters in JSON.

Steps:

  1. Paste the search endpoint.

  2. Set method to POST.

  3. Add the JSON body.

  4. Click Send.

  5. You’ll get a list of matching orders.


Common Mistakes to Avoid

  • Wrong method: GET for single order, POST for search.

  • No API Key: Always include your X-API-KEY in the header.

  • Missing Body for Search: Search needs a JSON body with your filters.


📝 Not what you needed?

Help us improve this article, send us an email to [email protected] — please include the article title.

Did this answer your question?