Create a company location catalog

Event Group	Event Identification
company	company/create

Message to create a company location catalog.

Request Headers

X-Shopline-Topic string required

The unique identifier for the event.

Example: orders/edited
X-Shopline-Hmac-Sha256 string required

The signature of the request. Upon receiving the request, you must verify the signature to confirm the authenticity and integrity of the data.

Example: XWmrwMey6OsLMeiZKwP4FppHH3cmAiiJJAweH5Jo4bM=
X-Shopline-Shop-Domain string required

The store domain.

Example: example.myshopline.com
X-Shopline-Shop-Id string required

The store ID.

Example: 1610418123456
X-Shopline-Merchant-Id string required

The merchant ID.

Example: 2000001234
X-Shopline-API-Version string required

The API version.

Example: v20250601
X-Shopline-Webhook-Id string required

The ID of this Webhook event.

Example: b54557e48a5fbf7d70bcd043

Request Body

company_location_catalogobject

Information of the company location catalog
adjustment_type integer

The type of percentage adjustment, with a value of 1 for decreasing the price and a value of 2 for increasing the price.
Example: 1
adjustment_value integer

The adjustment value based on adjustment_type, formatted as a percentage.

When decreasing the price, the value is limited to 0-100.

When increasing the price, the value is limited to 0-10,000.

Example: 10
auto_add_product boolean

Whether newly added products should automatically be included in the catalog.
Example: true
catalog_id string

The ID of company location catalog.
Example: 6505476185111667646
company_locations_count integer

Total number of company location in the catalog
Example: 10
created_at string

Create time of the catalog
Example: 2023-04-06T18:18:42.883+0800
currency_code string

Currency code
Example: USD
individual_price_products_count integer

Number of individually priced products
Example: 5
products_count integer

Total number of published products in the catalog
Example: 20
status string

The status of the specified catalog, with a value of 1 representing active status and a value of 2 representing draft status.
Example: 1
title string

The title of company location catalog.
Example: This is a catalog
updated_at string

Update time of the catalog
Example: 2023-04-06T18:18:42.883+0800

Status Codes

After receiving a webhook notification from SHOPLINE, you must respond with the following format:

HTTP/1.1 200 OK

For more information about how to subscribe to webhooks and webhook response rules, refer to Webhook overview.

Was this article helpful to you?

SHOPLINE

SHOPLINE

Legal

Privacy