LogoLogo
  • General
    • Overview
    • Mode of Operation
    • Key Services and Logistics Requirements
  • Know Your Customer (KYC) FAQs
  • User Guide
    • General Product Information
    • Create Products
    • Product Image Requirements
    • Manage and Publish Products
    • Manage Stock and Prices
    • Orders and Shipments
    • User Management
  • API
    • Getting Started
      • API Authentication
      • Sandbox Environment
      • Make your first API request
    • Products
      • Get Products
      • Create and Update Products
      • Get Product Batch Results
      • Update Product Status (and Publish)
      • Get Product Status Update Batch Results
      • List Product Categories
      • List Product Attribute Groups
    • Stock and Prices
      • Update Stock
      • Get Stock Batch Results
      • Update Price
      • Get Price Batch Results
    • Orders and Shipment
      • Get Orders
      • Ship Order Items
      • Get Shipped Order Batch Results
      • Cancel Order Items
      • Get Cancelled Order Item Batch Results
      • Return Order Items
      • Get Returned Order Batch Results
    • Webhooks
      • Order Delegation Webhook
  • Shopify Plugin
    • Getting Started
      • Intro
      • Add Custom App to your Store
      • Sync your Shop in the Sellers Center
      • Product Preparations
      • Sync Products
      • Connect Products to the Seller Center
    • Order Handling
    • Additional Information
      • Permissions
      • Stock Safety Margin
      • Price Markup
On this page

Was this helpful?

Export as PDF
  1. API

Webhooks

PreviousGet Returned Order Batch ResultsNextOrder Delegation Webhook

Last updated 4 days ago

Was this helpful?

This section of the API documentation provides details on the webhooks available in our system.

Subscription Management

This page lists helper endpoints that allow you to subscribe to and unsubscribe from webhooks.

Webhook Details

Each webhook is documented separately on individual subpages, providing specific information on their payload structure.

Endpoints for Subscription Management

Get Webhook Event Types

get
Authorizations
Responses
application/json
object[]Optional
application/json
application/json
get
GET /api/v1/webhooks/types HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

[
  {
    "description": "text",
    "event": "text"
  }
]

Get Webhook Subscriptions

get
Authorizations
Responses
application/json
object[]Optional
application/json
application/json
get
GET /api/v1/webhooks/ HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

[
  {
    "events": [
      "order.created"
    ],
    "url": "https://example.com",
    "id": 1,
    "description": "text",
    "enabled": true,
    "created_at": "2025-04-19T12:03:54.688Z"
  }
]

Get Webhook Subscription

get
Authorizations
Path parameters
subscription_idintegerRequired
Responses
application/json
objectOptional
application/json
application/json
application/json
get
GET /api/v1/webhooks/{subscription_id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "events": [
    "order.created"
  ],
  "url": "https://example.com",
  "id": 1,
  "description": "text",
  "enabled": true,
  "created_at": "2025-04-19T12:03:54.688Z"
}

Delete Webhook Subscription

delete
Authorizations
Path parameters
subscription_idintegerRequired
Responses
application/json
application/json
application/json
delete
DELETE /api/v1/webhooks/{subscription_id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

No content
  • Subscription Management
  • Webhook Details
  • Endpoints for Subscription Management
  • GETGet Webhook Event Types
  • GETGet Webhook Subscriptions
  • POSTPost Webhook Subscription
  • GETGet Webhook Subscription
  • DELETEDelete Webhook Subscription
  • PATCHUpdate Webhook Subscription Patch

Post Webhook Subscription

post
Authorizations
Body
eventsstring · enum[]Required
urlstring · uri · min: 1 · max: 2083RequiredExample: https://example.com
descriptionany ofOptional
Responses
application/json
objectOptional
application/json
application/json
post
POST /api/v1/webhooks/ HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "events": [
    "order.created"
  ],
  "url": "https://example.com",
  "description": "text"
}
{
  "events": [
    "order.created"
  ],
  "url": "https://example.com",
  "id": 1,
  "description": "text",
  "enabled": true,
  "created_at": "2025-04-19T12:03:54.688Z",
  "client_secret": "text"
}

Update Webhook Subscription Patch

patch
Authorizations
Path parameters
subscription_idintegerRequired
Body
eventsany ofOptional
urlany ofOptional
descriptionany ofOptional
enabledany ofOptional
Responses
application/json
objectOptional
application/json
application/json
application/json
patch
PATCH /api/v1/webhooks/{subscription_id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 92

{
  "events": [
    "order.created"
  ],
  "url": "https://example.com",
  "description": "text",
  "enabled": true
}
{
  "events": [
    "order.created"
  ],
  "url": "https://example.com",
  "id": 1,
  "description": "text",
  "enabled": true,
  "created_at": "2025-04-19T12:03:54.688Z"
}