Introduction
Welcome to HepsiGlobal API Documentation. HepsiGlobal is the crossborder arm of Hepsiburada - the leading ecommerce platform in Turkey. Our aim is to become the technology leader in the region extending from west of India to English channel by becoming a gateway to 1B+ customers within less than 4-hours flight distance from Istanbul.
This documentation explains how to use HepsiGlobal API endpoints and how to fill request parameters. HepsiGlobal API allows you to create and update your products in our systems, get orders and synchronize operations between your and HepsiGlobal systems.
Before starting to access services, please ensure you have received your Bearer Token from the Seller Portal
How To Use the API?
HepsiGlobal API is a multi channel sale system, where you can choose the sale channels for your products. We define a sale channel as a country and/or an affiliated platform. For example, you can sell your products on HepsiGlobal in Georgia or on Hepsiburada in Turkey via HepsiGlobal.
After uploading your products, you need to choose your preffered sale channels such as hepsiglobal.com, hepsiburada.com, Joom, Ozon, Wish, DHGate, etc.
Once you have your products synchronized with HepsiGlobal API, we take care of the rest.
Orders will be consolidated and shown in the orders panel of the Seller Portal. Also you can use order API endpoints to manage orders directly from your own systems.
Environments
There are two environments:
Sandbox:
https://api-qa.hepsiglobal.comwhere you may try your requests and see the results both in the API responses and in QA Seller PortalProduction:
https://api.hepsiglobal.comwhere your real data will be stored and published to marketplaces.
You may see the results both in the API responses and in Seller Portal
Sandbox
All your requests should use following domain;
https://api-qa.hepsiglobal.com
To use this environment, you still need to get your token; but this time from the QA Seller Portal
You can create/update/delete as many records as you like on the sandbox environment, until you feel ready to move on to production.
Entity IDs will vary from the ones in Production environment.
Production
All your requests should use following domain;
https://api.hepsiglobal.com
In this environment your records will be stored permanently. Before moving on to this environment, please make sure you are comfortable and successful with the Sandbox Environment.
Entity IDs will vary from the ones in Sandbox environment.
Authentication
HepsiGlobal API uses Bearer Token authorization. ALl your requests must include your token which can be taken from Seller Portal after registering your merchant.
Marketplaces
Marketplaces (Sale Channels) are the storefronts where your products will be shown. Based on your choices you may sell your products in selected channels.
You can choose which marketplaces you would like to use in the Seller Portal
List Marketplaces
curl --location
--request GET 'https://api.hepsiglobal.com/api/v1/marketplaces/list' \
--header 'Authorization: Bearer {token}' \
--data-raw ''
Response:
{
"data": [
{
"id": 1,
"name": "Hepsiburada",
"adapter": "hepsiburada",
"is_active": true,
"created_at": "2021-01-01T00:00:00Z",
"updated_at": "2021-01-01T00:00:00Z",
"deleted_at": null
},
{
"id": 2,
"name": "Hepsiglobal",
"adapter": "hepsiglobal",
"is_active": true,
"created_at": "2021-01-01T00:00:00Z",
"updated_at": "2021-01-01T00:00:00Z",
"deleted_at": null
},
],
"error_code": 0,
"message": ""
}
This endpoint lists all marketplaces where you can sell your products.
GET https://api.hepsiglobal.com/api/v1/marketplaces/list
Marketplace Categories
curl --location
--request POST 'https://api.hepsiglobal.com/api/v1/marketplace-categories/search' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"start":0,
"length":10,
"search":{
"marketplace_id": null,
"parent_id": null,
"name": null,
"is_active": true,
"id": null,
"is_leaf": null,
"attribute_list": true
}
}'
Response:
{
"data": {
"data": [
{
"id": 71486,
"marketplace_id": 2,
"name": "Çorap",
"name_en": "Sock",
"remote_id": "28274",
"remote_parent_id": "28270",
"is_active": true,
"is_leaf": true,
"path_ids": "70592,71070,71459,71460,71482,71486",
"path": "Ana Sayfa > Giyim / Ayakkabı > Çocuk > Kız Çocuk > İç Giyim > Çorap",
"path_en": "Main Page > Clothing / Shoes > Children > Girl > Underwear > Sock",
"created_at": "2021-08-16T07:43:12.647Z",
"updated_at": "2025-01-27T05:00:27.192Z",
"deleted_at": null,
"marketplace": {
"id": 2,
"name": "Hepsiglobal",
"adapter": "hepsiglobal",
"is_active": true,
"created_at": "2021-03-17T14:41:17Z",
"updated_at": "2021-03-17T14:41:18Z",
"deleted_at": null
},
"marketplace_attribute_configs": [
{
"id": 158422,
"marketplace_id": 2,
"marketplace_category_id": 71486,
"marketplace_attribute_id": 591994,
"is_required": false,
"is_custom": false,
"is_variant": false,
"created_at": "2022-01-31T00:31:31Z",
"updated_at": "2022-01-31T00:31:31Z",
"deleted_at": null,
"marketplace_attribute": {
"id": 591994,
"marketplace_id": 2,
"name": "Sezon",
"name_en": "Season",
"remote_id": "33",
"is_active": true,
"type": "enum",
"created_at": "2021-08-20T07:06:14Z",
"updated_at": "2021-08-20T07:06:14Z",
"deleted_at": null
}
},
{
"id": 158423,
"marketplace_id": 2,
"marketplace_category_id": 71486,
"marketplace_attribute_id": 591995,
"is_required": false,
"is_custom": false,
"is_variant": true,
"created_at": "2022-01-31T00:31:31Z",
"updated_at": "2022-01-31T00:31:31Z",
"deleted_at": null,
"marketplace_attribute": {
"id": 591995,
"marketplace_id": 2,
"name": "Beden",
"name_en": "Size",
"remote_id": "34",
"is_active": true,
"type": "enum",
"created_at": "2021-08-20T07:06:14Z",
"updated_at": "2024-04-22T05:07:29.174Z",
"deleted_at": null
}
},
{
"id": 158424,
"marketplace_id": 2,
"marketplace_category_id": 71486,
"marketplace_attribute_id": 591996,
"is_required": false,
"is_custom": false,
"is_variant": true,
"created_at": "2022-01-31T00:31:31Z",
"updated_at": "2022-01-31T00:31:31Z",
"deleted_at": null,
"marketplace_attribute": {
"id": 591996,
"marketplace_id": 2,
"name": "Renk",
"name_en": "Color",
"remote_id": "35",
"is_active": true,
"type": "enum",
"created_at": "2021-08-20T07:06:14Z",
"updated_at": "2021-08-20T07:06:14Z",
"deleted_at": null
}
},
{
"id": 158425,
"marketplace_id": 2,
"marketplace_category_id": 71486,
"marketplace_attribute_id": 592299,
"is_required": true,
"is_custom": false,
"is_variant": false,
"created_at": "2022-01-31T00:31:31Z",
"updated_at": "2022-01-31T00:31:31Z",
"deleted_at": null,
"marketplace_attribute": {
"id": 592299,
"marketplace_id": 2,
"name": "Cinsiyet",
"name_en": "Gender",
"remote_id": "338",
"is_active": true,
"type": "enum",
"created_at": "2021-08-20T07:06:14Z",
"updated_at": "2021-08-20T07:06:14Z",
"deleted_at": null
}
}
]
}
],
"count": 13,
"search": {
"marketplace_id": 2,
"parent_id": null,
"remote_parent_id": null,
"name": "çorap",
"is_active": true,
"remote_id": null,
"is_leaf": true,
"attribute_list": true,
"path": null,
"parent_ids": null
},
"start": 0,
"length": 1
},
"error_code": 0,
"message": ""
}
This endpoint lists all marketplace categories depending on the filters you apply. You must match your own categories with the sale channel's categories, using the IDs retrieved by this endpoint.
Note: Only leaf categories should be used when creating products. Products cannot be created for non-leaf/parent categories
POST https://api.hepsiglobal.com/api/v1/marketplace-categories/search
| Parameter | Type | Default | Description |
|---|---|---|---|
| start | int | 0 | Offset of the search results |
| length | int | 100 | Required result count in response. (Can be maximum 1000) |
| search. id |
int | null | Marketplace Category ID in HepsiGlobal system |
| search. marketplace_id |
int | null | Marketplace ID retrieved by marketplace list service |
| search. parent_id |
int | null | Category Parent ID |
| search. name |
string | null | Name you would like to search |
| search. is_active |
bool | null | true- only active, false- only passive, null- all |
| search. is_leaf |
bool | null | true- only active, false- only passive, null- all |
| search. attribute_list |
bool | null | true- only active |
Marketplace Attributes
curl --location
--request POST 'https://api.hepsiglobal.com/api/v1/marketplace-attributes/search' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"start":0,
"length":10,
"search":{
"marketplace_id": null,
"marketplace_category_id": null,
"name": null,
"is_active": null,
"remote_id": null,
"id": null
}
}'
Response:
{
"data": {
"data": [
{
"id": 591995,
"marketplace_id": 2,
"name": "Beden",
"name_en": "Size",
"remote_id": "34",
"is_active": true,
"type": "enum",
"created_at": "2021-08-20T07:06:14Z",
"updated_at": "2024-04-22T05:07:29.174Z",
"deleted_at": null,
"marketplace": null,
"marketplace_attribute_configs": [
{
"id": 158423,
"marketplace_id": 2,
"marketplace_category_id": 71486,
"marketplace_attribute_id": 591995,
"is_required": false,
"is_custom": false,
"is_variant": true,
"created_at": "2022-01-31T00:31:31Z",
"updated_at": "2022-01-31T00:31:31Z",
"deleted_at": null
}
]
},
{
"id": 591996,
"marketplace_id": 2,
"name": "Renk",
"name_en": "Color",
"remote_id": "35",
"is_active": true,
"type": "enum",
"created_at": "2021-08-20T07:06:14Z",
"updated_at": "2021-08-20T07:06:14Z",
"deleted_at": null,
"marketplace": null,
"marketplace_attribute_configs": [
{
"id": 158424,
"marketplace_id": 2,
"marketplace_category_id": 71486,
"marketplace_attribute_id": 591996,
"is_required": false,
"is_custom": false,
"is_variant": true,
"created_at": "2022-01-31T00:31:31Z",
"updated_at": "2022-01-31T00:31:31Z",
"deleted_at": null
}
]
}
],
"count": 2,
"search": {
"marketplace_id": 2,
"marketplace_category_id": 71486,
"name": null,
"is_active": null,
"remote_id": null,
"id": null
},
"start": 0,
"length": 2
},
"error_code": 0,
"message": ""
}
This endpoint lists all marketplace attributes depending on the filters you apply. You must match your own attributes with the sale channel's attributes, using the IDs retrieved by this endpoint.
POST https://api.hepsiglobal.com/api/v1/marketplace-attributes/search
| Parameter | Type | Description |
|---|---|---|
| start | int | Offset of the search results |
| length | int | Requested result count in response. Default 100, maximum 1000 |
| search. id |
int | Attribute ID in Hespiglobal system |
| search. marketplace_id |
int | Marketplace ID in Hespiglobal system |
| search. marketplace_category_id |
int | Marketplace Category ID in Hespiglobal system |
| search. name |
string | Name you would like to search |
| search. remote_id |
string | Attribute Code of the relevant marketplace |
| search. is_active |
bool | true- only active, false- only passive, null- all |
*None of the fields are required.
Marketplace Attribute Values
curl --location
--request POST 'https://api.hepsiglobal.com/api/v1/marketplace-attribute-values/search' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"start":0,
"length":10,
"search":{
"marketplace_id": null,
"marketplace_attribute_id": null,
"marketplace_category_id": null,
"value": null,
"is_active": null,
"remote_id": null,
"id": null
}
}'
Response:
{
"data": {
"data": [
{
"id": 1478058,
"marketplace_id": 2,
"value": "Kız Çocuk",
"value_en": "Girl",
"marketplace_attribute_id": 592299,
"remote_id": "485409",
"is_active": true,
"created_at": "2021-08-20T07:23:34Z",
"updated_at": "2024-04-22T05:25:17.864Z",
"deleted_at": null
},
{
"id": 1478059,
"marketplace_id": 2,
"value": "Kadın",
"value_en": "Female",
"marketplace_attribute_id": 592299,
"remote_id": "485410",
"is_active": true,
"created_at": "2021-08-20T07:23:34Z",
"updated_at": "2024-04-22T05:25:17.889Z",
"deleted_at": null
},
{
"id": 1478060,
"marketplace_id": 2,
"value": "Çocuk",
"value_en": "Child",
"marketplace_attribute_id": 592299,
"remote_id": "485411",
"is_active": true,
"created_at": "2021-08-20T07:23:34Z",
"updated_at": "2024-04-22T05:25:17.915Z",
"deleted_at": null
},
{
"id": 1478061,
"marketplace_id": 2,
"value": "Erkek",
"value_en": "Male",
"marketplace_attribute_id": 592299,
"remote_id": "485412",
"is_active": true,
"created_at": "2021-08-20T07:23:34Z",
"updated_at": "2024-04-22T05:25:17.947Z",
"deleted_at": null
},
{
"id": 1478062,
"marketplace_id": 2,
"value": "Unisex",
"value_en": "Unisex",
"marketplace_attribute_id": 592299,
"remote_id": "485413",
"is_active": true,
"created_at": "2021-08-20T07:23:34Z",
"updated_at": "2021-08-20T07:23:34Z",
"deleted_at": null,
"marketplace_attribute": null,
"marketplace": null
},
{
"id": 1478063,
"marketplace_id": 2,
"value": "Erkek Çocuk",
"value_en": "Boy",
"marketplace_attribute_id": 592299,
"remote_id": "485414",
"is_active": true,
"created_at": "2021-08-20T07:23:34Z",
"updated_at": "2024-04-22T05:25:17.991Z",
"deleted_at": null
}
],
"count": 6,
"search": {
"marketplace_id": 2,
"marketplace_attribute_id": 592299
},
"start": 0,
"length": 6
},
"error_code": 0,
"message": ""
}
This endpoint retrieves all marketplace attribute values depending on the filters you apply.
POST https://api.hepsiglobal.com/api/v1/marketplace-attribute-values/search
| Parameter | Type | Description |
|---|---|---|
| start | int | Offset of the search results. |
| length | int | Requested result count in response. Default 100, maximum 1000 |
| search. id |
int | Attribute Value ID in HepsiGlobal system |
| search. marketplace_id |
int | Marketplace ID retrieved by marketplace list service |
| search. marketplace_attribute_id |
int | Marketplace Attribute ID in HepsiGlobal system |
| search. marketplace_category_id |
int | Marketplace Category ID in HepsiGlobal system |
| search. value |
string | If there is a specific value you would like to search. |
| search. remote_id |
string | Attribute Value Code of the relevant marketplace |
| search. is_active |
bool | true- only active, false- only passive, null- all |
*None of the fields are required.
Marketplace Brands
curl --location
--request POST 'https://api.hepsiglobal.com/api/v1/marketplace-brands/search' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"start":0,
"length":10,
"search":{
"marketplace_id": null,
"name": null,
"is_active": null,
"id": null
}
}'
Response:
{
"data": {
"data": [
{
"id": 121009,
"marketplace_id": 2,
"name": "Brand123",
"is_active": true,
"created_at": "2025-01-28T09:20:12.839Z",
"updated_at": "2025-01-28T09:20:12.839Z",
"deleted_at": null
},
{
"id": 121008,
"marketplace_id": 2,
"name": "Brand321",
"is_active": true,
"created_at": "2025-01-28T09:17:11.02Z",
"updated_at": "2025-01-28T09:17:11.02Z",
"deleted_at": null
}
],
"count": 2,
"search": {
"marketplace_id": null,
"name": null,
"is_active": null,
"remote_id": null,
"id": null
},
"start": 0,
"length": 2
},
"error_code": 0,
"message": ""
}
This endpoint retrieves all marketplace brands depending on the filters you apply.
POST https://api.hepsiglobal.com/api/v1/marketplace-brands/search
| Parameter | Type | Description |
|---|---|---|
| start | int | Offset of the search results. |
| length | int | Required result count in response. (Can be maximum 1000) |
| search. id |
int | Brand ID in HepsiGlobal system |
| search. name |
string | Brand name |
| search. marketplace_id |
int | Marketplace ID retrieved by marketplace list service |
| search. is_active |
bool | true- only active, false- only passive, null- all |
*None of the fields are required.
Category, Attribute, Brands
In this section, endpoints are used to create your own Category, Attribute, Attribute Value and Brands data. You can optionally match your data directly with sale channel IDs in the API requests, or you may match them in Seller Portal manually afterwards.
Categories
Your categories with your own category tree structure. Later on you'll be matching saved categories with sale channel's category values.
Create / Update Category
curl --location
--request POST 'https://api.hepsiglobal.com/api/v1/categories/upsert' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"parent_id":null,
"name":"Bags",
"remote_id":"bags_1234",
"remote_parent_id":null,
"is_active":true,
"cross": [
{
"hepsiburada": "testmp1"
}
]
}'
Response:
{
"data":{
"id":"31c1eba2-1054-4595-ad0b-873fe268a6d5",
"company_id":2,
"file_name":"requests/2/20210208/category_create/ee1e799c-db26-4e25-a849-87558f86850e.json",
"method":"category_create",
"status":"open",
"error_code":null,
"error_msg":null,
"created_at":"2021-02-08T17:13:05.954955097+03:00",
"updated_at":"2021-02-08T17:13:05.954955236+03:00"
},
"error_code":0,
"message":""
}
Endpoint to create your categories.
POST https://api.hepsiglobal.com/api/v1/categories/upsert
| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | Your category name |
| remote_id | string | Yes | Unique category ID in your system |
| is_active | bool | Yes | active/passive |
| remote_parent_id | string | - | Category parent id |
| cross | array | - | Marketplaces' key and value. Key should be marketplace short code, value should be the corresponding value on marketplace's system. |
Search Category
curl --location
--request POST 'https://api.hepsiglobal.com/api/v1/categories/search' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"start":0,
"length":10,
"search":{
"id": null,
"company_id": null,
"parent_id": null,
"name": null,
"remote_id": null,
"is_active": null,
"remote_parent_id": null
}
}'
Response:
{
"data": {
"data": [
{
"id": 69724,
"company_id": 2,
"parent_id": null,
"name": "Ear Headphones",
"remote_id": "3a6070029da90a941b8288118d01f692",
"remote_parent_id": null,
"remote_image_url": null,
"is_active": true,
"hg_forever_sync": false,
"created_at": "2021-05-21T07:06:21.899Z",
"updated_at": "2021-05-21T07:06:21.912Z",
"deleted_at": null,
"marketplace_categories": [
{
"id": 14205,
"marketplace_id": 1,
"name": "Bluetooth Kulaklıklar",
"name_en": "Bluetooth Headsets",
"remote_id": "16218",
"remote_parent_id": "371967",
"is_active": true,
"is_leaf": true,
"path_ids": "19245,13830,13801,14205",
"path": "Telefon > Cep Telefonu Aksesuarları > Bluetooth Kulaklıklar",
"path_en": "Phone> Cell Phone Accessories> Bluetooth Headsets",
"created_at": "2021-03-11T17:52:01.146Z",
"updated_at": "2021-05-20T13:27:38.926Z",
"deleted_at": null,
},
{
"id": 128185,
"marketplace_id": 2,
"name": "Bluetooth Kulaklıklar",
"name_en": "Bluetooth Headsets",
"remote_id": "46131",
"remote_parent_id": "213",
"is_active": true,
"is_leaf": true,
"path_ids": "86151,86151,100662,103703,128185",
"path": "Telefon > Cep Telefonu Aksesuarları > Bluetooth Kulaklıklar",
"path_en": "Phone> Cell Phone Accessories> Bluetooth Headsets",
"created_at": "2021-04-07T18:29:48.679Z",
"updated_at": "2021-04-26T05:11:57.156Z",
"deleted_at": null,
}
],
"hepsiglobal_category_cross": null,
"attribute_values": null
}
],
"count": 1,
"search": {
"id": null,
"company_id": null,
"parent_id": null,
"name": null,
"remote_id": null,
"is_active": null,
"remote_parent_id": null
},
"start": 0,
"length": 10
},
"error_code": 0,
"message": ""
}
This endpoint retrieves all your categories depending on the filters you apply.
POST https://api.hepsiglobal.com/api/v1/categories/search
| Parameter | Type | Required | Description |
|---|---|---|---|
| start | int | - | Offset of the search results. |
| length | int | - | Requested result count in response. Default 100, maximum 1000 |
| search. id |
int | - | HepsiGlobal ID |
| search. parent_id |
int | - | HepsiGlobal Parent ID |
| search. name |
string | - | Category name |
| search. remote_id |
string | - | Your own category ID |
| search. remote_parent_id |
string | - | Your own parent category ID |
| search. is_active |
bool | - | true- only active, false- only passive, null- all |
Category Info
curl --location
--request GET 'https://api.hepsiglobal.com/api/v1/categories/get/shoe_123' \
--header 'Authorization: Bearer {token}' \
--data-raw ''
Response:
{
"data": {
"id": 69724,
"company_id": 2,
"parent_id": null,
"name": "Ear Headphones",
"remote_id": "3a6070029da90a941b8288118d01f692",
"remote_parent_id": null,
"remote_image_url": null,
"is_active": true,
"hg_forever_sync": false,
"created_at": "2021-05-21T07:06:21.899Z",
"updated_at": "2021-05-21T07:06:21.912Z",
"deleted_at": null,
"marketplace_categories": [
{
"id": 14205,
"marketplace_id": 1,
"name": "Bluetooth Kulaklıklar",
"name_en": "Bluetooth Headsets",
"remote_id": "16218",
"remote_parent_id": "371967",
"is_active": true,
"is_leaf": true,
"path_ids": "19245,13830,13801,14205",
"path": "Telefon > Cep Telefonu Aksesuarları > Bluetooth Kulaklıklar",
"path_en": "Phone> Cell Phone Accessories> Bluetooth Headsets",
"created_at": "2021-03-11T17:52:01.146Z",
"updated_at": "2021-05-20T13:27:38.926Z",
"deleted_at": null,
"marketplace": {
"id": 1,
"name": "hepsiburada",
"adapter": "hepsiburada",
"is_active": true,
"created_at": "0001-01-01T00:00:00Z",
"updated_at": "0001-01-01T00:00:00Z",
"deleted_at": null
}
},
{
"id": 128185,
"marketplace_id": 2,
"name": "Bluetooth Kulaklıklar",
"name_en": "Bluetooth Headsets",
"remote_id": "46131",
"remote_parent_id": "213",
"is_active": true,
"is_leaf": true,
"path_ids": "86151,86151,100662,103703,128185",
"path": "Telefon > Cep Telefonu Aksesuarları > Bluetooth Kulaklıklar",
"path_en": "Phone> Cell Phone Accessories> Bluetooth Headsets",
"created_at": "2021-04-07T18:29:48.679Z",
"updated_at": "2021-04-26T05:11:57.156Z",
"deleted_at": null,
"marketplace": {
"id": 2,
"name": "hepsiglobal",
"adapter": "hepsiglobal",
"is_active": true,
"created_at": "0001-01-01T00:00:00Z",
"updated_at": "0001-01-01T00:00:00Z",
"deleted_at": null
}
}
],
"hepsiglobal_category_cross": [
{
"id": 128185,
"marketplace_id": 2,
"name": "Bluetooth Kulaklıklar",
"name_en": "Bluetooth Headsets",
"remote_id": "46131",
"remote_parent_id": "213",
"is_active": true,
"is_leaf": true,
"path_ids": "86151,86151,100662,103703,128185",
"path": "Telefon > Cep Telefonu Aksesuarları > Bluetooth Kulaklıklar",
"path_en": "Phone> Cell Phone Accessories> Bluetooth Headsets",
"created_at": "2021-04-07T18:29:48.679Z",
"updated_at": "2021-04-26T05:11:57.156Z",
"deleted_at": null,
"hg_category_match": {
"hg_marketplace_category_id": 128185,
"marketplace_id": 1,
"marketplace_category_id": 14205,
"marketplace_category": {
"id": 14205,
"marketplace_id": 1,
"name": "Bluetooth Kulaklıklar",
"name_en": "Bluetooth Headsets",
"remote_id": "16218",
"remote_parent_id": "371967",
"is_active": true,
"is_leaf": true,
"path_ids": "19245,13830,13801,14205",
"path": "Telefon > Cep Telefonu Aksesuarları > Bluetooth Kulaklıklar",
"path_en": "Phone> Cell Phone Accessories> Bluetooth Headsets",
"created_at": "2021-03-11T17:52:01.146Z",
"updated_at": "2021-05-20T13:27:38.926Z",
"deleted_at": null,
"marketplace": {
"id": 1,
"name": "hepsiburada",
"adapter": "hepsiburada",
"is_active": true,
"created_at": "0001-01-01T00:00:00Z",
"updated_at": "0001-01-01T00:00:00Z",
"deleted_at": null
}
}
}
}
]
},
"error_code": 0,
"message": ""
}
This endpoint gives your own category info, saved on the HepsiGlobal system.
GET https://api.hepsiglobal.com/api/v1/categories/get/shoe_123
Attributes
Search Attribute
curl --location
--request POST 'https://api.hepsiglobal.com/api/v1/attributes/search' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"start":0,
"length":10,
"search":{
"name":null,
"is_active":null,
"id":null,
"remote_id":null
}
}'
Response:
{
"data":{
"data":[
{
"id":1,
"name":"Size",
"company_id":2,
"is_active":true,
"remote_id":"size_123",
"created_at":"2021-02-05T15:43:01.57+03:00",
"updated_at":"2021-02-05T15:47:27.042+03:00",
"company":null,
"attribute_values":null,
"marketplace_attributes":null
},
{
"id":2,
"name":"Color",
"company_id":2,
"is_active":true,
"remote_id":"10494",
"created_at":"2021-01-21T07:00:01.405+03:00",
"updated_at":"2021-01-21T07:00:01.405+03:00",
"company":null,
"attribute_values":null,
"marketplace_attributes":null
}
],
"count":2,
"search":{
"company_id":null,
"name":null,
"is_active":null,
"id":null,
"remote_id":null
},
"start":0,
"length":10
},
"error_code":0,
"message":""
}
This endpoint retrieves all your attributes depending on the filters you apply.
POST https://api.hepsiglobal.com/api/v1/attributes/search
| Parameter | Type | Required | Description |
|---|---|---|---|
| start | int | - | Offset of the search results. |
| length | int | - | Required result count in response. Default 100, maximum 1000 |
| search. id |
int | - | If there is a specific id you would like to search. |
| search. name |
string | - | If there is a specific name you would like to search. |
| search. remote_id |
string | - | If there is a specific your unique id you would like to search. |
| search. is_active |
bool | - | If there is a specific active/passive you would like to search. |
Create / Update Attribute
curl --location
--request POST 'https://api.hepsiglobal.com/api/v1/attributes/upsert' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"name":"Size",
"remote_id":"size_1234",
"is_active":true,
"cross": [
{
"hepsiburada": "size"
}
]
}'
Response:
{
"data":{
"id":"30a6766a-e890-4347-8ec8-0a6421a86d20",
"company_id":2,
"file_name":"requests/2/20210208/attribute_create/0d6183fb-4a9a-4bb0-9ce9-f78866b426d0.json",
"method":"attribute_create",
"status":"open",
"error_code":null,
"error_msg":null,
"created_at":"2021-02-08T17:13:58.753142669+03:00",
"updated_at":"2021-02-08T17:13:58.75314293+03:00"
},
"error_code":0,
"message":""
}
This endpoint creates your company attributes.
POST https://api.hepsiglobal.com/api/v1/attributes/upsert
| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | Your attribute name |
| remote_id | string | Yes | Unique attribute id on your own system |
| is_active | bool | Yes | active/passive |
| remote_parent_id | string | - | Your attribute unique parent id. |
| cross | array | - | Marketplaces' key and value. Key should be marketplace short code, value should be the corresponding value on marketplace's system. |
Attribute Info
curl --location
--request GET 'https://api.hepsiglobal.com/api/v1/attributes/get/size_1234' \
--header 'Authorization: Bearer {token}' \
--data-raw ''
Response:
{
"data":{
"id":4,
"name":"Size",
"company_id":2,
"is_active":true,
"remote_id":"size_1234",
"created_at":"2021-02-07T18:11:21.34+03:00",
"updated_at":"2021-02-07T18:11:21.624+03:00",
"company":null,
"attribute_values":null,
"marketplace_attributes":null
},
"error_code":0,
"message":""
}
This endpoint gets your attribute's detailed info.
GET https://api.hepsiglobal.com/api/v1/attributes/get/size_1234
Attributes Values
Search Attribute Values
curl --location
--request POST 'https://api.hepsiglobal.com/api/v1/attribute-values/search' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"start":0,
"length":10,
"search":{
"value":null,
"is_active":null,
"id":null,
"remote_id":null,
"attribute_id":null,
"remote_attribute_id":null
}
}'
Response:
{
"data":{
"data":[
{
"id":4,
"value":"43",
"company_id":2,
"attribute_id":3,
"is_active":true,
"remote_id":"remote_43",
"remote_attribute_id":"size_123",
"created_at":"2021-02-05T15:53:58.799+03:00",
"updated_at":"2021-02-05T16:05:07.504+03:00",
"company":null,
"attribute":null,
"marketplace_attribute_values":null
}
],
"count":1,
"search":{
"company_id":null,
"value":null,
"is_active":null,
"id":null,
"remote_id":null,
"remote_attribute_id":null,
"attribute_id":null
},
"start":0,
"length":10
},
"error_code":0,
"message":""
}
This endpoint retrieves all your attribute values depending on the filters you apply.
POST https://api.hepsiglobal.com/api/v1/attribute-values/search
| Parameter | Type | Required | Description |
|---|---|---|---|
| start | int | - | Offset of the search results. |
| length | int | - | Required result count in response. Default 100, maximum 1000 |
| search. id |
int | - | If there is a specific id you would like to search. |
| search. value |
string | - | If there is a specific value you would like to search. |
| search. remote_id |
string | - | If there is a specific your unique id you would like to search. |
| search. is_active |
bool | - | If there is a specific active/passive you would like to search. |
Create / Update Attribute Value
curl --location
--request POST 'https://api.hepsiglobal.com/api/v1/attribute-values/upsert' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"value":"44",
"is_active":true,
"remote_id":"remote_44",
"attribute": {
"name": "Size",
"remote_id": "size_123",
"is_active": true,
"cross": [
{
"hepsiburada": "size"
}
]
},
"cross": [
{
"hepsiburada": "43"
}
]
}'
Response:
{
"data":{
"id":"df2793b7-f36e-457b-a978-fa89b4d09568",
"company_id":2,
"file_name":"requests/2/20210208/attribute_value_create/8f68ba07-083f-4bc7-ac7c-66dcd0d75045.json",
"method":"attribute_value_create",
"status":"open",
"error_code":null,
"error_msg":null,
"created_at":"2021-02-08T17:14:28.052866268+03:00",
"updated_at":"2021-02-08T17:14:28.052866441+03:00"
},
"error_code":0,
"message":""
}
This endpoint creates your company attribute values.
POST https://api.hepsiglobal.com/api/v1/attribute-values/upsert
| Parameter | Type | Required | Description |
|---|---|---|---|
| value | string | Yes | Your attribute value |
| remote_id | string | Yes | Your attribute value unique id |
| remote_attribute_id | string | Yes | Your attribute unique id. |
| is_active | bool | Yes | active/passive |
| cross | array | - | Marketplaces' key and value. Key should be marketplace short code, value should be the corresponding value on marketplace's system. |
| attribute | object | - | Your attribute parameters |
| attribute.name | string | Yes | Your attribute name |
| attribute.remote_id | string | Yes | Your unique attribute id |
| attribute.is_active | bool | Yes | active/passive |
| attribute.cross | array | - | Marketplaces' key and value. Key should be marketplace short code, value should be the corresponding value on marketplace's |
Attribute Value Info
curl --location
--request GET 'https://api.hepsiglobal.com/api/v1/attribute-values/get/remote_44' \
--header 'Authorization: Bearer {token}' \
--data-raw ''
Response:
{
"data":{
"id":5,
"value":"44",
"company_id":2,
"attribute_id":3,
"is_active":true,
"remote_id":"remote_44",
"remote_attribute_id":"size_123",
"created_at":"2021-02-07T18:26:42.658+03:00",
"updated_at":"2021-02-07T18:26:42.959+03:00",
"company":null,
"attribute":{
"id":3,
"name":"Size Update",
"company_id":2,
"is_active":true,
"remote_id":"size_123",
"created_at":"2021-02-05T15:43:01.57+03:00",
"updated_at":"2021-02-05T15:47:27.042+03:00",
"company":null,
"attribute_values":null,
"marketplace_attributes":null
},
"marketplace_attribute_values":[
{
"id":1,
"marketplace_id":1,
"value":"44",
"marketplace_attribute_id":1,
"remote_id":"",
"is_active":true,
"created_at":"0001-01-01T00:00:00Z",
"updated_at":"0001-01-01T00:00:00Z",
"marketplace_attribute":null
}
]
},
"error_code":0,
"message":""
}
This endpoint gets your attribute value details.
GET https://api.hepsiglobal.com/api/v1/attribute-values/get/remote_44
Brands
Brands of the products you are selling.
Search Brand
curl --location
--request POST 'https://api.hepsiglobal.com/api/v1/brands/search' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"start":0,
"length":10,
"search":{
"company_id":null,
"remote_id":null,
"name":null,
"is_active":null,
"id":null
}
}'
Response:
{
"data":{
"data":[
{
"id":11,
"company_id":2,
"name":"Xiaomi",
"remote_id":"1122",
"remote_image_url":"test",
"tax_class_id":null,
"is_active":true,
"created_at":"2021-02-04T09:19:03.98+03:00",
"updated_at":"2021-02-04T09:19:03.98+03:00",
"marketplace_brands":null,
"tax_class":null
},
{
"id":3,
"company_id":2,
"name":"Apple",
"remote_id":"",
"remote_image_url":null,
"tax_class_id":null,
"is_active":false,
"created_at":"2021-02-03T19:27:34.175+03:00",
"updated_at":"2021-02-03T19:27:34.175+03:00",
"marketplace_brands":null,
"tax_class":null
}
],
"count":2,
"search":{
"company_id":null,
"remote_id":null,
"name":null,
"is_active":null,
"id":null
},
"start":0,
"length":10
},
"error_code":0,
"message":""
}
This endpoint retrieves all your brands depending on the filters you apply.
POST https://api.hepsiglobal.com/api/v1/brands/search
| Parameter | Type | Required | Description |
|---|---|---|---|
| start | int | - | Offset of the search results. |
| length | int | - | Required result count in response. Default 100, maximum 1000 |
| search. id |
int | - | If there is a specific id you would like to search. |
| search. name |
string | - | If there is a specific name you would like to search. |
| search. remote_id |
string | - | If there is a specific your unique id you would like to search. |
| search. is_active |
bool | - | If there is a specific active/passive you would like to search. |
Create / Update Brand
curl --location
--request POST 'https://api.hepsiglobal.com/api/v1/brands/upsert' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"name":"Apple",
"remote_id":"apple_123",
"remote_image_url":"https://productimages.hepsiburada.net/s/33/277-478/10410313056306.jpg",
"is_active":true,
"cross": [
{
"hepsiburada": "pg1"
}
]
}'
Response:
{
"data":{
"id":"759bddce-c8a9-440c-aaaa-79b96326279b",
"company_id":2,
"file_name":"requests/2/20210208/brand_create/9f4ac725-627f-4195-b5a1-602ccc73b971.json",
"method":"brand_create",
"status":"open",
"error_code":null,
"error_msg":null,
"created_at":"2021-02-08T17:15:04.434832169+03:00",
"updated_at":"2021-02-08T17:15:04.434832318+03:00"
},
"error_code":0,
"message":""
}
This endpoint lets you to create your own brands in the HepsiGlobal system.
POST https://api.hepsiglobal.com/api/v1/brands/upsert
| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | Your brand |
| remote_id | string | Yes | Your brand unique id |
| is_active | bool | Yes | active/passive |
| cross | array | - | Marketplaces' key and value. Key should be marketplace short code, value should be the corresponding value on marketplace's |
Brand Info
curl --location
--request GET 'https://api.hepsiglobal.com/api/v1/brands/get/apple_123' \
--header 'Authorization: Bearer {token}' \
--data-raw ''
Response:
{
"data":{
"id":18,
"company_id":2,
"name":"Apple Update",
"remote_id":"apple_123",
"remote_image_url":"https://productimages.hepsiburada.net/s/33/277-478/10410313056306.jpg",
"tax_class_id":null,
"is_active":true,
"created_at":"2021-02-05T15:40:21.529+03:00",
"updated_at":"2021-02-05T15:41:17.219+03:00",
"marketplace_brands":null,
"tax_class":null
},
"error_code":0,
"message":""
}
Retrieve details of the brand.
GET https://api.hepsiglobal.com/api/v1/brands/get/apple_123
Products
Create / Update Product
curl --location
--request POST 'https://api.hepsiglobal.com/api/v1/products/upsert' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"tax": 0,
"spu": "spu123",
"brand": {
"remote_id": "brand123",
"name": "brandABC",
"cross": [
{
"hepsiburada": "marketplaceBrand"
}
]
},
"category": {
"name": "Soket Çorap",
"remote_id": "123456",
"remote_parent_id": null,
"cross": [
{
"hepsiglobal": "27915"
}
]
},
"default_image_url": "https://*.jpg",
"name": "Kadın Dikişsiz Çorap",
"fulfillment_day": 2,
"guarantee": 0,
"is_active": true,
"translations": [
{
"language": "TR",
"name": "TR Product Name Translation"
},
{
"language": "EN",
"name": "EN Product Name Translation"
}
],
"variants": [
{
"price": 5.6,
"retail_price": 5.6,
"currency": "USD",
"stock": 0,
"sku": "sku1234",
"extra_sku": "",
"barcode": "barcode1234",
"hs_code": "123456789123",
"gtin": "",
"default_image_url": "https://*.jpg",
"extra_images": [
"https://*_01.jpg",
"https://*_02.jpg"
],
"name": "Kadın Dikişsiz Çorap",
"description": "<ul><li>Yetişkin kadınlar için özel olarak tasarlanmış patik çoraplar. </li></ul>",
"is_active": true,
"freight": 1,
"weight": 0,
"height": 0,
"width": 0,
"length": 0,
"translations": [
{
"language": "TR",
"name": "TR Variant Name Translation",
"description": "TR Variant Desc Translation"
},
{
"language": "EN",
"name": "EN Variant Name Translation",
"description": "EN Variant Desc Translation"
}
],
"attributes": [
{
"name": "Renk",
"value": "Çok Renkli",
"remote_attribute_id": "attribute123",
"remote_attribute_value_id": "atrValue123",
"cross": [
{
"hepsiglobal": "141334"
}
],
"cross_attr": [
{
"hepsiglobal": "35"
}
]
},
{
"name": "Beden",
"value": "STD",
"remote_attribute_id": "attribute1234",
"remote_attribute_value_id": "atrValue1234",
"cross": [
{
"hepsiglobal": "134309"
}
],
"cross_attr": [
{
"hepsiglobal": "34"
}
]
},
{
"name": "Cinsiyet",
"value": "Kadın",
"remote_attribute_id": "attribute12345",
"remote_attribute_value_id": "atrValue12345",
"cross": [
{
"hepsiglobal": "485410"
}
],
"cross_attr": [
{
"hepsiglobal": "338"
}
]
}
]
}
]
}'
Response:
{
"data":{
"id":"5e346c39-364d-4390-8268-1f53d9f14e02",
"company_id":2,
"file_name":"requests/2/20210208/products_create/4117b148-c615-411a-bf42-ffd396342912.json",
"method":"product_create",
"status":"open",
"error_code":null,
"error_msg":null,
"created_at":"2021-02-08T17:04:55.994105343+03:00",
"updated_at":"2021-02-08T17:04:55.994105702+03:00"
},
"error_code":0,
"message":""
}
When creating a new product:
POST https://api.hepsiglobal.com/api/v1/products/create
When updating an existing product:
PUT https://api.hepsiglobal.com/api/v1/products/update
If you want to use a single service for product/variant creation and updating, you can use the upsert endpoint:
POST https://api.hepsiglobal.com/api/v1/products/upsert
The same request can be used for all three endpoints.
Note: To protect the system, there is a daily limit of 25,000 requests for product creation and update services. To avoid exceeding this limit or reduce the risk of reaching it, it is recommended to separate and use the appropriate endpoints based on their specific functions instead of using the "Upsert" endpoint.
Required: (*) means the field is not mandatory during the product creation process, but it is required for the product to be listed for sale on the marketplace. Therefore, this information must be completed in a step before the product is listed on the marketplace.
| Parameter | Type | Required | Description |
|---|---|---|---|
tax |
int | Yes | Tax percent that you would like to use |
spu |
string | Yes | Product's unique code in your system |
brand.remote_id |
string | Yes | Unique brand ID in your system |
brand.name |
string | Yes | Brand name in your system |
brand.cross |
array | No (*) | Marketplace mappings Key: Specifies which marketplace the brand cross will be made for. It corresponds to the name field returned by the https://developers.hepsiglobal.com/#list-marketplaces service. Value: For the marketplace specified in the key field, it corresponds to the remote_id field returned by the https://developers.hepsiglobal.com/#marketplace-brands service for the relevant brand. |
category.name |
string | Yes | Category name in your system |
category.remote_id |
string | Yes | Unique category ID in your system |
category.remote_parent_id |
string | No | Unique parent category ID in your system (if applicable) |
category.cross |
array | No (*) | Marketplace mappings Key: Specifies which marketplace the category cross will be made for. It corresponds to the name field returned by the https://developers.hepsiglobal.com/#list-marketplaces service. Value: For the marketplace specified in the key field, it corresponds to the remote_id field returned by the https://developers.hepsiglobal.com/#marketplace-categories service for the relevant category. |
default_image_url |
string | Yes | Product's default image URL |
name |
string | Yes | Product name |
fulfillment_day |
int | No | Maximum dispatch day to the shipping branch |
guarantee |
int | No | Guarantee duration in months |
is_active |
bool | Yes | Whether the product is active or not |
translations |
array | Dep. | Product name translations |
translations.language |
string | Dep. | (Required, if parent array is provided) TR, EN, etc. |
translations.name |
string | Dep. | (Required, if parent array is provided) Product name translation |
variants.price |
float | Yes | Selling price |
variants.retail_price |
float | Yes | Retail price (crossed price) |
variants.currency |
string | Yes | Currency of the price (currently only USD is supported) |
variants.stock |
int | Yes | Stock count |
variants.sku |
string | Yes | Variant's unique code in your system |
variants.extra_sku |
string | No | Extra SKU for internal reference |
variants.barcode |
string | Yes | Variant barcode |
variants.hs_code |
string | No | Harmonized System Code for customs (GTIP) |
variants.gtin |
string | No | Global Trade Item Number |
variants.default_image_url |
string | Yes | Variant's default image URL |
variants.extra_images |
array | No | Additional image URLs for the variant |
variants.name |
string | Yes | Variant name |
variants.description |
string | Yes | Variant description |
variants.is_active |
bool | Yes | Whether the variant is active or not |
variants.freight |
int | Dep. | Deci. Required, If the length, width, and height values are empty |
variants.weight |
int | Yes | Weight in grams (gr). Required for shipping calculations |
variants.height |
int | Dep. | Height in millimeters (mm). Required, If the freight value is empty |
variants.width |
int | Dep. | Width in millimeters (mm). Required, If the freight value is empty |
variants.length |
int | Dep. | Length in millimeters (mm). Required, If the freight value is empty |
variants.translations |
array | Dep. | Variant name and description translations |
variants.translations.language |
string | Dep. | (Required, if parent array is provided) TR, EN, etc. |
variants.translations.name |
string | Dep. | (Required, if parent array is provided) Variant name translation |
variants.translations.description |
string | Dep. | Variant description translation |
variants.attributes |
array | Dep. | Variant attributes |
variants.attributes.name |
string | Dep. | Attribute name in your system |
variants.attributes.value |
string | Dep. | Attribute value in your system |
variants.attributes.remote_attribute_id |
string | Dep. | Unique attribute code in your system |
variants.attributes.remote_attribute_value_id |
string | Dep. | Unique attribute value code in your system |
variants.attributes.cross |
array | Dep. | Marketplace mappings key: Specifies which marketplace the attribute value cross will be made for. It corresponds to the name field returned by the https://developers.hepsiglobal.com/#list-marketplaces service. value: For the marketplace specified in the key field, it corresponds to the remote_id field returned by the https://developers.hepsiglobal.com/#marketplace-attribute-values service for the relevant attribute value. |
variants.attributes.cross_attr |
array | Dep. | Marketplace mappings key: Specifies which marketplace the attribute cross will be made for. It corresponds to the name field returned by the https://developers.hepsiglobal.com/#list-marketplaces service. value: For the marketplace specified in the key field, it corresponds to the remote_id field returned by the https://developers.hepsiglobal.com/#marketplace-attributes service for the relevant attribute. |
Search Products
curl --location
--request POST 'https://api.hepsiglobal.com/api/v1/products/search' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"start":0,
"length":10,
"search":{
"category_id":null,
"brand_id":null,
"spu":null,
"name":null,
"is_active":null,
"id":null,
"remote_brand_id":null,
"remote_category_id":null
}
}'
Response:
{
"data": {
"data": [
{
"id": 106454,
"company_id": 3235,
"category_id": 133403,
"brand_id": 40398,
"name": "Kadın Dikişsiz Çorap",
"remote_category_id": "123456",
"remote_brand_id": "brand123",
"spu": "spu1234",
"default_image_url": "https://*.jpg",
"tax_class_id": 5,
"is_active": true,
"fulfillment_day": 2,
"guarantee": 0,
"created_at": "2025-01-27T08:32:56.553Z",
"updated_at": "2025-01-27T12:41:05.303Z",
"deleted_at": null,
"variants": [
{
"id": 1279815,
"company_id": 3235,
"product_id": 106454,
"name": "Kadın Dikişsiz Çorap",
"description": "<ul><li>Yetişkin kadınlar için özel olarak tasarlanmış patik çoraplar. </li></ul>",
"sku": "sku1234",
"extra_sku": "",
"barcode": "barcode1234",
"hs_code": "123456789123",
"gtin": "",
"default_image_url": "https://*.jpg",
"extra_images": "https://*_1.jpg,https://*_2.jpg,https://*_3.jpg,https://*.jpg",
"price": "99.99",
"retail_price": "129.99",
"currency": "USD",
"stock": 20,
"is_active": true,
"freight": 5.5,
"weight": 1.2,
"height": 10,
"width": 15,
"length": 20,
"created_at": "2025-01-27T08:32:56.779Z",
"updated_at": "2025-01-27T12:41:05.312Z",
"deleted_at": null,
"activation_date": "2025-01-27T12:41:05.312Z"
}
],
"marketplace_products": [
{
"id": 19054,
"company_id": 3235,
"marketplace_id": 2,
"product_id": 106454,
"external_code": "107839",
"marketplace_state": null,
"lock_state": false,
"lock_reason": "",
"locked_by": null,
"lock_expiration_time": null,
"locked_by_user": null,
"seller_state": true,
"audit_state": true,
"created_at": "2025-01-27T08:32:59.266Z",
"updated_at": "2025-01-27T12:50:04.077Z",
"locked_at": null,
"deleted_at": null,
"marketplace": {
"id": 2,
"name": "hepsiglobal",
"adapter": "hepsiglobal",
"is_active": true,
"created_at": "2022-12-20T13:49:27.683Z",
"updated_at": "2023-10-12T11:48:34.758Z",
"deleted_at": null
},
"marketplace_variants": [
{
"id": 45907,
"company_id": 3235,
"marketplace_id": 2,
"marketplace_product_id": 19054,
"marketplace_channel_id": null,
"variant_id": 1279815,
"base_currency": "USD",
"base_price": "99.99",
"base_retail_price": "129.99",
"last_price": "112.29",
"last_retail_price": "145.89",
"last_stock": 20,
"currency": "USD",
"last_rate": "1",
"last_weight": 50,
"last_deci": 5.5,
"customer_review_score": null,
"marketplace_rate": 100,
"marketplace_fee": "0",
"customs_currency": "USD",
"customs_fee": "0",
"otv_fee": "0",
"tax_label_fee": "0",
"tax_label_rate": "1",
"original_tax_label_fee": "0",
"original_tax_label_fee_currency": "USD",
"shipping_currency": "USD",
"shipping_rate": "1",
"logistic_fee": "0",
"service_fee": "0",
"buffer_fee": "0",
"commission_fee": "10",
"commission_vat_fee": "2",
"marketplace_service_fee": "0.25",
"marketplace_service_vat_fee": "0.05",
"external_code": "250841",
"marketplace_state": null,
"seller_state": true,
"audit_state": true,
"lock_state": false,
"lock_expiration_time": null,
"lock_reason": "",
"locked_by": null,
"created_at": "2025-01-27T08:32:59.276Z",
"updated_at": "2025-01-27T12:50:04.124Z",
"locked_at": null,
"deleted_at": null,
"marketplace": {
"id": 2,
"name": "hepsiglobal",
"adapter": "hepsiglobal",
"image": null,
"is_active": true,
"created_at": "2022-12-20T13:49:27.683Z",
"updated_at": "2023-10-12T11:48:34.758Z",
"deleted_at": null
}
}
]
}
]
}
],
"count": 1,
"search": {
"category_id": null,
"integration_category_id": null,
"brand_id": null,
"company_id": null,
"spu": "spu1234",
"sku": null,
"extra_sku": null,
"name": null,
"barcode": null,
"is_active": null,
"id": null,
"supplier_id": null,
"remote_supplier_id": null,
"remote_brand_id": null,
"remote_category_id": null,
"marketplaces": null,
"marketplace_spu": null,
"marketplace_sku": null,
"lock_reason": null,
"lock_state": null,
"sort_by": null,
"order_by": null
},
"start": 0,
"length": 10
},
"error_code": 0,
"message": ""
}
This endpoint retrieves all your products depending on the filters you apply.
POST https://api.hepsiglobal.com/api/v1/products/search
| Parameter | Type | Required | Description |
|---|---|---|---|
| start | int | - | Offset of the search results |
| length | int | - | Required result count in response. Default 100, maximum 1000 |
| search.id | int | null | Product ID in HepsiGlobal system. |
| search.category_id | int | - | Category ID in HepsiGlobal system |
| search.brand_id | int | - | Brand ID in HepsiGlobal system |
| search.spu | string | - | Product's SPU in your system |
| search.name | string | - | Product name you would like to search |
| search.is_active | bool | - | true- only active, false- only passive, null- all |
| search.remote_brand_id | string | - | Brand ID in your system |
| search.remote_category_id | string | - | Category ID in your system |
Product Info
curl --location
--request GET 'https://api.hepsiglobal.com/api/v1/products/get/spu1234' \
--header 'Authorization: Bearer {token}' \
--data-raw ''
Response:
{
"data": {
"id": 106454,
"company_id": 3235,
"category_id": 133403,
"brand_id": 40398,
"name": "Kadın Dikişsiz Çorap",
"remote_category_id": "123456",
"remote_brand_id": "brand123",
"spu": "spu1234",
"default_image_url": "https://*.jpg",
"tax_class_id": 5,
"is_active": true,
"fulfillment_day": 2,
"guarantee": 0,
"created_at": "2025-01-27T08:32:56.553Z",
"updated_at": "2025-01-27T10:48:47.585Z",
"deleted_at": null,
"tax_class": {
"id": 5,
"name": "Tax 0",
"created_at": "2022-12-20T13:49:39.087Z",
"updated_at": "2022-12-20T13:49:39.087Z",
"deleted_at": null,
"taxes": null
},
"products_media": [
{
"id": 152874,
"product_id": 106454,
"media_id": 832210,
"product": null,
"is_active": true,
"is_default": true,
"created_at": "2025-01-27T08:32:56.564Z",
"updated_at": "2025-01-27T08:32:56.564Z",
"remote_link": "https://*.jpg",
"link": "prod/media/3235/20250127/bf45d547-696d-494c-b7b2-c692d643b566.jpg",
"width": null,
"height": null
}
],
"product_translations": [
{
"id": 252298,
"company_id": 3235,
"product_id": 106454,
"language": "TR",
"name": "TR Product Name Translation",
"created_at": "2025-01-27T08:32:56.574Z",
"updated_at": "2025-01-27T08:32:56.574Z",
"deleted_at": null
},
{
"id": 252299,
"company_id": 3235,
"product_id": 106454,
"language": "EN",
"name": "Kadın Dikişsiz Çorap",
"created_at": "2025-01-27T08:32:56.581Z",
"updated_at": "2025-01-27T10:48:47.61Z",
"deleted_at": null
},
{
"id": 252300,
"company_id": 3235,
"product_id": 106454,
"language": "AZ",
"name": "Kadın Dikişsiz Çorap",
"created_at": "2025-01-27T08:32:56.587Z",
"updated_at": "2025-01-27T08:32:56.587Z",
"deleted_at": null
}
],
"variants": [
{
"id": 1279815,
"company_id": 3235,
"product_id": 106454,
"supplier_id": null,
"remote_supplier_id": "Sup1",
"name": "Kadın Dikişsiz Çorap",
"description": "<ul><li>Yetişkin kadınlar için özel olarak tasarlanmış patik çoraplar. </li></ul>",
"sku": "sku1234",
"extra_sku": "",
"barcode": "barcode1234",
"hs_code": "123456789123",
"gtin": "",
"default_image_url": "https://*.jpg",
"extra_images": "https://*_1.jpg,https://*_2.jpg",
"price": "5.6",
"retail_price": "5.6",
"currency": "USD",
"stock": 0,
"is_active": false,
"freight": 1,
"weight": 0,
"height": 0,
"width": 0,
"length": 0,
"created_at": "2025-01-27T08:32:56.779Z",
"updated_at": "2025-01-27T10:48:48.674Z",
"deleted_at": null,
"supplier": null,
"variants_media": [
{
"id": 3517255,
"variant_id": 1279815,
"media_id": 832210,
"variant": null,
"is_active": true,
"is_default": true,
"created_at": "2025-01-27T08:32:57.062Z",
"updated_at": "2025-01-27T08:32:57.062Z",
"remote_link": "https://*.jpg",
"link": "prod/media/3235/20250127/bf45d547-696d-494c-b7b2-c692d643b566.jpg",
"width": null,
"height": null
},
{
"id": 3517251,
"variant_id": 1279815,
"media_id": 832211,
"variant": null,
"is_active": true,
"is_default": false,
"created_at": "2025-01-27T08:32:57.062Z",
"updated_at": "2025-01-27T08:32:57.062Z",
"remote_link": "https://*.jpg",
"link": "prod/media/3235/20250127/5676c260-e5c2-4cb2-97f7-6ac9b9f03751.jpg",
"width": null,
"height": null
},
{
"id": 3517252,
"variant_id": 1279815,
"media_id": 832212,
"variant": null,
"is_active": true,
"is_default": false,
"created_at": "2025-01-27T08:32:57.062Z",
"updated_at": "2025-01-27T08:32:57.062Z",
"remote_link": "https://*.jpg",
"link": "prod/media/3235/20250127/78a6d002-3a8a-4c74-9621-69135ee0cf32.jpg",
"width": null,
"height": null
},
{
"id": 3517253,
"variant_id": 1279815,
"media_id": 832213,
"variant": null,
"is_active": true,
"is_default": false,
"created_at": "2025-01-27T08:32:57.062Z",
"updated_at": "2025-01-27T08:32:57.062Z",
"remote_link": "https://*.jpg",
"link": "prod/media/3235/20250127/08b48c48-a6b2-4635-9516-13f34fe516e5.jpg",
"width": null,
"height": null
},
{
"id": 3517254,
"variant_id": 1279815,
"media_id": 832214,
"variant": null,
"is_active": true,
"is_default": false,
"created_at": "2025-01-27T08:32:57.062Z",
"updated_at": "2025-01-27T08:32:57.062Z",
"remote_link": "https://*.jpg",
"link": "prod/media/3235/20250127/b41fa7cf-4238-473f-800c-3940d6170aae.jpg",
"width": null,
"height": null
}
],
"variant_translations": [
{
"id": 653337,
"company_id": 3235,
"variant_id": 1279815,
"language": "TR",
"name": "TR Variant Name Translation",
"description": "TR Variant Desc Translation",
"created_at": "2025-01-27T08:32:57.074Z",
"updated_at": "2025-01-27T08:32:57.074Z",
"deleted_at": null
},
{
"id": 653338,
"company_id": 3235,
"variant_id": 1279815,
"language": "EN",
"name": "Kadın Dikişsiz Çorap",
"description": "<ul><li>Yetişkin kadınlar için özel olarak tasarlanmış patik çoraplar. </li></ul>",
"created_at": "2025-01-27T08:32:57.082Z",
"updated_at": "2025-01-27T10:48:47.901Z",
"deleted_at": null
},
{
"id": 653339,
"company_id": 3235,
"variant_id": 1279815,
"language": "AZ",
"name": "Kadın Dikişsiz Çorap",
"description": "<ul><li>Yetişkin kadınlar için özel olarak tasarlanmış patik çoraplar. </li></ul>",
"created_at": "2025-01-27T08:32:57.088Z",
"updated_at": "2025-01-27T08:32:57.088Z",
"deleted_at": null
}
],
"activation_date": null,
"deactivation_date": "2025-01-27T09:06:03.739Z"
}
],
"category": {
"id": 133403,
"company_id": 3235,
"parent_id": null,
"name": "Soket Çorap",
"remote_id": "123456",
"is_active": true,
"created_at": "2025-01-27T08:31:40.909Z",
"updated_at": "2025-01-27T10:48:47.406Z",
"deleted_at": null
},
"brand": {
"id": 40398,
"company_id": 3235,
"name": "brandABC",
"remote_id": "brand123",
"is_active": true,
"created_at": "2025-01-27T08:32:56.225Z",
"updated_at": "2025-01-27T10:48:47.424Z",
"deleted_at": null
}
},
"error_code": 0,
"message": ""
}
This endpoint gets your product information with spu.
GET https://api.hepsiglobal.com/api/v1/products/get/spu1234
Product Enabled
curl --location
--request GET 'https://api.hepsiglobal.com/api/v1/products/enabled/spu1234' \
--header 'Authorization: Bearer {token}' \
--data-raw ''
Response:
{
"data": {
"id": "f52374a2-d3c6-420e-bec1-3b732fe232b0",
"company_id": 3235,
"file_name": "prod/requests/3235/20250127/products_enable/9ddaa3ca-3801-496d-974a-6055980dfe92",
"method": "product_enable",
"status": "open",
"error_code": null,
"error_msg": null,
"created_at": "2025-01-27T11:48:53.52222733Z",
"updated_at": "2025-01-27T11:48:53.522227455Z"
},
"error_code": 0,
"message": ""
}
This endpoint enable product with spu.
GET https://api.hepsiglobal.com/api/v1/products/enabled/spu1234
Product Disabled
curl --location
--request GET 'https://api.hepsiglobal.com/api/v1/products/disabled/spu1234' \
--header 'Authorization: Bearer {token}' \
--data-raw ''
Response:
{
"data": {
"id": "33ab8db8-231b-4e45-8f54-7d1f38bb89e9",
"company_id": 3235,
"file_name": "prod/requests/3235/20250127/products_disable/d40cf705-c6fe-4aad-81b4-d45a3a44d358",
"method": "product_disable",
"status": "open",
"error_code": null,
"error_msg": null,
"created_at": "2025-01-27T11:50:20.48383974Z",
"updated_at": "2025-01-27T11:50:20.483839962Z",
},
"error_code": 0,
"message": ""
}
This endpoint disable product with spu.
GET https://api.hepsiglobal.com/api/v1/products/disabled/spu1234
Variants
Create / Update Variant
curl --location
--request POST 'https://api.hepsiglobal.com/api/v1/variants/upsert' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '
{
"spu": "spu1234",
"retail_price": 5.6,
"price": 5.6,
"currency": "USD",
"stock": 0,
"name": "Kadın Dikişsiz Çorap",
"sku": "sku1234",
"barcode": "barcode1234",
"hs_code": "123456789123",
"gtin": "",
"default_image_url": "https://*.jpg",
"extra_images": [
"https://*_1.jpg",
"https://*_2.jpg"
],
"description": "<ul><li>Yetişkin kadınlar için özel olarak tasarlanmış patik çoraplar. </li></ul>",
"weight": 0,
"height": 0,
"width": 0,
"length": 0,
"freight": 1,
"is_active": true,
"translations": [
{
"language": "TR",
"name": "TR Variant Name Translation",
"description": "TR Variant Desc Translation"
},
{
"language": "EN",
"name": "EN Variant Name Translation",
"description": "EN Variant Desc Translation"
}
],
"attributes": [
{
"name": "Renk",
"value": "Çok Renkli",
"remote_attribute_id": "attribute123",
"remote_attribute_value_id": "atrValue123",
"cross": [
{
"hepsiglobal": "141334"
}
],
"cross_attr": [
{
"hepsiglobal": "35"
}
]
},
{
"name": "Beden",
"value": "STD",
"remote_attribute_id": "attribute1234",
"remote_attribute_value_id": "atrValue1234",
"cross": [
{
"hepsiglobal": "134309"
}
],
"cross_attr": [
{
"hepsiglobal": "34"
}
]
},
{
"name": "Cinsiyet",
"value": "Kadın",
"remote_attribute_id": "attribute12345",
"remote_attribute_value_id": "atrValue12345",
"cross": [
{
"hepsiglobal": "485410"
}
],
"cross_attr": [
{
"hepsiglobal": "338"
}
]
}
]
}'
Response:
{
"data":{
"id":"fdff8286-224b-4713-9888-e8c84307c0e3",
"company_id":2,
"file_name":"requests/2/20210208/variants_create/21cc5496-ded5-42a9-a2fb-6b4fb551702c.json",
"method":"variant_create",
"status":"open",
"error_code":null,
"error_msg":null,
"created_at":"2021-02-08T17:04:25.989653947+03:00",
"updated_at":"2021-02-08T17:04:25.989654193+03:00"
},
"error_code":0,
"message":""
}
This endpoint creates your variants connected to your product.
When creating a new variant:
POST https://api.hepsiglobal.com/api/v1/variants/create
When updating an existing variant:
PUT https://api.hepsiglobal.com/api/v1/variants/update
If you want to use a single service for product/variant creation and updating, you can use the POST upsert endpoint:
POST https://api.hepsiglobal.com/api/v1/variants/upsert
The same request can be used for all three endpoints.
Note: To protect the system, there is a daily limit of 25,000 requests for variant creation and update services.
To avoid exceeding this limit or reduce the risk of reaching it, it is recommended to separate and use the appropriate endpoints based on their specific functions instead of using the "Upsert" endpoint.
Required: (*) means the field is not mandatory during the variant creation process, but it is required for the variant to be listed for sale on the marketplace. Therefore, this information must be completed in a step before the variant is listed on the marketplace.
| Parameter | Type | Required | Description |
|---|---|---|---|
| spu | string | Yes | Product's unique code in your system |
| sku | string | Yes | Variant's unique code in your system |
| retail_price | float | Yes | Retail price (crossed price) |
| price | float | Yes | Selling price |
| currency | string | Yes | Currency of the price (currently only USD is supported) |
| stock | int | Yes | Stock count |
| name | string | Yes | Variant name |
| default_image_url | string | Yes | Variant default image URL |
| extra_images | array | No | Additional image URLs for the |
| barcode | string | Yes | Variant barcode |
| hs_code | string | Yes | Harmonized System Code for customs (GTIP) |
| gtin | string | No | Global Trade Item Number |
| description | string | Yes | Variant description |
| weight | int | Yes | Weight in grams (gr). Required for shipping calculations |
| width | int | Dep. | Width in millimeters (mm). Required, If the freight value is empty |
| height | int | Dep. | Height in millimeters (mm). Required, If the freight value is empty |
| length | int | Dep. | Length in millimeters (mm). Required, If the freight value is empty |
| freight | int | Dep. | Deci. Required, If the length, width, and height values are empty |
| is_active | bool | Yes | Active/passive |
| translations.language | string | Dep. | TR, EN |
| translations.name | string | Dep. | Variant name |
| translations.description | string | Dep. | Variant description |
| attributes.name | string | Dep. | Attribute name in your system |
| attributes.value | string | Dep. | Attribute value in your system |
| attributes.remote_attribute_id | string | Dep. | Unique attribute code in your system |
| attributes.remote_attribute_value_id | string | Dep. | Unique attribute value code in your system |
| attributes.cross | array | Dep. | Marketplace mappings key: Specifies which marketplace the attribute value cross will be made for. It corresponds to the name field returned by the https://developers.hepsiglobal.com/#list-marketplaces service. value: For the marketplace specified in the key field, it corresponds to the remote_id field returned by the https://developers.hepsiglobal.com/#marketplace-attribute-values service for the relevant attribute value. |
| attributes.cross_att` | array | Dep. | Marketplace mappings key: Specifies which marketplace the attribute cross will be made for. It corresponds to the name field returned by the https://developers.hepsiglobal.com/#list-marketplaces service. value: For the marketplace specified in the key field, it corresponds to the remote_id field returned by the https://developers.hepsiglobal.com/#marketplace-attributes service for the relevant attribute. |
Search Variants
curl --location
--request POST 'https://api.hepsiglobal.com/api/v1/variants/search' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"start":0,
"length":10,
"search":{
"product_id":null,
"sku":null,
"name":null,
"is_active":null,
"id":null,
}
}'
Response:
{
"data": {
"data": [
{
"id": 1279815,
"company_id": 3235,
"product_id": 106454,
"name": "Kadın Dikişsiz Çorap",
"description": "<ul><li>Yetişkin kadınlar için özel olarak tasarlanmış patik çoraplar. </li></ul>",
"sku": "sku1234",
"extra_sku": "",
"barcode": "barcode1234",
"hs_code": "123456789123",
"gtin": "",
"default_image_url": "https://*.jpg",
"extra_images": "https://*_01.jpg,https://*_02.jpg",
"price": "5.6",
"retail_price": "5.6",
"currency": "USD",
"stock": 0,
"is_active": false,
"freight": 1,
"weight": 0,
"height": 0,
"width": 0,
"length": 0,
"created_at": "2025-01-27T08:32:56.779Z",
"updated_at": "2025-01-27T11:45:29.74Z",
"deleted_at": null,
"product": {
"id": 106454,
"company_id": 3235,
"category_id": 133403,
"brand_id": 40398,
"name": "Kadın Dikişsiz Çorap",
"remote_category_id": "123456",
"remote_brand_id": "brand123",
"spu": "spu1234",
"default_image_url": "https://*.jpg",
"tax_class_id": 5,
"is_active": false,
"fulfillment_day": 2,
"guarantee": 0,
"created_at": "2025-01-27T08:32:56.553Z",
"updated_at": "2025-01-27T11:50:20.688Z",
"deleted_at": null,
"tax_class": null,
"category": {
"id": 133403,
"company_id": 3235,
"parent_id": null,
"name": "Soket Çorap",
"remote_id": "123456",
"remote_parent_id": null,
"is_active": true,
"created_at": "2025-01-27T08:31:40.909Z",
"updated_at": "2025-01-27T11:45:28.516Z",
"deleted_at": null
},
"brand": {
"id": 40398,
"company_id": 3235,
"name": "brandABC",
"remote_id": "brand123",
"tax_class_id": null,
"is_active": true,
"created_at": "2025-01-27T08:32:56.225Z",
"updated_at": "2025-01-27T11:45:28.538Z",
"deleted_at": null
}
},
"attribute_values": [
{
"id": 4100635,
"value": "Çok Renkli",
"company_id": 3235,
"attribute_id": 92423,
"is_active": true,
"remote_id": "atrValue123",
"remote_attribute_id": "attribute123",
"created_at": "2025-01-27T08:32:58.096Z",
"updated_at": "2025-01-27T11:45:29.331Z",
"deleted_at": null,
"attribute": {
"id": 92423,
"name": "Renk",
"company_id": 3235,
"is_active": true,
"remote_id": "attribute123",
"created_at": "2025-01-27T08:32:58.001Z",
"updated_at": "2025-01-27T11:45:29.197Z",
"deleted_at": null
}
},
{
"id": 4100636,
"value": "STD",
"company_id": 3235,
"attribute_id": 92424,
"is_active": true,
"remote_id": "atrValue1234",
"remote_attribute_id": "attribute1234",
"created_at": "2025-01-27T08:32:58.47Z",
"updated_at": "2025-01-27T11:45:29.564Z",
"deleted_at": null,
"attribute": {
"id": 92424,
"name": "Beden",
"company_id": 3235,
"is_active": true,
"remote_id": "attribute1234",
"created_at": "2025-01-27T08:32:58.351Z",
"updated_at": "2025-01-27T11:45:29.455Z",
"deleted_at": null
}
},
{
"id": 4100637,
"value": "Kadın",
"company_id": 3235,
"attribute_id": 92425,
"is_active": true,
"remote_id": "atrValue12345",
"remote_attribute_id": "attribute12345",
"created_at": "2025-01-27T08:32:58.708Z",
"updated_at": "2025-01-27T11:45:29.723Z",
"deleted_at": null,
"attribute": {
"id": 92425,
"name": "Cinsiyet",
"company_id": 3235,
"is_active": true,
"remote_id": "attribute12345",
"created_at": "2025-01-27T08:32:58.673Z",
"updated_at": "2025-01-27T11:45:29.592Z",
"deleted_at": null
}
}
],
"variants_media": [
{
"id": 3517255,
"variant_id": 1279815,
"media_id": 832210,
"variant": null,
"is_active": true,
"is_default": true,
"created_at": "2025-01-27T08:32:57.062Z",
"updated_at": "2025-01-27T08:32:57.062Z",
"remote_link": "https://*.jpg",
"link": "prod/media/3235/20250127/bf45d547-696d-494c-b7b2-c692d643b566.jpg",
"width": null,
"height": null
},
{
"id": 3517251,
"variant_id": 1279815,
"media_id": 832211,
"variant": null,
"is_active": true,
"is_default": false,
"created_at": "2025-01-27T08:32:57.062Z",
"updated_at": "2025-01-27T08:32:57.062Z",
"remote_link": "https://*.jpg",
"link": "prod/media/3235/20250127/5676c260-e5c2-4cb2-97f7-6ac9b9f03751.jpg",
"width": null,
"height": null
},
{
"id": 3517252,
"variant_id": 1279815,
"media_id": 832212,
"variant": null,
"is_active": true,
"is_default": false,
"created_at": "2025-01-27T08:32:57.062Z",
"updated_at": "2025-01-27T08:32:57.062Z",
"remote_link": "https://*.jpg",
"link": "prod/media/3235/20250127/78a6d002-3a8a-4c74-9621-69135ee0cf32.jpg",
"width": null,
"height": null
},
{
"id": 3517253,
"variant_id": 1279815,
"media_id": 832213,
"variant": null,
"is_active": true,
"is_default": false,
"created_at": "2025-01-27T08:32:57.062Z",
"updated_at": "2025-01-27T08:32:57.062Z",
"remote_link": "https://*.jpg",
"link": "prod/media/3235/20250127/08b48c48-a6b2-4635-9516-13f34fe516e5.jpg",
"width": null,
"height": null,
}
{
"id": 3517254,
"variant_id": 1279815,
"media_id": 832214,
"variant": null,
"is_active": true,
"is_default": false,
"created_at": "2025-01-27T08:32:57.062Z",
"updated_at": "2025-01-27T08:32:57.062Z",
"remote_link": "https://*.jpg",
"link": "prod/media/3235/20250127/b41fa7cf-4238-473f-800c-3940d6170aae.jpg",
"width": null,
"height": null
}
],
"variant_translations": [
{
"id": 653337,
"company_id": 3235,
"variant_id": 1279815,
"language": "TR",
"name": "TR Variant Name Translation",
"description": "TR Variant Desc Translation",
"created_at": "2025-01-27T08:32:57.074Z",
"updated_at": "2025-01-27T08:32:57.074Z",
"deleted_at": null,
},
{
"id": 653338,
"company_id": 3235,
"variant_id": 1279815,
"language": "EN",
"name": "Kadın Dikişsiz Çorap",
"description": "<ul><li>Yetişkin kadınlar için özel olarak tasarlanmış patik çoraplar. </li></ul>",
"created_at": "2025-01-27T08:32:57.082Z",
"updated_at": "2025-01-27T11:45:28.973Z",
"deleted_at": null,
},
{
"id": 653339,
"company_id": 3235,
"variant_id": 1279815,
"language": "AZ",
"name": "Kadın Dikişsiz Çorap",
"description": "<ul><li>Yetişkin kadınlar için özel olarak tasarlanmış patik çoraplar. </li></ul>",
"created_at": "2025-01-27T08:32:57.088Z",
"updated_at": "2025-01-27T08:32:57.088Z",
"deleted_at": null,
}
],
"activation_date": null,
"deactivation_date": "2025-01-27T09:06:03.739Z",
}
],
"count": 1,
"search": {
"product_id": null,
"company_id": null,
"sku": "sku1234",
"extra_sku": null,
"barcode": null,
"name": null,
"is_active": null,
"id": null,
"sync_sku": null,
"sort_by": null,
"order_by": null
},
"start": 0,
"length": 10
},
"error_code": 0,
"message": ""
}
This endpoint retrieves all your variants depending on the filters you apply.
POST https://api.hepsiglobal.com/api/v1/variants/search
| Parameter | Type | Description |
|---|---|---|
| start | int | Offset of the search results. |
| length | int | Required result count in response. Default 100, maximum 1000 |
| search. id |
int | Variant ID in HepsiGlobal system |
| search. sku |
string | Variant's SKU in your system |
| search. name |
string | Variant name |
| search. is_active |
bool | true- only active, false- only passive, null- all |
*None of the fields are required.
Variant Info
curl --location
--request GET 'https://api.hepsiglobal.com/api/v1/variants/get/sku1234' \
--header 'Authorization: Bearer {token}' \
--data-raw ''
Response:
{
"data": {
"id": 1279815,
"company_id": 3235,
"product_id": 106454,
"name": "Kadın Dikişsiz Çorap",
"description": "<ul><li>Yetişkin kadınlar için özel olarak tasarlanmış patik çoraplar. </li></ul>",
"sku": "sku1234",
"extra_sku": "",
"barcode": "barcode1234",
"hs_code": "123456789123",
"gtin": "",
"default_image_url": "https://*.jpg",
"extra_images": "https://*_01.jpg,https://*_02.jpg,https://*_03.jpg,https://*_04.jpg,https://*_05.jpg",
"price": "5.6",
"retail_price": "5.6",
"currency": "USD",
"stock": 0,
"is_active": false,
"freight": 1,
"weight": 0,
"height": 0,
"width": 0,
"length": 0,
"created_at": "2025-01-27T08:32:56.779Z",
"updated_at": "2025-01-27T12:25:05.042Z",
"deleted_at": null,
"attribute_values": [
{
"id": 4100635,
"value": "Çok Renkli",
"company_id": 3235,
"attribute_id": 92423,
"is_active": true,
"remote_id": "atrValue123",
"remote_attribute_id": "attribute123",
"created_at": "2025-01-27T08:32:58.096Z",
"updated_at": "2025-01-27T12:25:04.833Z",
"deleted_at": null,
"attribute": {
"id": 92423,
"name": "Renk",
"company_id": 3235,
"is_active": true,
"remote_id": "attribute123",
"created_at": "2025-01-27T08:32:58.001Z",
"updated_at": "2025-01-27T12:25:04.79Z",
"deleted_at": null
},
"marketplace_attribute_values": [
{
"id": 169199,
"marketplace_id": 2,
"value": "Çok Renkli",
"value_en": "Very colorful",
"marketplace_attribute_id": 4293,
"remote_id": "141334",
"is_active": true,
"created_at": "2021-08-20T07:23:34Z",
"updated_at": "2021-08-20T07:23:34Z",
"deleted_at": null
}
]
},
{
"id": 4100636,
"value": "STD",
"company_id": 3235,
"attribute_id": 92424,
"is_active": true,
"remote_id": "atrValue1234",
"remote_attribute_id": "attribute1234",
"created_at": "2025-01-27T08:32:58.47Z",
"updated_at": "2025-01-27T12:25:04.928Z",
"deleted_at": null,
"attribute": {
"id": 92424,
"name": "Beden",
"company_id": 3235,
"is_active": true,
"remote_id": "attribute1234",
"created_at": "2025-01-27T08:32:58.351Z",
"updated_at": "2025-01-27T12:25:04.885Z",
"deleted_at": null
},
"marketplace_attribute_values": [
{
"id": 162174,
"marketplace_id": 2,
"value": "Tek Beden",
"value_en": "One Size",
"marketplace_attribute_id": 4292,
"remote_id": "134309",
"is_active": true,
"created_at": "2021-08-20T07:23:34Z",
"updated_at": "2021-08-20T07:23:34Z",
"deleted_at": null
}
]
},
{
"id": 4100637,
"value": "Kadın",
"company_id": 3235,
"attribute_id": 92425,
"is_active": true,
"remote_id": "atrValue12345",
"remote_attribute_id": "attribute12345",
"created_at": "2025-01-27T08:32:58.708Z",
"updated_at": "2025-01-27T12:25:05.015Z",
"deleted_at": null,
"attribute": {
"id": 92425,
"name": "Cinsiyet",
"company_id": 3235,
"is_active": true,
"remote_id": "attribute12345",
"created_at": "2025-01-27T08:32:58.673Z",
"updated_at": "2025-01-27T12:25:04.973Z",
"deleted_at": null
},
"marketplace_attribute_values": [
{
"id": 513275,
"marketplace_id": 2,
"value": "Kadın",
"value_en": "Female",
"marketplace_attribute_id": 4596,
"remote_id": "485410",
"is_active": true,
"created_at": "2021-08-20T07:23:34Z",
"updated_at": "2021-08-20T07:23:34Z",
"deleted_at": null
}
]
}
],
"variants_media": [
{
"id": 3517255,
"variant_id": 1279815,
"media_id": 832210,
"remote_link": "https://*.jpg",
"link": "prod/media/3235/20250127/bf45d547-696d-494c-b7b2-c692d643b566.jpg"
},
{
"id": 3517251,
"variant_id": 1279815,
"media_id": 832211,
"remote_link": "https://*.jpg",
"link": "prod/media/3235/20250127/5676c260-e5c2-4cb2-97f7-6ac9b9f03751.jpg"
},
{
"id": 3517252,
"variant_id": 1279815,
"media_id": 832212,
"remote_link": "https://*.jpg",
"link": "prod/media/3235/20250127/78a6d002-3a8a-4c74-9621-69135ee0cf32.jpg"
},
{
"id": 3517253,
"variant_id": 1279815,
"media_id": 832213,
"remote_link": "https://*.jpg",
"link": "prod/media/3235/20250127/08b48c48-a6b2-4635-9516-13f34fe516e5.jpg"
},
{
"id": 3517254,
"variant_id": 1279815,
"media_id": 832214,
"remote_link": "https://*.jpg",
"link": "prod/media/3235/20250127/b41fa7cf-4238-473f-800c-3940d6170aae.jpg"
}
],
"variant_translations": [
{
"id": 653337,
"company_id": 3235,
"variant_id": 1279815,
"language": "TR",
"name": "TR Variant Name Translation",
"description": "TR Variant Desc Translation",
"created_at": "2025-01-27T08:32:57.074Z",
"updated_at": "2025-01-27T08:32:57.074Z",
"deleted_at": null
},
{
"id": 653338,
"company_id": 3235,
"variant_id": 1279815,
"language": "EN",
"name": "Kadın Dikişsiz Çorap",
"description": "<ul><li>Yetişkin kadınlar için özel olarak tasarlanmış patik çoraplar. </li></ul>",
"created_at": "2025-01-27T08:32:57.082Z",
"updated_at": "2025-01-27T12:25:04.743Z",
"deleted_at": null
},
{
"id": 653339,
"company_id": 3235,
"variant_id": 1279815,
"language": "AZ",
"name": "Kadın Dikişsiz Çorap",
"description": "<ul><li>Yetişkin kadınlar için özel olarak tasarlanmış patik çoraplar. </li></ul>",
"created_at": "2025-01-27T08:32:57.088Z",
"updated_at": "2025-01-27T08:32:57.088Z",
"deleted_at": null
}
]
},
"error_code": 0,
"message": ""
}
This endpoint gets your variant information with sku.
GET https://api.hepsiglobal.com/api/v1/variants/get/sku1234
Variant Enabled
curl --location
--request GET 'https://api.hepsiglobal.com/api/v1/variants/enabled/sku1234' \
--header 'Authorization: Bearer {token}' \
--data-raw ''
Response:
{
"data": {
"id": "1bbfa58a-030b-4e39-a6f1-f20c6aa0b133",
"company_id": 3235,
"file_name": "prod/requests/3235/20250127/variants_enable/22eea6c2-2fb0-4f84-a019-2d07d74f178e",
"method": "variant_enable",
"status": "open",
"error_code": null,
"error_msg": null,
"created_at": "2025-01-27T12:36:41.799496157Z",
"updated_at": "2025-01-27T12:36:41.799496325Z",
"deleted_at": null,
},
"error_code": 0,
"message": ""
}
This endpoint enable variant with sku.
GET https://api.hepsiglobal.com/api/v1/variants/enabled/sku1234
Variant Disabled
curl --location
--request GET 'https://api.hepsiglobal.com/api/v1/variants/disabled/sku1234' \
--header 'Authorization: Bearer {token}' \
--data-raw ''
Response:
{
"data": {
"id": "2c512454-d4cb-46a7-8bfc-2b1136b44e9a",
"company_id": 3235,
"file_name": "prod/requests/3235/20250127/variants_disable/07104615-e324-4046-a557-3d9db8697462",
"method": "variant_disable",
"status": "open",
"error_code": null,
"error_msg": null,
"created_at": "2025-01-27T12:37:22.404623979Z",
"updated_at": "2025-01-27T12:37:22.404624172Z",
"deleted_at": null,
},
"error_code": 0,
"message": ""
}
This endpoint disable variant with sku.
GET https://api.hepsiglobal.com/api/v1/variants/disabled/sku1234
Variant Price And Stock Update
curl --location
--request POST 'https://api.hepsiglobal.com/api/v1/variants/stock-and-price' \
--header 'Authorization: Bearer {token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"items": [
{
"sku": "sku1234",
"stock": 20,
"price": 99.99,
"retail_price": 129.99,
"others": {
"freight": 5,
"weight": 120,
"height": 10,
"length": 20,
"width": 15
}
}
]
}
'
Response:
{
"data": {
"id": "8895ccfe-ab68-42f6-87bd-ab3cb7386e50",
"company_id": 3235,
"file_name": "prod/requests/3235/20250127/variants_stock_and_price/23247346-7631-480c-a785-7b8f443a7ad6",
"method": "variant_stock_and_price_update",
"status": "open",
"error_code": null,
"error_msg": null,
"created_at": "2025-01-27T12:41:04.843912594Z",
"updated_at": "2025-01-27T12:41:04.843912749Z",
"deleted_at": null,
},
"error_code": 0,
"message": ""
}
This service updates the stock, price values for the variant(s) and the dimension values (width, height, length, weight and freight) that directly affect the price.
POST https://api.hepsiglobal.com/api/v1/variants/stock-and-price
| Parameter | Type | Required | Description |
|---|---|---|---|
sku |
string | Yes | Variant SKU |
stock |
int | Yes | Stock |
price |
float | Yes | Price |
retail_price |
float | No | Retail price (crossed price) |
others.freight |
float | No | Freight value for shipping calculations. |
others.weight |
float | No | Weight of the product in grams |
others.height |
float | No | Height of the product in millimeters |
others.length |
float | No | Length of the product in millimeters |
others.width |
float | No | Width of the product in millimeters |
Orders
Search Orders
curl --location
--request POST 'https://api.hepsiglobal.com/api/v1/orders/search' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"start":0,
"length":10,
"search":{
"id": null,
"ids": [],
"marketplace_order_id": null,
"created_from": "2025-01-02T10:30:00.000Z",
"created_to": "2025-01-03T10:30:00.000Z",
"updated_from": "2025-01-02T10:30:00.000Z",
"updated_to": "2025-01-03T10:30:00.000Z",
"status": null,
"customer_full_name": null,
"sku": null,
"spu": null,
"marketplace_sku": null,
"marketplace_id": null
}
}'
Response:
{
"data": {
"data": [
{
"id": 35836,
"company_id": 3235,
"marketplace_id": 12,
"marketplace_order_id": "mporder123",
"marketplace_bank_order_id": "mporder123",
"customer_id": 32354,
"customer_identity_number": "1111111111",
"customer_full_name": "Customer Name Surname",
"customer_shipping_address_id": 80992,
"customer_billing_address_id": 80991,
"customer_tax_number": "1111111111",
"currency": "USD",
"base_currency": "USD",
"base_price_total": "24",
"commission_fee_total": "26.4",
"commission_vat_fee_total": "5.28",
"marketplace_fee_total": "0",
"customs_currency": "USD",
"customs_fee_total": "0",
"otv_fee_total": "0",
"tax_label_fee_total": "0",
"original_tax_label_fee_total": "0",
"original_tax_label_fee_currency": "USD",
"shipping_currency": "USD",
"logistic_fee_total": "0",
"service_fee_total": "0",
"buffer_fee_total": "0",
"total_price": "55.68",
"tax_total": "0",
"discount_total": "45.76",
"grand_total": "55.68",
"original_grand_total": "55.68",
"original_currency": "USD",
"marketplace_commission_fee_total": "0",
"marketplace_base_commission_fee_total": "0",
"marketplace_service_fee_total": "0",
"marketplace_service_vat_fee_total": "0",
"order_date": "2025-01-02T10:00:12Z",
"created_at": "2025-01-02T10:18:45.002Z",
"updated_at": "2025-01-02T10:30:05.626Z",
"order_items": [
{
"id": 13734,
"order_id": 35836,
"company_id": 3235,
"variant_id": 235577,
"marketplace_variant_history_id": 76074,
"marketplace_order_id": "mporder123",
"marketplace_order_item_id": "mporder123_HBV00000321EF",
"marketplace_sku": "mpsku1234",
"currency": "USD",
"base_currency": "USD",
"unit_base_price": "24",
"total_base_price": "24",
"unit_commission_fee": "26.4",
"unit_commission_vat_fee": "5.28",
"total_commission_fee": "26.4",
"total_commission_vat_fee": "5.28",
"rate": "1",
"marketplace_rate": 100,
"unit_marketplace_fee": "0",
"total_marketplace_fee": "0",
"customs_currency": "USD",
"unit_customs_fee": "0",
"total_customs_fee": "0",
"unit_otv_fee": "0",
"total_otv_fee": "0",
"unit_tax_label_fee": "0",
"total_tax_label_fee": "0",
"tax_label_rate": "1",
"unit_original_tax_label_fee": "0",
"total_original_tax_label_fee": "0",
"original_tax_label_fee_currency": "USD",
"shipping_currency": "USD",
"shipping_rate": "1",
"unit_logistic_fee": "0",
"total_logistic_fee": "0",
"unit_service_fee": "0",
"total_service_fee": "0",
"unit_buffer_fee": "0",
"total_buffer_fee": "0",
"unit_price": "55.68",
"total_price": "55.68",
"tax_fee": "0",
"discount": "45.76",
"grand_total": "55.68",
"original_grand_total": "55.68",
"original_currency": "USD",
"quantity": 1,
"quantity_cancel": 0,
"quantity_refund": 0,
"marketplace_commission_fee": "0",
"marketplace_base_commission_fee": "0",
"hb_new_price_calculation": true,
"unit_marketplace_service_fee": "0",
"unit_marketplace_service_vat_fee": "0",
"total_marketplace_service_fee": "0",
"total_marketplace_service_vat_fee": "0",
"total_base_price_after_discount": "24",
"status": "completed",
"cancellation_reason": "",
"cancellation_date": null,
"cancellation_user_id": null,
"cancellation_user_type": null,
"cancellation_user_name": null,
"marketplace_status": "open",
"due_date": "2025-01-06T15:00:00Z",
"created_at": "2025-01-02T10:18:45.004Z",
"updated_at": "2025-01-02T11:29:39.49Z",
"deleted_at": null,
"variant": {
"id": 235577,
"company_id": 3235,
"product_id": 104187,
"name": "Blender",
"description": "<ul><li>Blender Description</li></ul>",
"sku": "sku1234",
"barcode": "1132459869123",
"hs_code": "850940000013",
"gtin": "",
"default_image_url": "https://*.jpg",
"extra_images": [
"https://*_01.jpg",
"https://*_02.jpg"
],
"price": "88",
"retail_price": "88",
"currency": "USD",
"stock": 88,
"is_active": true,
"freight": 2,
"weight": 500,
"height": 0,
"width": 0,
"length": 0,
"created_at": "2023-11-29T08:39:18.72Z",
"updated_at": "2025-01-28T07:18:56.272Z",
"deleted_at": null,
"product": {
"id": 104187,
"company_id": 3235,
"category_id": 133139,
"brand_id": 40143,
"name": "Blender",
"remote_category_id": "eee5c792e8a0ddfe97791671532f0206",
"remote_brand_id": "a6596eebfd87efaaf16a73adb1e00284",
"spu": "spu123",
"default_image_url": "https://*.jpg",
"tax_class_id": 3,
"is_active": true,
"fulfillment_day": 2,
"guarantee": 24,
"created_at": "2023-11-29T08:39:02.593Z",
"updated_at": "2025-01-22T12:50:00.231Z",
"deleted_at": null
},
"activation_date": "2024-12-25T08:23:11.474Z",
"deactivation_date": null,
"commission_rate": "10",
"commission_vat_rate": "20"
},
"subject_to_penalty": true,
"refund_date": null,
"currency_usd_to_tl_rate": "34"
}
],
"customer_billing_address": {
"id": 80991,
"company_id": 3235,
"remote_id": "NOON-4e8598f0f9ba5e6b372e38d5ee13f39e",
"name": "Customer Name Surname",
"address": "NoonHQ, Boulevard Plaza - Downtown Dubai - Dubai - United Arab Emirates",
"phone": "",
"country_code": "AE",
"district": "Dubai",
"city": "Dubai",
"town": "Dubai",
"zipcode": "",
"created_at": "2024-11-25T07:52:07.028Z",
"updated_at": "2024-11-25T07:52:07.028Z"
},
"customer_shipping_address": {
"id": 80992,
"company_id": 3235,
"remote_id": "NOON-635268c1ec03c759ce6840232e6703fd",
"name": "Customer Name Surname",
"address": "Noon HQ,Boulevard Plaza - Downtown Dubai - Dubai - United Arab Emirates",
"phone": "",
"country_code": "AE",
"district": "Dubai",
"city": "Dubai",
"town": "Dubai",
"zipcode": "",
"created_at": "2024-11-25T07:52:07.035Z",
"updated_at": "2024-11-25T07:52:07.035Z"
},
"shipping_provider": {
"name": "Noon",
"is_formula": false,
"adapter": "noon"
},
"marketplace_channel_id": 18
}
],
"count": 1,
"search": {
"id": null,
"ids": [],
"marketplace_order_id": null,
"created_from": "2025-01-02T10:30:00.000Z",
"created_to": "2025-01-03T10:30:00.000Z",
"updated_from": "2025-01-02T10:30:00.000Z",
"updated_to": "2025-01-03T10:30:00.000Z",
"status": null,
"customer_full_name": null,
"sku": null,
"spu": null,
"marketplace_sku": null,
"marketplace_id": null
},
"start": 0,
"length": 10
},
"error_code": 0,
"message": ""
}
This endpoint allows you to search for orders based on various criteria such as date, status, customer details, and product identifiers.
POST https://api.hepsiglobal.com/api/v1/orders/search
| Parameter | Type | Description |
|---|---|---|
| start | int | Offset of the search results. |
| length | int | Required result count in response. Default 100, maximum 1000. |
| search. id |
int | Order ID in HepsiGlobal system. |
| search. ids |
[]int | Array of Order IDs. Max 100 IDs allowed at once. |
| search. marketplace_order_id |
string | Marketplace Order ID in HepsiGlobal system. |
| search. created_from |
time | Orders created after a specific date. |
| search. created_to |
time | Orders created before a specific date. |
| search. updated_from |
time | Orders that changed after a specific date. |
| search. updated_to |
time | Orders that changed before a specific date. |
| search. status |
string | order item status (open, delay, preparing, delay_by_package, shipped, completed, refund, cancel) |
| search. customer_full_name |
string | Customer's full name who placed the order. |
| search. sku |
string | Variant's unique code in your system. |
| search. spu |
string | Product's unique code in your system. |
| search. marketplace_sku |
string | SKU code for the variant specific to the relevant marketplace. |
| search. marketplace_id |
int | Marketplace ID retrieved by marketplace list service. |
*None of the fields are required.
Unfulfilled Order List
curl --location
--request POST 'https://api.hepsiglobal.com/api/v1/orders/unfulfilled-list' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"start":0,
"length":10
}'
Response:
{
"data": {
"data": [
{
"id": 13770,
"order_id": 35859,
"company_id": 3235,
"variant_id": 235577,
"marketplace_variant_history_id": 76587,
"marketplace_order_id": "mporder123",
"marketplace_order_item_id": "mporder123_HBV00000321EF",
"marketplace_sku": "mpsku1234",
"currency": "USD",
"base_currency": "USD",
"unit_base_price": "88",
"total_base_price": "176",
"unit_commission_fee": "10",
"unit_commission_vat_fee": "2",
"total_commission_fee": "20",
"total_commission_vat_fee": "4",
"rate": "1",
"marketplace_rate": 100,
"unit_marketplace_fee": "0",
"total_marketplace_fee": "0",
"customs_currency": "USD",
"unit_customs_fee": "0",
"total_customs_fee": "0",
"unit_otv_fee": "0",
"total_otv_fee": "0",
"unit_tax_label_fee": "0",
"total_tax_label_fee": "0",
"tax_label_rate": "1",
"unit_original_tax_label_fee": "0",
"total_original_tax_label_fee": "0",
"original_tax_label_fee_currency": "USD",
"shipping_currency": "USD",
"shipping_rate": "1",
"unit_logistic_fee": "0",
"total_logistic_fee": "0",
"unit_service_fee": "0",
"total_service_fee": "0",
"unit_buffer_fee": "0",
"total_buffer_fee": "0",
"unit_price": "188",
"total_price": "376",
"tax_fee": "0",
"discount": "356.16",
"grand_total": "376",
"original_grand_total": "376",
"original_currency": "USD",
"quantity": 2,
"quantity_cancel": 0,
"quantity_refund": 0,
"marketplace_commission_fee": "0",
"marketplace_base_commission_fee": "0",
"unit_marketplace_service_fee": "0",
"unit_marketplace_service_vat_fee": "0",
"total_marketplace_service_fee": "0",
"total_marketplace_service_vat_fee": "0",
"total_base_price_after_discount": "176",
"status": "open",
"cancellation_reason": "",
"cancellation_date": null,
"cancellation_user_id": null,
"cancellation_user_type": null,
"cancellation_user_name": null,
"marketplace_status": "open",
"due_date": "2025-01-30T15:00:00Z",
"created_at": "2025-01-28T06:52:49.997Z",
"updated_at": "2025-01-28T06:52:49.997Z",
"deleted_at": null,
"variant": {
"id": 235577,
"company_id": 3235,
"product_id": 104187,
"name": "Blender",
"description": "<ul><li>Blender Description</li></ul>",
"sku": "sku1234",
"barcode": "1132459869123",
"hs_code": "850940000013",
"gtin": "",
"default_image_url": "https://*.jpg",
"extra_images": [
"https://*_01.jpg",
"https://*_02.jpg"
],
"price": "88",
"retail_price": "88",
"currency": "USD",
"stock": 88,
"is_active": true,
"freight": 2,
"weight": 500,
"height": 0,
"width": 0,
"length": 0,
"created_at": "2023-11-29T08:39:18.72Z",
"updated_at": "2025-01-28T07:18:56.272Z",
"deleted_at": null,
"product": {
"id": 104187,
"company_id": 3235,
"category_id": 133139,
"brand_id": 40143,
"name": "Blender",
"remote_category_id": "eee5c792e8a0ddfe97791671532f0206",
"remote_brand_id": "a6596eebfd87efaaf16a73adb1e00284",
"spu": "spu123",
"default_image_url": "https://*.jpg",
"tax_class_id": 3,
"is_active": true,
"fulfillment_day": 2,
"guarantee": 24,
"created_at": "2023-11-29T08:39:02.593Z",
"updated_at": "2025-01-22T12:50:00.231Z",
"deleted_at": null
},
"activation_date": "2024-12-25T08:23:11.474Z",
"deactivation_date": null,
"commission_rate": "10",
"commission_vat_rate": "20"
},
"order": {
"id": 35859,
"company_id": 3235,
"marketplace_id": 12,
"marketplace_order_id": "mporder123",
"marketplace_bank_order_id": "mporder123",
"customer_id": 32294,
"customer_identity_number": "1111111111",
"customer_full_name": "Customer Name Surname",
"customer_shipping_address_id": 80116,
"customer_billing_address_id": 80115,
"customer_tax_number": "1111111111",
"currency": "USD",
"base_currency": "USD",
"base_price_total": "227.16",
"commission_fee_total": "76.28",
"commission_vat_fee_total": "15.26",
"marketplace_fee_total": "0",
"customs_currency": "USD",
"customs_fee_total": "0",
"otv_fee_total": "0",
"tax_label_fee_total": "0",
"original_tax_label_fee_total": "0",
"original_tax_label_fee_currency": "USD",
"shipping_currency": "USD",
"logistic_fee_total": "0",
"service_fee_total": "0",
"buffer_fee_total": "0",
"total_price": "494.7",
"tax_total": "0",
"discount_total": "466.96",
"grand_total": "494.7",
"original_grand_total": "494.7",
"original_currency": "USD",
"marketplace_commission_fee_total": "0",
"marketplace_base_commission_fee_total": "0",
"marketplace_service_fee_total": "0",
"marketplace_service_vat_fee_total": "0",
"order_date": "2025-01-28T10:42:12Z",
"created_at": "2025-01-28T06:52:49.928Z",
"updated_at": "2025-01-28T06:52:49.928Z",
"customer_billing_address": {
"id": 80115,
"company_id": 3235,
"remote_id": "NOON-040e0f347915c9ec40d15e6fa7d299e8",
"name": "Customer Name Surname",
"address": "NoonHQ, Boulevard Plaza - Downtown Dubai - Dubai - United Arab Emirates",
"phone": "",
"country_code": "AE",
"district": "Dubai",
"city": "Dubai",
"town": "Dubai",
"zipcode": "",
"created_at": "2024-08-15T23:29:24.461Z",
"updated_at": "2024-08-15T23:29:24.461Z"
},
"customer_shipping_address": {
"id": 80116,
"company_id": 3235,
"remote_id": "NOON-c08030d277ec2983453127b7fc4a26e5",
"name": "Customer Name Surname",
"address": "Noon HQ,Boulevard Plaza - Downtown Dubai - Dubai - United Arab Emirates",
"phone": "",
"country_code": "AE",
"district": "Dubai",
"city": "Dubai",
"town": "Dubai",
"zipcode": "",
"created_at": "2024-08-15T23:29:24.471Z",
"updated_at": "2024-08-15T23:29:24.471Z"
},
"shipping_provider": {
"name": "Noon",
"is_formula": false,
"adapter": "noon"
},
"marketplace_channel_id": 18
},
"subject_to_penalty": true
}
],
"count": 1,
"start": 0,
"length": 10
},
"error_code": 0,
"message": ""
}
This endpoint allows you to retrieve a list of all orders that have not yet been packed.
POST https://api.hepsiglobal.com/api/v1/orders/unfulfilled-list
| Parameter | Type | Required | Description |
|---|---|---|---|
| start | int | - | Offset of the search results. |
| length | int | - | Requested result count in response. Default 100, maximum 1000. |
Get Order Details
curl --location
--request GET 'https://api.hepsiglobal.com/api/v1/orders/{id}' \
--header 'Authorization: Bearer {token}' \
--data-raw ''
Response:
{
"data": {
"id": 35836,
"company_id": 3235,
"marketplace_id": 12,
"marketplace_order_id": "mporder123",
"marketplace_bank_order_id": "mporder123",
"customer_id": 32354,
"customer_identity_number": "1111111111",
"customer_full_name": "Customer Name Surname",
"customer_shipping_address_id": 80992,
"customer_billing_address_id": 80991,
"customer_tax_number": "1111111111",
"currency": "USD",
"base_currency": "USD",
"base_price_total": "24",
"commission_fee_total": "26.4",
"commission_vat_fee_total": "5.28",
"marketplace_fee_total": "0",
"customs_currency": "USD",
"customs_fee_total": "0",
"otv_fee_total": "0",
"tax_label_fee_total": "0",
"original_tax_label_fee_total": "0",
"original_tax_label_fee_currency": "USD",
"shipping_currency": "USD",
"logistic_fee_total": "0",
"service_fee_total": "0",
"buffer_fee_total": "0",
"total_price": "55.68",
"tax_total": "0",
"discount_total": "45.76",
"grand_total": "55.68",
"original_grand_total": "55.68",
"original_currency": "USD",
"marketplace_commission_fee_total": "0",
"marketplace_base_commission_fee_total": "0",
"marketplace_service_fee_total": "0",
"marketplace_service_vat_fee_total": "0",
"order_date": "2025-01-02T10:00:12Z",
"created_at": "2025-01-02T10:18:45.002Z",
"updated_at": "2025-01-02T10:30:05.626Z",
"order_items": [
{
"id": 13734,
"order_id": 35836,
"company_id": 3235,
"variant_id": 235577,
"marketplace_variant_history_id": 76074,
"marketplace_order_id": "mporder123",
"marketplace_order_item_id": "mporder123_HBV00000321EF",
"marketplace_sku": "mpsku1234",
"currency": "USD",
"base_currency": "USD",
"unit_base_price": "24",
"total_base_price": "24",
"unit_commission_fee": "26.4",
"unit_commission_vat_fee": "5.28",
"total_commission_fee": "26.4",
"total_commission_vat_fee": "5.28",
"rate": "1",
"marketplace_rate": 100,
"unit_marketplace_fee": "0",
"total_marketplace_fee": "0",
"customs_currency": "USD",
"unit_customs_fee": "0",
"total_customs_fee": "0",
"unit_otv_fee": "0",
"total_otv_fee": "0",
"unit_tax_label_fee": "0",
"total_tax_label_fee": "0",
"tax_label_rate": "1",
"unit_original_tax_label_fee": "0",
"total_original_tax_label_fee": "0",
"original_tax_label_fee_currency": "USD",
"shipping_currency": "USD",
"shipping_rate": "1",
"unit_logistic_fee": "0",
"total_logistic_fee": "0",
"unit_service_fee": "0",
"total_service_fee": "0",
"unit_buffer_fee": "0",
"total_buffer_fee": "0",
"unit_price": "55.68",
"total_price": "55.68",
"tax_fee": "0",
"discount": "45.76",
"grand_total": "55.68",
"original_grand_total": "55.68",
"original_currency": "USD",
"quantity": 1,
"quantity_cancel": 0,
"quantity_refund": 0,
"marketplace_commission_fee": "0",
"marketplace_base_commission_fee": "0",
"unit_marketplace_service_fee": "0",
"unit_marketplace_service_vat_fee": "0",
"total_marketplace_service_fee": "0",
"total_marketplace_service_vat_fee": "0",
"total_base_price_after_discount": "24",
"status": "completed",
"cancellation_reason": "",
"cancellation_date": null,
"cancellation_user_id": null,
"cancellation_user_type": null,
"cancellation_user_name": null,
"marketplace_status": "open",
"due_date": "2025-01-06T15:00:00Z",
"created_at": "2025-01-02T10:18:45.004Z",
"updated_at": "2025-01-02T11:29:39.49Z",
"deleted_at": null,
"variant": {
"id": 235577,
"company_id": 3235,
"product_id": 104187,
"name": "Blender",
"description": "<ul><li>Blender Description</li></ul>",
"sku": "sku1234",
"barcode": "1132459869123",
"hs_code": "850940000013",
"gtin": "",
"default_image_url": "https://*.jpg",
"extra_images": [
"https://*_01.jpg",
"https://*_02.jpg"
],
"price": "88",
"retail_price": "88",
"currency": "USD",
"stock": 88,
"is_active": true,
"freight": 2,
"weight": 500,
"height": 0,
"width": 0,
"length": 0,
"created_at": "2023-11-29T08:39:18.72Z",
"updated_at": "2025-01-28T07:18:56.272Z",
"deleted_at": null,
"product": {
"id": 104187,
"company_id": 3235,
"category_id": 133139,
"brand_id": 40143,
"name": "Blender",
"remote_category_id": "eee5c792e8a0ddfe97791671532f0206",
"remote_brand_id": "a6596eebfd87efaaf16a73adb1e00284",
"spu": "spu123",
"default_image_url": "https://*.jpg",
"tax_class_id": 3,
"is_active": true,
"fulfillment_day": 2,
"guarantee": 24,
"created_at": "2023-11-29T08:39:02.593Z",
"updated_at": "2025-01-22T12:50:00.231Z",
"deleted_at": null
},
"activation_date": "2024-12-25T08:23:11.474Z",
"deactivation_date": null,
"commission_rate": "10",
"commission_vat_rate": "20"
},
"package_items": [
{
"id": 8734,
"company_id": 3235,
"package_id": 7507,
"order_item_id": 13734,
"quantity": 1,
"total_deci": 2,
"created_at": "2025-01-02T10:19:03.084Z",
"updated_at": "2025-01-02T10:19:03.084Z",
"deleted_at": null,
"package": {
"id": 7507,
"company_id": 3235,
"order_id": 35836,
"remote_id": "6776681647463ec83cac8524",
"proforma_url": "https://*.pdf",
"marketplace_package_id": "7507",
"total_deci": 2,
"status": "packaged",
"invoice_link": "https://*.pdf",
"invoice_number": "62750013577924",
"invoice_date": "2025-01-02T00:00:00Z",
"delivered_at": "2025-01-01T00:00:00Z",
"cancellation_date": null,
"payment_valut_date": "2025-01-21T00:00:00Z",
"package_received_at": null,
"ead": null,
"esd": "2025-01-06T15:00:00Z",
"created_at": "2025-01-02T10:19:03.083Z",
"updated_at": "2025-01-02T13:57:45.538Z",
"deleted_at": null,
"volumetric_weight": 0,
"weight": 0,
"height": 0,
"width": 0,
"length": 0
}
}
],
"subject_to_penalty": true,
"refund_date": null,
"currency_usd_to_tl_rate": "34"
}
],
"customer_billing_address": {
"id": 80991,
"company_id": 3235,
"remote_id": "NOON-4e8598f0f9ba5e6b372e38d5ee13f39e",
"name": "Customer Name Surname",
"address": "NoonHQ, Boulevard Plaza - Downtown Dubai - Dubai - United Arab Emirates",
"phone": "",
"country_code": "AE",
"district": "Dubai",
"city": "Dubai",
"town": "Dubai",
"zipcode": "",
"created_at": "2024-11-25T07:52:07.028Z",
"updated_at": "2024-11-25T07:52:07.028Z"
},
"customer_shipping_address": {
"id": 80992,
"company_id": 3235,
"remote_id": "NOON-635268c1ec03c759ce6840232e6703fd",
"name": "Customer Name Surname",
"address": "Noon HQ,Boulevard Plaza - Downtown Dubai - Dubai - United Arab Emirates",
"phone": "",
"country_code": "AE",
"district": "Dubai",
"city": "Dubai",
"town": "Dubai",
"zipcode": "",
"created_at": "2024-11-25T07:52:07.035Z",
"updated_at": "2024-11-25T07:52:07.035Z"
},
"shipping_provider": {
"name": "Noon",
"is_formula": false,
"adapter": "noon"
},
"marketplace_channel_id": 18
},
"error_code": 0,
"message": ""
}
This endpoint retrieves order details.
GET https://api.hepsiglobal.com/api/v1/orders/{id}
Order Cancel
curl --location
--request POST 'https://api.hepsiglobal.com/api/v1/order-items/cancel' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"lines": [
{
"id": 13770,
"quantity": 2,
"reason": "out_of_stock"
}
]
}'
Response:
{
"data":true,
"error_code":0,
"message":""
}
Order cancellations can only be made on a line-item basis, meaning the entire order item must be canceled together. Quantity-based (partial) cancellations are not allowed. Therefore, the quantity in the cancellation request must match the total quantity of the respective order item.
An order that has been shipped, delivered, or refunded cannot be canceled.
POST https://api.hepsiglobal.com/api/v1/order-items/cancel
| Parameter | Type | Required | Description |
|---|---|---|---|
| lines.id | int | Yes | Order Item ID in HepsiGlobal system |
| lines.quantity | int | Yes | quantity to be cancelled |
| lines.reason | string | Yes | Any of the reasons returned by the Order Cancellation Reason List service. |
Order Cancellation Reason List
curl --location
--request GET 'https://api.hepsiglobal.com/api/v1/order-items/reasons' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"start":0,
"length":10
}'
Response:
{
"data":
{
"out_of_stock",
"incorrect_pricing",
"sourcing_delay"
},
"error_code": 0,
"message": ""
}
This endpoint retrieves all cancellation reason.
GET https://api.hepsiglobal.com/api/v1/order-items/reasons
Packages
Search Package
curl --location
--request POST 'https://api.hepsiglobal.com/api/v1/packages/search' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"start": 0,
"length": 10,
"search": {
"id": null,
"order_id": null,
"marketplace_package_id": null,
"marketplace_order_id": null,
"remote_id": null,
"status": null,
"package_status": null
}
}'
Response:
{
"data": {
"data": [
{
"id": 7507,
"company_id": 3235,
"order_id": 35836,
"remote_id": "6776681647463ec83cac8524",
"proforma_url": "https://*.pdf",
"marketplace_package_id": "7507",
"total_deci": 2,
"status": "packaged",
"invoice_link": "https://*.pdf",
"invoice_number": "62750013577924",
"invoice_date": "2025-01-02T00:00:00Z",
"tracking": [
{
"id": 30106,
"package_id": 7507,
"company_id": 3235,
"tracking_barcode": "62750013577924",
"tracking_link": "https://*.com/tracking/*?lang=en",
"tracking_pdf": "https://*.pdf",
"label_image_url": "https://*.jpg",
"tracking_provider": "hepsijet",
"provider": "hepsijet",
"origin_country": "TR",
"destination_country": "AE",
"is_default": false,
"delivery_info": null,
"delivery_info_provider": null,
"is_tracking": true,
"delivery_state": "pending",
"state_detail": null,
"marketplace_delivery_state": "",
"created_at": "2025-01-02T10:19:05.196Z",
"updated_at": "2025-01-09T12:30:20.945Z",
"deleted_at": null,
"customs_declaration_id": "",
"customs_declaration_date": null,
"is_first_mile": true,
"undelivered_reason": null
},
{
"id": 30105,
"package_id": 7507,
"company_id": 3235,
"tracking_barcode": "62750013577924",
"tracking_link": "https://*.com/tracking/*?lang=en",
"tracking_pdf": "https://*.pdf",
"label_image_url": "https://*.jpg",
"tracking_provider": "noon",
"provider": "noon",
"origin_country": "TR",
"destination_country": "AE",
"is_default": true,
"delivery_info": null,
"delivery_info_provider": null,
"is_tracking": false,
"delivery_state": "delivered",
"state_detail": null,
"marketplace_delivery_state": "delivered",
"created_at": "2025-01-02T10:19:03.637Z",
"updated_at": "2025-01-02T11:30:06Z",
"deleted_at": null,
"customs_declaration_id": "",
"customs_declaration_date": null,
"is_first_mile": false,
"undelivered_reason": null
}
],
"delivered_at": "2025-01-01T00:00:00Z",
"cancellation_date": null,
"payment_valut_date": "2025-01-21T00:00:00Z",
"package_received_at": "2025-01-06T15:00:00Z",
"ead": "2025-01-06T15:00:00Z",
"esd": "2025-01-06T15:00:00Z",
"created_at": "2025-01-02T10:19:03.083Z",
"updated_at": "2025-01-02T13:57:45.538Z",
"deleted_at": null,
"package_items": [
{
"id": 8734,
"company_id": 3235,
"package_id": 7507,
"order_item_id": 13734,
"quantity": 1,
"total_deci": 2,
"created_at": "2025-01-02T10:19:03.084Z",
"updated_at": "2025-01-02T10:19:03.084Z",
"deleted_at": null
}
],
"order": {
"id": 35836,
"company_id": 3235,
"marketplace_id": 12,
"marketplace_order_id": "mporder12345",
"marketplace_bank_order_id": "mporder12345",
"customer_id": 32354,
"customer_identity_number": "1111111111",
"customer_full_name": "Customer Name Surname",
"customer_shipping_address_id": 80992,
"customer_billing_address_id": 80991,
"customer_tax_number": "1111111111",
"currency": "USD",
"base_currency": "USD",
"base_price_total": "24",
"commission_fee_total": "26.4",
"commission_vat_fee_total": "5.28",
"marketplace_fee_total": "0",
"customs_currency": "USD",
"customs_fee_total": "0",
"otv_fee_total": "0",
"tax_label_fee_total": "0",
"original_tax_label_fee_total": "0",
"original_tax_label_fee_currency": "USD",
"shipping_currency": "USD",
"logistic_fee_total": "0",
"service_fee_total": "0",
"buffer_fee_total": "0",
"total_price": "55.68",
"tax_total": "0",
"discount_total": "45.76",
"grand_total": "55.68",
"original_grand_total": "55.68",
"original_currency": "USD",
"marketplace_commission_fee_total": "0",
"marketplace_base_commission_fee_total": "0",
"marketplace_service_fee_total": "0",
"marketplace_service_vat_fee_total": "0",
"order_date": "2025-01-02T10:00:12Z",
"created_at": "2025-01-02T10:18:45.002Z",
"updated_at": "2025-01-02T10:30:05.626Z",
"deleted_at": null,
"customer_pay_uuid": "b7ca0eb078a9c4c0c3346a38fdb72ce9",
"customer_address_key": "4e8598f0f9ba5e6b372e38d5ee13f39e",
"shipping_provider_id": 15,
"marketplace_channel_id": 18,
"marketplace_channel": {
"id": 18,
"marketplace_id": 12,
"external_id": "noon_sa",
"channel_name": "Noon KSA",
"is_active": true,
"created_at": "2024-05-20T12:06:33Z",
"updated_at": "2024-05-20T12:06:35Z",
"deleted_at": null,
"country_code": "SA"
}
},
"company": {
"id": 3235,
"name": "Test A.Ş.",
"is_active": true,
"adapter_package": "api",
"from_currency": "USD",
"native_language": "TR",
"base_country": "TR",
"billing_address_id": 1935,
"delivery_return_address_id": 1936,
"company_contact_id": 922,
"company_info_id": 922,
"bank_account_info_id": 914,
"hepsijet_merchant_id": 31,
"created_at": "2023-11-29T08:33:03.019Z",
"updated_at": "2025-01-20T13:33:29.885Z",
"deleted_at": null,
"created_at_hepsijet": true,
"use_hepsijet_for_first_mile": false,
"first_mile_ignore_country": null,
"is_translate": false,
"retrieves_label_without_invoice": true,
"activation_date": "2025-01-20T13:33:29.885Z",
"deactivation_date": null,
"use_hb_delivery_for_first_mile": true
},
"volumetric_weight": 0,
"weight": 0,
"height": 0,
"width": 0,
"length": 0
}
],
"count": 1,
"search": {
"order_id": null,
"id": null,
"marketplace_package_id": null,
"marketplace_order_id": null,
"remote_id": null,
"status": null,
"package_status": null
},
"start": 0,
"length": 10
},
"error_code": 0,
"message": ""
}
This endpoint retrieves all packages depending on the filters you apply.
POST https://api.hepsiglobal.com/api/v1/packages/search
| Parameter | Type | Description |
|---|---|---|
| start | int | Offset of the search results. |
| length | int | Requested result count in response. Default is 100, maximum is 1000. |
| search.id | int | Package ID in HepsiGlobal system. |
| search.order_id | int | Order ID in HepsiGlobal system. |
| search.marketplace_package_id | string | Package ID in the relevant marketplace. |
| search.marketplace_order_id | string | Marketplace Order ID in the relevant marketplace. |
| search.remote_id | string | Package ID on your system. |
| search.status | string | Package Tracking Status in HepsiGlobal system. (pending, in_transit, delivered, exception, canceled, returned_shipper) |
| search.package_status | string | Package Status in HepsiGlobal system. (packaged, delay, invoice_awaiting, cancelled_by_seller, cancelled_by_marketplace, cancelled_by_system) |
*None of the fields are required.
Create Package
curl --location
--request POST 'https://api.hepsiglobal.com/api/v1/packages' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"order_id": 35624,
"total_deci": 1.0,
"items": [
{
"order_item_id": 13440,
"quantity": 2,
"total_deci": 1.0
}
],
"invoice": {
"invoice_pdf": null,
"invoice_link": "https://*.pdf",
"invoice_date": "2025-01-01",
"invoice_number": "18244124758"
}
}'
Response:
{
"data": {
"id": 7559,
"company_id": 3235,
"order_id": 35624,
"remote_id": "remote_package_1",
"proforma_url": "https://*.pdf",
"marketplace_package_id": "1234",
"total_deci": 4,
"status": "packaged",
"invoice_link": "https://*.pdf",
"invoice_number": "18244124758",
"invoice_date": "2025-01-01T00:00:00Z",
"tracking": [
{
"id": 30106,
"package_id": 7559,
"company_id": 3235,
"tracking_barcode": "62750013577924",
"tracking_link": "https://*.com/tracking/*?lang=en",
"tracking_pdf": "https://*.pdf",
"label_image_url": "https://*.jpg",
"tracking_provider": "hepsijet",
"provider": "hepsijet",
"origin_country": "TR",
"destination_country": "AE",
"is_default": false,
"delivery_info": null,
"delivery_info_provider": null,
"is_tracking": true,
"delivery_state": "pending",
"state_detail": null,
"marketplace_delivery_state": "",
"created_at": "2025-01-02T10:19:05.196Z",
"updated_at": "2025-01-09T12:30:20.945Z",
"deleted_at": null,
"customs_declaration_id": "",
"customs_declaration_date": null,
"is_first_mile": true,
"undelivered_reason": null
},
{
"id": 30105,
"package_id": 7559,
"company_id": 3235,
"tracking_barcode": "62750013577924",
"tracking_link": "https://*.com/tracking/*?lang=en",
"tracking_pdf": "https://*.pdf",
"label_image_url": "https://*.jpg",
"tracking_provider": "noon",
"provider": "noon",
"origin_country": "TR",
"destination_country": "AE",
"is_default": true,
"delivery_info": null,
"delivery_info_provider": null,
"is_tracking": false,
"delivery_state": "pending",
"state_detail": null,
"marketplace_delivery_state": "delivered",
"created_at": "2025-01-02T10:19:03.637Z",
"updated_at": "2025-01-02T11:30:06Z",
"deleted_at": null,
"customs_declaration_id": "",
"customs_declaration_date": null,
"is_first_mile": false,
"undelivered_reason": null
}
],
"esd": "2025-12-02T13:53:00Z",
"created_at": "2025-01-29T12:06:34.329142002Z",
"updated_at": "2025-01-29T12:06:36.146Z",
"deleted_at": null,
"package_items": [
{
"id": 8734,
"company_id": 3235,
"package_id": 7559,
"order_item_id": 13440,
"quantity": 1,
"total_deci": 2,
"created_at": "2025-01-02T10:19:03.084Z",
"updated_at": "2025-01-02T10:19:03.084Z",
"deleted_at": null,
"order_item": {
"id": 13440,
"order_id": 35624,
"company_id": 3235,
"variant_id": 103487,
"marketplace_variant_history_id": 68175,
"marketplace_order_id": "3455531274",
"marketplace_sku": "HBV00000EA6RW",
"currency": "TRY",
"base_currency": "USD",
"unit_base_price": "7.2",
"total_base_price": "7.2",
"unit_commission_fee": "2.52",
"unit_commission_vat_fee": "0.5",
"total_commission_fee": "2.52",
"total_commission_vat_fee": "0.5",
"rate": "34",
"marketplace_rate": 120,
"unit_marketplace_fee": "1.2",
"total_marketplace_fee": "1.2",
"customs_currency": "USD",
"unit_customs_fee": "2.88",
"total_customs_fee": "2.88",
"unit_otv_fee": "0.72",
"total_otv_fee": "0.72",
"unit_tax_label_fee": "0.16",
"total_tax_label_fee": "0.16",
"tax_label_rate": "1.05",
"unit_original_tax_label_fee": "0.15",
"total_original_tax_label_fee": "0.15",
"original_tax_label_fee_currency": "EUR",
"shipping_currency": "USD",
"shipping_rate": "1",
"unit_logistic_fee": "11",
"total_logistic_fee": "11",
"unit_service_fee": "3.2",
"total_service_fee": "3.2",
"unit_buffer_fee": "0",
"total_buffer_fee": "0",
"unit_price": "968.32",
"total_price": "968.32",
"tax_fee": "0",
"discount": "0",
"grand_total": "968.32",
"original_grand_total": "28.48",
"original_currency": "USD",
"quantity": 1,
"quantity_cancel": 0,
"quantity_refund": 0,
"marketplace_commission_fee": "0",
"marketplace_base_commission_fee": "0",
"unit_marketplace_service_fee": "0.25",
"unit_marketplace_service_vat_fee": "0.05",
"total_marketplace_service_fee": "0.25",
"total_marketplace_service_vat_fee": "0.05",
"total_base_price_after_discount": "7.2",
"status": "open",
"cancellation_reason": "",
"cancellation_date": null,
"cancellation_user_id": null,
"cancellation_user_type": null,
"cancellation_user_name": null,
"marketplace_status": "Open",
"merchant_status": "",
"due_date": "2025-12-02T13:53:00Z",
"created_at": "2024-12-11T11:00:03.579Z",
"updated_at": "2024-12-11T11:00:03.579Z",
"deleted_at": null,
"subject_to_penalty": true
}
}
],
"order": {
"id": 35624,
"company_id": 3235,
"marketplace_id": 12,
"marketplace_order_id": "mporder12345",
"marketplace_bank_order_id": "mporder12345",
"customer_id": 32354,
"customer_identity_number": "1111111111",
"customer_full_name": "Customer Name Surname",
"customer_shipping_address_id": 80992,
"customer_billing_address_id": 80991,
"customer_tax_number": "1111111111",
"currency": "USD",
"base_currency": "USD",
"base_price_total": "24",
"commission_fee_total": "26.4",
"commission_vat_fee_total": "5.28",
"marketplace_fee_total": "0",
"customs_currency": "USD",
"customs_fee_total": "0",
"otv_fee_total": "0",
"tax_label_fee_total": "0",
"original_tax_label_fee_total": "0",
"original_tax_label_fee_currency": "USD",
"shipping_currency": "USD",
"logistic_fee_total": "0",
"service_fee_total": "0",
"buffer_fee_total": "0",
"total_price": "55.68",
"tax_total": "0",
"discount_total": "45.76",
"grand_total": "55.68",
"original_grand_total": "55.68",
"original_currency": "USD",
"marketplace_commission_fee_total": "0",
"marketplace_base_commission_fee_total": "0",
"marketplace_service_fee_total": "0",
"marketplace_service_vat_fee_total": "0",
"order_date": "2025-01-02T10:00:12Z",
"created_at": "2025-01-02T10:18:45.002Z",
"updated_at": "2025-01-02T10:30:05.626Z",
"deleted_at": null,
"customer_pay_uuid": "b7ca0eb078a9c4c0c3346a38fdb72ce9",
"customer_address_key": "4e8598f0f9ba5e6b372e38d5ee13f39e",
"shipping_provider_id": 15,
"marketplace_channel_id": 18,
"company": {
"id": 3235,
"name": "Test A.Ş.",
"is_active": true,
"adapter_package": "api",
"from_currency": "USD",
"native_language": "TR",
"base_country": "TR",
"billing_address_id": 1935,
"delivery_return_address_id": 1936,
"company_contact_id": 922,
"company_info_id": 922,
"bank_account_info_id": 914,
"hepsijet_merchant_id": 31,
"created_at": "2023-11-29T08:33:03.019Z",
"updated_at": "2025-01-20T13:33:29.885Z",
"deleted_at": null,
"created_at_hepsijet": true,
"use_hepsijet_for_first_mile": false,
"first_mile_ignore_country": null,
"is_translate": false,
"retrieves_label_without_invoice": true,
"activation_date": "2025-01-20T13:33:29.885Z",
"deactivation_date": null,
"use_hb_delivery_for_first_mile": true
},
"customer_billing_address": {
"id": 80991,
"company_id": 3235,
"remote_id": "NOON-4e8598f0f9ba5e6b372e38d5ee13f39e",
"name": "Customer Name Surname",
"address": "NoonHQ, Boulevard Plaza - Downtown Dubai - Dubai - United Arab Emirates",
"phone": "",
"country_code": "AE",
"district": "Dubai",
"city": "Dubai",
"town": "Dubai",
"zipcode": "",
"created_at": "2024-11-25T07:52:07.028Z",
"updated_at": "2024-11-25T07:52:07.028Z"
},
"customer_shipping_address": {
"id": 80992,
"company_id": 3235,
"remote_id": "NOON-635268c1ec03c759ce6840232e6703fd",
"name": "Customer Name Surname",
"address": "Noon HQ,Boulevard Plaza - Downtown Dubai - Dubai - United Arab Emirates",
"phone": "",
"country_code": "AE",
"district": "Dubai",
"city": "Dubai",
"town": "Dubai",
"zipcode": "",
"created_at": "2024-11-25T07:52:07.035Z",
"updated_at": "2024-11-25T07:52:07.035Z"
},
"shipping_provider": {
"name": "Noon",
"is_formula": false,
"adapter": "noon"
}
}
},
"error_code": 0,
"message": ""
}
Once you are ready to send your products, you need to start with creating package information with the related items by this service. Quantity-based packaging is not allowed; all quantities for an order item must be included in a single package.
POST https://api.hepsiglobal.com/api/v1/packages
Once you are ready to send your products, you need to start with creating package information with the related items by this service. Quantity-based packaging is not allowed; all quantities for an order item must be included in a single package.
POST https://api.hepsiglobal.com/api/v1/packages
| Parameter | Type | Required | Description |
|---|---|---|---|
order_id |
int | Yes | Order ID on HepsiGlobal System |
total_deci |
decimal | Yes | Total volume of the package in decimal (e.g., 1.0) |
items |
array | Yes | Order items and quantities |
items.order_item_id |
int | Yes | Order Item ID in HepsiGlobal System |
items.quantity |
int | Yes | Order Item Quantity |
items.total_deci |
decimal | Yes | Total volume of the item in decimal (e.g., 1.0) |
invoice |
object | No (*) | Invoice details (Required for Turkish merchants) |
invoice.invoice_pdf |
string | Dep. | Invoice PDF in Base64 format (Required if invoice_link is not provided) |
invoice.invoice_link |
string | Dep. | Invoice File Link |
invoice.invoice_date |
string | Yes (*) | Invoice Date |
invoice.invoice_number |
string | Yes (*) | Invoice Number |
Create Package (for self-shipping sellers)
curl --location
--request POST 'https://api.hepsiglobal.com/api/v1/packages' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"order_id": 35624,
"total_deci": 1.0,
"items": [
{
"order_item_id": 13440,
"quantity": 2,
"total_deci": 1.0
}
],
"tracking": {
"tracking_pdf": "http://merchant.zoodmall.com/index.php?m=parcellabel&a=downloadpttlabel&trackNumber=UZ107142235TR",
"tracking_barcode": "12312412412",
"base64_file": null,
"tracking_link": "http://www.ptt.com",
"provider": "pts"
},
"invoice": {
"invoice_pdf": null,
"invoice_link": "https://*.pdf",
"invoice_date": "2025-01-01",
"invoice_number": "18244124758"
}
}'
Response:
{
"data": {
"id": 7559,
"company_id": 3235,
"order_id": 35624,
"remote_id": "remote_package_1",
"proforma_url": "https://*.pdf",
"marketplace_package_id": "1234",
"total_deci": 4,
"status": "packaged",
"invoice_link": "https://*.pdf",
"invoice_number": "18244124758",
"invoice_date": "2025-01-01T00:00:00Z",
"tracking": [
{
"id": 30105,
"package_id": 7559,
"company_id": 3235,
"tracking_barcode": "62750013577924",
"tracking_link": "https://*.com/tracking/*?lang=en",
"tracking_pdf": "https://*.pdf",
"label_image_url": "https://*.jpg",
"tracking_provider": "your_provider",
"provider": "your_provider",
"origin_country": "TR",
"destination_country": "AE",
"is_default": true,
"delivery_info": null,
"delivery_info_provider": null,
"is_tracking": false,
"delivery_state": "pending",
"state_detail": null,
"marketplace_delivery_state": "delivered",
"created_at": "2025-01-02T10:19:03.637Z",
"updated_at": "2025-01-02T11:30:06Z",
"deleted_at": null,
"customs_declaration_id": "",
"customs_declaration_date": null,
"is_first_mile": false,
"undelivered_reason": null
}
],
"esd": "2025-12-02T13:53:00Z",
"created_at": "2025-01-29T12:06:34.329142002Z",
"updated_at": "2025-01-29T12:06:36.146Z",
"deleted_at": null,
"package_items": [
{
"id": 8734,
"company_id": 3235,
"package_id": 7559,
"order_item_id": 13440,
"quantity": 1,
"total_deci": 2,
"created_at": "2025-01-02T10:19:03.084Z",
"updated_at": "2025-01-02T10:19:03.084Z",
"deleted_at": null,
"order_item": {
"id": 13440,
"order_id": 35624,
"company_id": 3235,
"variant_id": 103487,
"marketplace_variant_history_id": 68175,
"marketplace_order_id": "3455531274",
"marketplace_sku": "HBV00000EA6RW",
"currency": "TRY",
"base_currency": "USD",
"unit_base_price": "7.2",
"total_base_price": "7.2",
"unit_commission_fee": "2.52",
"unit_commission_vat_fee": "0.5",
"total_commission_fee": "2.52",
"total_commission_vat_fee": "0.5",
"rate": "34",
"marketplace_rate": 120,
"unit_marketplace_fee": "1.2",
"total_marketplace_fee": "1.2",
"customs_currency": "USD",
"unit_customs_fee": "2.88",
"total_customs_fee": "2.88",
"unit_otv_fee": "0.72",
"total_otv_fee": "0.72",
"unit_tax_label_fee": "0.16",
"total_tax_label_fee": "0.16",
"tax_label_rate": "1.05",
"unit_original_tax_label_fee": "0.15",
"total_original_tax_label_fee": "0.15",
"original_tax_label_fee_currency": "EUR",
"shipping_currency": "USD",
"shipping_rate": "1",
"unit_logistic_fee": "11",
"total_logistic_fee": "11",
"unit_service_fee": "3.2",
"total_service_fee": "3.2",
"unit_buffer_fee": "0",
"total_buffer_fee": "0",
"unit_price": "968.32",
"total_price": "968.32",
"tax_fee": "0",
"discount": "0",
"grand_total": "968.32",
"original_grand_total": "28.48",
"original_currency": "USD",
"quantity": 1,
"quantity_cancel": 0,
"quantity_refund": 0,
"marketplace_commission_fee": "0",
"marketplace_base_commission_fee": "0",
"unit_marketplace_service_fee": "0.25",
"unit_marketplace_service_vat_fee": "0.05",
"total_marketplace_service_fee": "0.25",
"total_marketplace_service_vat_fee": "0.05",
"total_base_price_after_discount": "7.2",
"status": "open",
"cancellation_reason": "",
"cancellation_date": null,
"cancellation_user_id": null,
"cancellation_user_type": null,
"cancellation_user_name": null,
"marketplace_status": "Open",
"merchant_status": "",
"due_date": "2025-12-02T13:53:00Z",
"created_at": "2024-12-11T11:00:03.579Z",
"updated_at": "2024-12-11T11:00:03.579Z",
"deleted_at": null,
"subject_to_penalty": true
}
}
],
"order": {
"id": 35624,
"company_id": 3235,
"marketplace_id": 12,
"marketplace_order_id": "mporder12345",
"marketplace_bank_order_id": "mporder12345",
"customer_id": 32354,
"customer_identity_number": "1111111111",
"customer_full_name": "Customer Name Surname",
"customer_shipping_address_id": 80992,
"customer_billing_address_id": 80991,
"customer_tax_number": "1111111111",
"currency": "USD",
"base_currency": "USD",
"base_price_total": "24",
"commission_fee_total": "26.4",
"commission_vat_fee_total": "5.28",
"marketplace_fee_total": "0",
"customs_currency": "USD",
"customs_fee_total": "0",
"otv_fee_total": "0",
"tax_label_fee_total": "0",
"original_tax_label_fee_total": "0",
"original_tax_label_fee_currency": "USD",
"shipping_currency": "USD",
"logistic_fee_total": "0",
"service_fee_total": "0",
"buffer_fee_total": "0",
"total_price": "55.68",
"tax_total": "0",
"discount_total": "45.76",
"grand_total": "55.68",
"original_grand_total": "55.68",
"original_currency": "USD",
"marketplace_commission_fee_total": "0",
"marketplace_base_commission_fee_total": "0",
"marketplace_service_fee_total": "0",
"marketplace_service_vat_fee_total": "0",
"order_date": "2025-01-02T10:00:12Z",
"created_at": "2025-01-02T10:18:45.002Z",
"updated_at": "2025-01-02T10:30:05.626Z",
"deleted_at": null,
"customer_pay_uuid": "b7ca0eb078a9c4c0c3346a38fdb72ce9",
"customer_address_key": "4e8598f0f9ba5e6b372e38d5ee13f39e",
"shipping_provider_id": 15,
"marketplace_channel_id": 18,
"company": {
"id": 3235,
"name": "Test A.Ş.",
"is_active": true,
"adapter_package": "api",
"from_currency": "USD",
"native_language": "TR",
"base_country": "TR",
"billing_address_id": 1935,
"delivery_return_address_id": 1936,
"company_contact_id": 922,
"company_info_id": 922,
"bank_account_info_id": 914,
"hepsijet_merchant_id": 31,
"created_at": "2023-11-29T08:33:03.019Z",
"updated_at": "2025-01-20T13:33:29.885Z",
"deleted_at": null,
"created_at_hepsijet": true,
"use_hepsijet_for_first_mile": false,
"first_mile_ignore_country": null,
"is_translate": false,
"retrieves_label_without_invoice": true,
"activation_date": "2025-01-20T13:33:29.885Z",
"deactivation_date": null,
"use_hb_delivery_for_first_mile": true
},
"customer_billing_address": {
"id": 80991,
"company_id": 3235,
"remote_id": "NOON-4e8598f0f9ba5e6b372e38d5ee13f39e",
"name": "Customer Name Surname",
"address": "NoonHQ, Boulevard Plaza - Downtown Dubai - Dubai - United Arab Emirates",
"phone": "",
"country_code": "AE",
"district": "Dubai",
"city": "Dubai",
"town": "Dubai",
"zipcode": "",
"created_at": "2024-11-25T07:52:07.028Z",
"updated_at": "2024-11-25T07:52:07.028Z"
},
"customer_shipping_address": {
"id": 80992,
"company_id": 3235,
"remote_id": "NOON-635268c1ec03c759ce6840232e6703fd",
"name": "Customer Name Surname",
"address": "Noon HQ,Boulevard Plaza - Downtown Dubai - Dubai - United Arab Emirates",
"phone": "",
"country_code": "AE",
"district": "Dubai",
"city": "Dubai",
"town": "Dubai",
"zipcode": "",
"created_at": "2024-11-25T07:52:07.035Z",
"updated_at": "2024-11-25T07:52:07.035Z"
},
"shipping_provider": {
"name": "Noon",
"is_formula": false,
"adapter": "noon"
}
}
},
"error_code": 0,
"message": ""
}
Once you are ready to send your products, you need to start with creating package information with the related items by this service. Quantity-based packaging is not allowed; all quantities for an order item must be included in a single package.
POST https://api.hepsiglobal.com/api/v1/packages
| Parameter | Type | Required | Description |
|---|---|---|---|
order_id |
int | Yes | Order ID on HepsiGlobal System |
total_deci |
decimal | Yes | Total volume of the package in decimal (e.g., 1.0) |
items |
array | Yes | Order items and quantities |
items.order_item_id |
int | Yes | Order Item ID in HepsiGlobal System |
items.quantity |
int | Yes | Order Item Quantity |
items.total_deci |
decimal | Yes | Total volume of the item in decimal (e.g., 1.0) |
invoice |
object | No (*) | Invoice details (Required for Turkish merchants) |
invoice.invoice_pdf |
string | Dep. | Invoice PDF in Base64 format (Required if invoice_link is not provided) |
invoice.invoice_link |
string | Dep. | Invoice File Link |
invoice.invoice_date |
string | Yes (*) | Invoice Date |
invoice.invoice_number |
string | Yes (*) | Invoice Number |
tracking |
object | Dep. | If the tracking is sent later, you need to provide tracking information using 'Fulfill Package (for self-shipping sellers)'. |
tracking.tracking_pdf |
string | Yes | Tracking PDF Link (Required if base64_file is not provided) |
tracking.tracking_barcode |
string | Yes | Tracking barcode |
tracking.base64_file |
string | No | Base64 encoded tracking file (Required if tracking_pdf is not provided) |
tracking.tracking_link |
string | Yes | Public tracking link to track the package |
tracking.provider |
string | Yes | Shipping provider (e.g., "DHL") |
Package Invoice (for Turkish merchants)
curl --location
--request POST 'https://api.hepsiglobal.com/api/v1/packages/invoice/{*}' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"invoice_link":"https://*.pdf",
"invoice_date":"2021-12-29",
"invoice_number":"18244124758"
}'
Response:
{
"data": {
"invoice_pdf": null,
"invoice_link": "https://*.pdf",
"invoice_date": "2021-12-29",
"invoice_number": "18244124758"
},
"error_code": 0,
"message": ""
}
The invoice_link, invoice_date and invoice_number fields are mandatory only for Turkish merchants. Non-Turkish merchants can ignore these fields.
POST https://api.hepsiglobal.com/api/v1/packages/invoice/{*}
| Parameter | Type | Required | Description |
|---|---|---|---|
invoice_pdf |
string | Dep. | Invoice PDF in Base64 format (Required if invoice_link is not provided) |
invoice_link |
string | Dep. | Invoice File Link |
invoice_date |
string | Yes | Invoice Date |
invoice_number |
string | Yes | Invoice Number |
Cancel Package
curl --location
--request GET 'https://api.hepsiglobal.com/api/v1/packages/cancel/{id}' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw ''
Response:
{
"data":true,
"error_code":0,
"message":""
}
You may cancel package with this endpoint by package id. A package cannot be cancelled if its tracking record indicates a delivery state of 'in_transit', 'delivered', 'exception', or 'canceled'.
GET https://api.hepsiglobal.com/api/v1/packages/cancel/{id}
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | int | Yes | Package ID in HepsiGlobal System |
Get Package Info
curl --location
--request GET 'https://api.hepsiglobal.com/api/v1/packages/{id}' \
--header 'Authorization: Bearer {token}' \
--data-raw ''
Response:
{
"data": {
"id": 7559,
"company_id": 3235,
"order_id": 35624,
"remote_id": "remote_package_1",
"proforma_url": "https://*.pdf",
"marketplace_package_id": "1234",
"total_deci": 4,
"status": "packaged",
"invoice_link": "https://*.pdf",
"invoice_number": "18244124758",
"invoice_date": "2025-01-01T00:00:00Z",
"tracking": [
{
"id": 30106,
"package_id": 7559,
"company_id": 3235,
"tracking_barcode": "62750013577924",
"tracking_link": "https://*.com/tracking/*?lang=en",
"tracking_pdf": "https://*.pdf",
"label_image_url": "https://*.jpg",
"tracking_provider": "hepsijet",
"provider": "hepsijet",
"origin_country": "TR",
"destination_country": "AE",
"is_default": false,
"delivery_info": null,
"delivery_info_provider": null,
"is_tracking": true,
"delivery_state": "pending",
"state_detail": null,
"marketplace_delivery_state": "",
"created_at": "2025-01-02T10:19:05.196Z",
"updated_at": "2025-01-09T12:30:20.945Z",
"deleted_at": null,
"customs_declaration_id": "",
"customs_declaration_date": null,
"is_first_mile": true,
"undelivered_reason": null
},
{
"id": 30105,
"package_id": 7559,
"company_id": 3235,
"tracking_barcode": "62750013577924",
"tracking_link": "https://*.com/tracking/*?lang=en",
"tracking_pdf": "https://*.pdf",
"label_image_url": "https://*.jpg",
"tracking_provider": "noon",
"provider": "noon",
"origin_country": "TR",
"destination_country": "AE",
"is_default": true,
"delivery_info": null,
"delivery_info_provider": null,
"is_tracking": false,
"delivery_state": "pending",
"state_detail": null,
"marketplace_delivery_state": "delivered",
"created_at": "2025-01-02T10:19:03.637Z",
"updated_at": "2025-01-02T11:30:06Z",
"deleted_at": null,
"customs_declaration_id": "",
"customs_declaration_date": null,
"is_first_mile": false,
"undelivered_reason": null
}
],
"esd": "2025-12-02T13:53:00Z",
"created_at": "2025-01-29T12:06:34.329142002Z",
"updated_at": "2025-01-29T12:06:36.146Z",
"deleted_at": null,
"package_items": [
{
"id": 8734,
"company_id": 3235,
"package_id": 7559,
"order_item_id": 13440,
"quantity": 1,
"total_deci": 2,
"created_at": "2025-01-02T10:19:03.084Z",
"updated_at": "2025-01-02T10:19:03.084Z",
"deleted_at": null,
"order_item": {
"id": 13440,
"order_id": 35624,
"company_id": 3235,
"variant_id": 103487,
"marketplace_variant_history_id": 68175,
"marketplace_order_id": "3455531274",
"marketplace_sku": "HBV00000EA6RW",
"currency": "TRY",
"base_currency": "USD",
"unit_base_price": "7.2",
"total_base_price": "7.2",
"unit_commission_fee": "2.52",
"unit_commission_vat_fee": "0.5",
"total_commission_fee": "2.52",
"total_commission_vat_fee": "0.5",
"rate": "34",
"marketplace_rate": 120,
"unit_marketplace_fee": "1.2",
"total_marketplace_fee": "1.2",
"customs_currency": "USD",
"unit_customs_fee": "2.88",
"total_customs_fee": "2.88",
"unit_otv_fee": "0.72",
"total_otv_fee": "0.72",
"unit_tax_label_fee": "0.16",
"total_tax_label_fee": "0.16",
"tax_label_rate": "1.05",
"unit_original_tax_label_fee": "0.15",
"total_original_tax_label_fee": "0.15",
"original_tax_label_fee_currency": "EUR",
"shipping_currency": "USD",
"shipping_rate": "1",
"unit_logistic_fee": "11",
"total_logistic_fee": "11",
"unit_service_fee": "3.2",
"total_service_fee": "3.2",
"unit_buffer_fee": "0",
"total_buffer_fee": "0",
"unit_price": "968.32",
"total_price": "968.32",
"tax_fee": "0",
"discount": "0",
"grand_total": "968.32",
"original_grand_total": "28.48",
"original_currency": "USD",
"quantity": 1,
"quantity_cancel": 0,
"quantity_refund": 0,
"marketplace_commission_fee": "0",
"marketplace_base_commission_fee": "0",
"unit_marketplace_service_fee": "0.25",
"unit_marketplace_service_vat_fee": "0.05",
"total_marketplace_service_fee": "0.25",
"total_marketplace_service_vat_fee": "0.05",
"total_base_price_after_discount": "7.2",
"status": "open",
"cancellation_reason": "",
"cancellation_date": null,
"cancellation_user_id": null,
"cancellation_user_type": null,
"cancellation_user_name": null,
"marketplace_status": "Open",
"merchant_status": "",
"due_date": "2025-12-02T13:53:00Z",
"created_at": "2024-12-11T11:00:03.579Z",
"updated_at": "2024-12-11T11:00:03.579Z",
"deleted_at": null,
"subject_to_penalty": true
}
}
],
"order": {
"id": 35624,
"company_id": 3235,
"marketplace_id": 12,
"marketplace_order_id": "mporder12345",
"marketplace_bank_order_id": "mporder12345",
"customer_id": 32354,
"customer_identity_number": "1111111111",
"customer_full_name": "Customer Name Surname",
"customer_shipping_address_id": 80992,
"customer_billing_address_id": 80991,
"customer_tax_number": "1111111111",
"currency": "USD",
"base_currency": "USD",
"base_price_total": "24",
"commission_fee_total": "26.4",
"commission_vat_fee_total": "5.28",
"marketplace_fee_total": "0",
"customs_currency": "USD",
"customs_fee_total": "0",
"otv_fee_total": "0",
"tax_label_fee_total": "0",
"original_tax_label_fee_total": "0",
"original_tax_label_fee_currency": "USD",
"shipping_currency": "USD",
"logistic_fee_total": "0",
"service_fee_total": "0",
"buffer_fee_total": "0",
"total_price": "55.68",
"tax_total": "0",
"discount_total": "45.76",
"grand_total": "55.68",
"original_grand_total": "55.68",
"original_currency": "USD",
"marketplace_commission_fee_total": "0",
"marketplace_base_commission_fee_total": "0",
"marketplace_service_fee_total": "0",
"marketplace_service_vat_fee_total": "0",
"order_date": "2025-01-02T10:00:12Z",
"created_at": "2025-01-02T10:18:45.002Z",
"updated_at": "2025-01-02T10:30:05.626Z",
"deleted_at": null,
"customer_pay_uuid": "b7ca0eb078a9c4c0c3346a38fdb72ce9",
"customer_address_key": "4e8598f0f9ba5e6b372e38d5ee13f39e",
"shipping_provider_id": 15,
"marketplace_channel_id": 18,
"company": {
"id": 3235,
"name": "Test A.Ş.",
"is_active": true,
"adapter_package": "api",
"from_currency": "USD",
"native_language": "TR",
"base_country": "TR",
"billing_address_id": 1935,
"delivery_return_address_id": 1936,
"company_contact_id": 922,
"company_info_id": 922,
"bank_account_info_id": 914,
"hepsijet_merchant_id": 31,
"created_at": "2023-11-29T08:33:03.019Z",
"updated_at": "2025-01-20T13:33:29.885Z",
"deleted_at": null,
"created_at_hepsijet": true,
"use_hepsijet_for_first_mile": false,
"first_mile_ignore_country": null,
"is_translate": false,
"retrieves_label_without_invoice": true,
"activation_date": "2025-01-20T13:33:29.885Z",
"deactivation_date": null,
"use_hb_delivery_for_first_mile": true
},
"customer_billing_address": {
"id": 80991,
"company_id": 3235,
"remote_id": "NOON-4e8598f0f9ba5e6b372e38d5ee13f39e",
"name": "Customer Name Surname",
"address": "NoonHQ, Boulevard Plaza - Downtown Dubai - Dubai - United Arab Emirates",
"phone": "",
"country_code": "AE",
"district": "Dubai",
"city": "Dubai",
"town": "Dubai",
"zipcode": "",
"created_at": "2024-11-25T07:52:07.028Z",
"updated_at": "2024-11-25T07:52:07.028Z"
},
"customer_shipping_address": {
"id": 80992,
"company_id": 3235,
"remote_id": "NOON-635268c1ec03c759ce6840232e6703fd",
"name": "Customer Name Surname",
"address": "Noon HQ,Boulevard Plaza - Downtown Dubai - Dubai - United Arab Emirates",
"phone": "",
"country_code": "AE",
"district": "Dubai",
"city": "Dubai",
"town": "Dubai",
"zipcode": "",
"created_at": "2024-11-25T07:52:07.035Z",
"updated_at": "2024-11-25T07:52:07.035Z"
},
"shipping_provider": {
"name": "Noon",
"is_formula": false,
"adapter": "noon"
}
}
},
"error_code": 0,
"message": ""
}
This endpoint retrieves package details.
GET https://api.hepsiglobal.com/api/v1/packages/{id}
Fulfill Package (for self-shipping sellers)
curl --location
--request POST 'https://api.hepsiglobal.com/api/v1/packages/fulfill/{id}' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"tracking_pdf":"http://merchant.zoodmall.com/index.php?m=parcellabel&a=downloadpttlabel&trackNumber=UZ107142235TR",
"tracking_barcode":"12312412412",
"base64_file":null,
"tracking_link":"http://www.ptt.com",
"tracking_provider":"pts", // Will be deprecated
"provider":"pts"
}'
Response:
{
"data": {
"id": 13,
"package_id": 5,
"company_id": 2,
"tracking_barcode": "12312412412",
"tracking_link": "http://www.ptt.com",
"tracking_pdf": "https://storage.googleapis.com/global-api/tracking/pdf/2/20210226/0d2d5907-bfb0-44fe-bb2b-01bc1ed339ec.pdf",
"tracking_provider": "pts", // Will be deprecated
"provider": "pts",
"origin_country": null,
"destination_country": null,
"is_default": true,
"delivery_info": null,
"delivery_info_provider": null,
"is_tracking": true,
"delivery_state": null,
"marketplace_delivery_state": null,
"created_at": "2021-02-26T12:47:32.359+03:00",
"updated_at": "2021-02-26T12:47:34.695126074+03:00",
"deleted_at": null,
"company": null,
"package": null
},
"error_code": 0,
"message": ""
}
Self-shipping sellers that do not provide tracking data while performing packaging via the 'Create Package (for self-shipping sellers)' service may subsequently submit the missing tracking data through the 'Fulfill Package (for self-shipping sellers)' service.
POST https://api.hepsiglobal.com/api/v1/packages/fulfill/{id}
| Parameter | Type | Required | Description |
|---|---|---|---|
tracking.tracking_pdf |
string | Yes | Tracking PDF Link (Required if base64_file is not provided) |
tracking.tracking_barcode |
string | Yes | Tracking barcode |
tracking.base64_file |
string | No | Base64 encoded tracking file (Required if tracking_pdf is not provided) |
tracking.tracking_link |
string | Yes | Public tracking link to track the package |
tracking.provider |
string | Yes | Shipping provider (e.g., "DHL") |
Package Tracking
Search Tracking
curl --location
--request POST 'https://api.hepsiglobal.com/api/v1/tracking/search' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"start": 0,
"length": 10,
"search": {
"package_id": null,
"id": null
}
}'
Response:
{
"data": {
"data": [
{
"id": 30106,
"package_id": 7507,
"company_id": 3235,
"tracking_barcode": "62750013577924",
"tracking_link": "https://*.com/tracking/*?lang=en",
"tracking_pdf": "https://*.pdf",
"label_image_url": "https://*.jpg",
"tracking_provider": "hepsijet",
"provider": "hepsijet",
"origin_country": "TR",
"destination_country": "AE",
"is_default": false,
"delivery_info": null,
"delivery_info_provider": null,
"is_tracking": true,
"delivery_state": "pending",
"state_detail": null,
"marketplace_delivery_state": "",
"created_at": "2025-01-02T10:19:05.196Z",
"updated_at": "2025-01-09T12:30:20.945Z",
"deleted_at": null,
"customs_declaration_id": "",
"customs_declaration_date": null,
"is_first_mile": true,
"undelivered_reason": null
},
{
"id": 30105,
"package_id": 7507,
"company_id": 3235,
"tracking_barcode": "62750013577924",
"tracking_link": "https://*.com/tracking/*?lang=en",
"tracking_pdf": "https://*.pdf",
"label_image_url": "https://*.jpg",
"tracking_provider": "noon",
"provider": "noon",
"origin_country": "TR",
"destination_country": "AE",
"is_default": true,
"delivery_info": null,
"delivery_info_provider": null,
"is_tracking": false,
"delivery_state": "delivered",
"state_detail": null,
"marketplace_delivery_state": "delivered",
"created_at": "2025-01-02T10:19:03.637Z",
"updated_at": "2025-01-02T11:30:06Z",
"deleted_at": null,
"customs_declaration_id": "",
"customs_declaration_date": null,
"is_first_mile": false,
"undelivered_reason": null
}
],
"count": 2,
"search": {
"package_id": null,
"id": null
},
"start": 0,
"length": 10
},
"error_code": 0,
"message": ""
}
This endpoint retrieves all your package tracking depending on the filters you apply.
POST https://api.hepsiglobal.com/api/v1/tracking/search
| Parameter | Type | Description |
|---|---|---|
| start | int | Offset of the search results. |
| length | int | Requested result count in response. Default 100, maximum 1000. |
| search.id | int | Package Tracking ID in HepsiGlobal system. |
| search.package_id | int | Package ID in HepsiGlobal system. |
Create / Update Tracking
curl --location
--request POST 'https://api.hepsiglobal.com/api/v1/tracking' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"package_id": 5,
"company_id": null,
"tracking_pdf": "http://merchant.zoodmall.com/index.php?m=parcellabel&a=example_pdfTR",
"tracking_barcode": "12312412412",
"base64_file": null,
"tracking_link": "http://www.ptt.com",
"tracking_provider": "pts", // Will be deprecated
"provider": "pts",
"is_default": false,
"is_tracking": null,
"delivery_info": null,
"delivery_info_provider":null,
"delivery_state": null
}'
Response:
{
"data": {
"id": 6,
"package_id": 5,
"company_id": 2,
"tracking_barcode": "12312412412",
"tracking_link": "http://www.ptt.com",
"tracking_pdf": "https://storage.googleapis.com/global-api/tracking/pdf/2/20210218/example.pdf",
"tracking_provider": "pts", // Will be deprecated
"provider": "pts",
"origin_country": null,
"destination_country": null,
"is_default": false,
"delivery_info": null,
"delivery_info_provider": null,
"is_tracking": null,
"delivery_state": null,
"marketplace_delivery_state": null,
"created_at": "2021-02-18T14:57:19.053532209+03:00",
"updated_at": "2021-02-18T14:57:19.053532659+03:00",
"deleted_at": null,
"company": null,
"package": null
},
"error_code": 0,
"message": ""
}
This endpoint creates tracking for package.
POST https://api.hepsiglobal.com/api/v1/tracking/create
| Parameter | Type | Required | Description |
|---|---|---|---|
| package_id | int | Yes | Package id |
| base64_file | string | Dep. | (Required if tracking_pdf not given) tracking pdf base64 |
| tracking_pdf | string | Dep. | (Required if base64_file not given) tracking pdf link |
| tracking_barcode | string | Yes | tracking barcode |
| tracking_link | string | Yes | your tracking link |
| tracking_provider | string | Yes | tracking provider (Will be deprecated) |
| provider | string | No | tracking provider |
| is_default | bool | - | package default tracking |
Tracking Info
curl --location
--request GET 'https://api.hepsiglobal.com/api/v1/tracking/{id}' \
--header 'Authorization: Bearer {token}' \
--data-raw ''
Response:
{
"data": {
"id": 30105,
"package_id": 7507,
"company_id": 3235,
"tracking_barcode": "62750013577924",
"tracking_link": "https://*.com/tracking/*?lang=en",
"tracking_pdf": "https://*.pdf",
"label_image_url": "https://*.jpg",
"tracking_provider": "noon",
"provider": "noon",
"origin_country": "TR",
"destination_country": "AE",
"is_default": true,
"delivery_info": null,
"delivery_info_provider": null,
"is_tracking": false,
"delivery_state": "delivered",
"state_detail": null,
"marketplace_delivery_state": "delivered",
"created_at": "2025-01-02T10:19:03.637Z",
"updated_at": "2025-01-02T11:30:06Z",
"deleted_at": null,
"customs_declaration_id": "",
"customs_declaration_date": null,
"is_first_mile": false,
"undelivered_reason": null
},
"error_code": 0,
"message": ""
}
This endpoint get your tracking info.
GET https://api.hepsiglobal.com/api/v1/tracking/{id}
Transactions
Transaction List
curl --location
--request POST 'https://api.hepsiglobal.com/api/v1/transactions/search' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"start":0,
"length":10,
"search":{
"id":null,
"company_id":null,
"method":null,
"status":null
}
}'
Response:
{
"data":{
"data":[
{
"id":"6fd0f1e6-001f-487b-9c5f-5d457ea3f565",
"company_id":2,
"file_name":"requests/2/20210208/brand_update/113724d9-7290-48d1-9dd2-fc9ed80a03db.json",
"method":"brand_update",
"status":"open",
"error_code":null,
"error_msg":null,
"created_at":"2021-02-08T17:15:12.811+03:00",
"updated_at":"2021-02-08T17:15:12.811+03:00"
},
{
"id":"759bddce-c8a9-440c-aaaa-79b96326279b",
"company_id":2,
"file_name":"requests/2/20210208/brand_create/9f4ac725-627f-4195-b5a1-602ccc73b971.json",
"method":"brand_create",
"status":"open",
"error_code":null,
"error_msg":null,
"created_at":"2021-02-08T17:15:04.435+03:00",
"updated_at":"2021-02-08T17:15:04.435+03:00"
},
{
"id":"42e91703-7380-4276-9118-41588a561b2d",
"company_id":2,
"file_name":"requests/2/20210208/attribute_value_update/3c385b0d-f727-45ea-8889-173cf65a8eaf.json",
"method":"attribute_value_update",
"status":"open",
"error_code":null,
"error_msg":null,
"created_at":"2021-02-08T17:14:38.574+03:00",
"updated_at":"2021-02-08T17:14:38.574+03:00"
},
{
"id":"df2793b7-f36e-457b-a978-fa89b4d09568",
"company_id":2,
"file_name":"requests/2/20210208/attribute_value_create/8f68ba07-083f-4bc7-ac7c-66dcd0d75045.json",
"method":"attribute_value_create",
"status":"open",
"error_code":null,
"error_msg":null,
"created_at":"2021-02-08T17:14:28.053+03:00",
"updated_at":"2021-02-08T17:14:28.053+03:00"
},
{
"id":"d3f473b9-6ff4-4094-ac77-797bb7476a42",
"company_id":2,
"file_name":"requests/2/20210208/attribute_update/18ab697e-eb13-4d28-9640-bea2e7b364bb.json",
"method":"attribute_update",
"status":"open",
"error_code":null,
"error_msg":null,
"created_at":"2021-02-08T17:14:09.695+03:00",
"updated_at":"2021-02-08T17:14:09.695+03:00"
},
{
"id":"30a6766a-e890-4347-8ec8-0a6421a86d20",
"company_id":2,
"file_name":"requests/2/20210208/attribute_create/0d6183fb-4a9a-4bb0-9ce9-f78866b426d0.json",
"method":"attribute_create",
"status":"open",
"error_code":null,
"error_msg":null,
"created_at":"2021-02-08T17:13:58.753+03:00",
"updated_at":"2021-02-08T17:13:58.753+03:00"
},
{
"id":"a8990882-5d45-4eaf-9d84-1c0c1310e3da",
"company_id":2,
"file_name":"requests/2/20210208/category_update/0b4c390e-fa87-4519-9c32-c34e2818b67f.json",
"method":"category_update",
"status":"open",
"error_code":null,
"error_msg":null,
"created_at":"2021-02-08T17:13:20.259+03:00",
"updated_at":"2021-02-08T17:13:20.259+03:00"
},
{
"id":"31c1eba2-1054-4595-ad0b-873fe268a6d5",
"company_id":2,
"file_name":"requests/2/20210208/category_create/ee1e799c-db26-4e25-a849-87558f86850e.json",
"method":"category_create",
"status":"open",
"error_code":null,
"error_msg":null,
"created_at":"2021-02-08T17:13:05.955+03:00",
"updated_at":"2021-02-08T17:13:05.955+03:00"
},
{
"id":"191c0646-7cf5-450d-97cb-d1fe0dd7973d",
"company_id":2,
"file_name":"requests/2/20210208/variants_stock/c5ff3a66-b09e-4329-a8da-af9100c58a2d.json",
"method":"variant_stock_update",
"status":"open",
"error_code":null,
"error_msg":null,
"created_at":"2021-02-08T17:11:48.012+03:00",
"updated_at":"2021-02-08T17:11:48.012+03:00"
},
{
"id":"245f2336-5c88-4897-af49-f48169be25ab",
"company_id":2,
"file_name":"requests/2/20210208/variants_price/e5dc197b-f081-4d3e-bc9b-8e63c46e04f3.json",
"method":"variant_price_update",
"status":"open",
"error_code":null,
"error_msg":null,
"created_at":"2021-02-08T17:09:13.243+03:00",
"updated_at":"2021-02-08T17:09:13.243+03:00"
}
],
"count":95,
"search":{
"id":null,
"company_id":null,
"method":null,
"status":null
},
"start":0,
"length":10
},
"error_code":0,
"message":""
}
This endpoint retrieves all transactions depending on the filters you apply.
POST https://api.hepsiglobal.com/api/v1/transactions/search
| Parameter | Type | Description |
|---|---|---|
| start | int | Offset of the search results. |
| length | int | Required result count in response. Default 100, maximum 1000 |
| search.id | int | If there is a specific id you would like to search. |
| search.method | string | If there is a specific method you would like to search. |
| search.status | string | If there is a specific status you would like to search. |
*None of the fields are required.
Transaction Details
curl --location
--request GET 'https://api.hepsiglobal.com/api/v1/transactions/1dd1db15-4a26-4781-8a39-773f1fcae103' \
--header 'Authorization: Bearer {token}'
Response:
{
"data":{
"id":"1dd1db15-4a26-4781-8a39-773f1fcae103",
"company_id":2,
"file_name":"requests/20210107/2/category_create/143d5856-0d1b-4e7c-977e-ac0dda940350.json",
"method":"category_create",
"status":"open",
"error_code":null,
"error_msg":null,
"created_at":"2021-01-07T14:28:20.667+03:00",
"updated_at":"2021-01-07T14:28:20.667+03:00"
},
"error_code":0,
"message":""
}
This endpoint retrieves transaction details.
GET https://api.hepsiglobal.com/api/v1/transactions/1dd1db15-4a26-4781-8a39-773f1fcae103
Deliveries (for self-shipping sellers)
Get Delivery Info
curl --location
--request GET 'https://api.hepsiglobal.com/api/v1/deliveries/1/' \
--header 'Authorization: Bearer {token}' \
--data-raw ''
Response:
{
"id":28,
"package_id":1,
"company_id":2,
"tracking_barcode":"BARCODE-01",
"tracking_link":"http://test.com",
"tracking_pdf":"http://test.com/test.pdf",
"tracking_provider":"custom", // Will be deprecated
"provider":"custom",
"origin_country": null,
"destination_country": null,
"is_default":true,
"delivery_info":[
{
"datetime":"",
"status":"in_transtit",
"detail":"",
"location":"germany"
},
{
"datetime":"",
"status":"in_transtit",
"detail":"",
"location":"turkey"
}
],
"delivery_info_provider":null,
"is_tracking":false,
"delivery_state":"delivered",
"marketplace_delivery_state":"",
"created_at":"2021-05-11T10:31:33.123+03:00",
"updated_at":"2021-05-11T11:15:44.228+03:00",
"deleted_at":null
}
Update Event Info
curl --location
--request PATCH 'https://api.hepsiglobal.com/api/v1/deliveries/1/event' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"delivery_info": {
"datetime": "2021-01-01 00:00:00",
"status": "delivered",
"detail": "the shipment has been successfully delivered",
"location": "turkey"
}
}'
Response:
{
"id": 28,
"package_id": 1,
"company_id": 2,
"tracking_barcode": "BARCODE-01",
"tracking_link": "http://test.com",
"tracking_pdf": "http://test.com/test.pdf",
"tracking_provider": "custom", // Will be deprecated
"provider": "custom",
"origin_country": null,
"destination_country": null,
"is_default": true,
"delivery_info": [
{
"datetime": "",
"status": "in_transtit",
"detail": "",
"location": "germany"
},
{
"datetime": "",
"status": "in_transtit",
"detail": "",
"location": "turkey"
},
{
"datetime": "2021:01:01 00:00:00",
"status": "delivered",
"detail": "the shipment has been successfully delivered",
"location": "turkey"
}
],
"delivery_info_provider": null,
"is_tracking": false,
"delivery_state": "delivered",
"marketplace_delivery_state": "",
"created_at": "2021-05-11T10:31:33.123+03:00",
"updated_at": "2021-05-11T11:15:44.228+03:00",
"deleted_at": null
}
PATCH https://api.hepsiglobal.com/api/v1/deliveries/1/event
| Parameter | Type | Required | Description |
|---|---|---|---|
| delivery_info | DeliveryInfo | Yes | DeliveryInfo Model |
DeliveryInfo Model
| Parameter | Type | Required | Description |
|---|---|---|---|
| datetime | Datetime | Dep. | Example: 2021-01-01 00:00:00 |
| status | string | Dep. | Example: delivered |
| detail | string | Dep. | Example: the shipment has been successfully delivered |
| location | string | Dep. | Example: Turkey |
Update Status
curl --location
--request PATCH 'https://api.hepsiglobal.com/api/v1/deliveries/1/status' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"status" : "in_transit"
}'
Response:
{
"id": 28,
"package_id": 1,
"company_id": 2,
"tracking_barcode": "BARCODE-01",
"tracking_link": "http://test.com/",
"tracking_pdf": "https://test.com/test.pdf",
"tracking_provider": "custom", // Will be deprecated
"provider": "custom",
"origin_country": null,
"destination_country": null,
"is_default": true,
"delivery_info": null,
"delivery_info_provider": null,
"is_tracking": false,
"delivery_state": "in_transit",
"marketplace_delivery_state": "",
"created_at": "2021-05-11T10:31:33.123+03:00",
"updated_at": "2021-05-11T10:56:45.249+03:00",
"deleted_at": null,
}
PATCH https://api.hepsiglobal.com/api/v1/deliveries/1/status
| Parameter | Type | Required | Description |
|---|---|---|---|
| status | enum | Yes | (in_transit,delivered,exception) |
Claims
Search Claims
curl --location
--request POST 'https://api.hepsiglobal.com/api/v1/claims/search' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"start":0,
"length":10,
"search":{
"id": null,
"marketplace_id": null,
"status": null,
"order_id": null,
"marketplace_order_id": null,
"marketplace_customer_name": null,
"marketplace_type": null,
}
}'
Response:
{
"data": {
"data": [
{
"id": 141103,
"company_id": 3235,
"marketplace_id": 10,
"ticket_id": null,
"quantity": 1,
"status": "approved",
"order_id": 33907,
"explanation": "Other",
"explanation_en": "Other",
"reason": "OTHER",
"reason_en": "OTHER",
"marketplace_number": "110-MTVESMIXGOY",
"marketplace_type": "Return",
"marketplace_order_id": "1222-CE-TEST-35453",
"marketplace_status": "IN_PROGRESS",
"marketplace_customer_id": "af385c047a7e982c811db999a7ec15f3",
"marketplace_customer_name": "Berke Bağıröz",
"marketplace_claim_date": "2024-07-18T08:14:45.661Z",
"report_by_customer_images": "",
"report_by_merchant_images": "",
"delivery_info": null,
"reject_reason": "",
"reject_note": "",
"reject_images": [],
"reject_by_admin_note": "",
"sap_sync": true,
"created_at": "2024-07-18T08:16:51.567Z",
"updated_at": "2024-07-18T09:00:05.994Z",
"deleted_at": null,
"company": {
"id": 3235,
"name": "kivircik_test",
"is_active": true,
"adapter_package": "api",
"from_currency": "USD",
"native_language": "TR",
"base_country": "TR",
"billing_address_id": 1935,
"delivery_return_address_id": 1936,
"company_contact_id": 922,
"company_info_id": 922,
"bank_account_info_id": 914,
"hepsijet_merchant_id": 31,
"created_at": "2023-11-29T08:33:03.019Z",
"updated_at": "2024-12-19T12:20:54.032Z",
"deleted_at": null,
"billing_address": null,
"delivery_return_address": null,
"delivery_return_addresses": null,
"company_contact": null,
"company_info": null,
"bank_account_info": null,
"hepsijet_merchants": null,
"company_marketplaces": null,
"company_tokens": null,
"company_configs": null,
"hepsijet_company_addresses": null,
"current_company_config": null,
"current_company_marketplaces": null,
"created_at_hepsijet": true,
"use_hepsijet_for_first_mile": true,
"first_mile_ignore_country": null,
"companies_tags": null,
"is_translate": false,
"retrieves_label_without_invoice": true,
"logo": "",
"activation_date": "2024-12-03T06:35:13.124Z",
"deactivation_date": null,
"is_one_click_merchant": true,
"one_click_type": 0,
"use_hb_delivery_for_first_mile": false
},
"claim_lines": [
{
"id": 1247,
"company_id": 3235,
"claim_id": 141103,
"variant_id": 235577,
"order_item_id": 11278,
"marketplace_line_item_id": "",
"marketplace_product_name": "Vestel Mix Go Green Blender",
"marketplace_listing_id": "",
"marketplace_sku": "MTVESMIXGOY",
"seller_sku": "MTVESMIXGOY",
"price": "0.949999988079071",
"currency": "USD",
"total_price": "0.949999988079071",
"total_currency": "USD",
"created_at": "2024-07-18T08:16:51.597Z",
"updated_at": "2024-07-18T08:16:51.597Z",
"deleted_at": null,
"claim": null,
"company": null,
"order_item": {
"id": 11278,
"order_id": 33907,
"company_id": 3235,
"variant_id": 235577,
"marketplace_variant_history_id": 42360,
"marketplace_order_id": "1222-CE-TEST-35453",
"marketplace_order_item_sap_number": "10",
"marketplace_order_item_id": "1222-CE-TEST-35453_MTVESMIXGOY",
"marketplace_sku": "MTVESMIXGOY",
"currency": "USD",
"base_currency": "USD",
"unit_base_price": "9.09",
"total_base_price": "9.09",
"unit_commission_fee": "4.55",
"unit_commission_vat_fee": "0.91",
"total_commission_fee": "4.55",
"total_commission_vat_fee": "0.91",
"rate": "1",
"marketplace_rate": 100,
"unit_marketplace_fee": "0",
"total_marketplace_fee": "0",
"customs_currency": "USD",
"unit_customs_fee": "0",
"total_customs_fee": "0",
"unit_otv_fee": "0",
"total_otv_fee": "0",
"unit_tax_label_fee": "0",
"total_tax_label_fee": "0",
"tax_label_rate": "0",
"unit_original_tax_label_fee": "0",
"total_original_tax_label_fee": "0",
"original_tax_label_fee_currency": "",
"shipping_currency": "USD",
"shipping_rate": "1",
"unit_logistic_fee": "8.14",
"total_logistic_fee": "8.14",
"unit_service_fee": "0",
"total_service_fee": "0",
"unit_buffer_fee": "0",
"total_buffer_fee": "0",
"unit_price": "22.69",
"total_price": "22.69",
"tax_fee": "0",
"discount": "13.6",
"grand_total": "22.69",
"original_grand_total": "22.69",
"original_currency": "USD",
"quantity": 1,
"quantity_cancel": 0,
"quantity_refund": 1,
"marketplace_commission_fee": "0",
"marketplace_base_commission_fee": "0",
"hb_new_price_calculation": true,
"unit_marketplace_service_fee": "0",
"unit_marketplace_service_vat_fee": "0",
"total_marketplace_service_fee": "0",
"total_marketplace_service_vat_fee": "0",
"total_base_price_after_discount": "9.09",
"status": "refund",
"cancellation_reason": "",
"cancellation_date": null,
"cancellation_user_id": null,
"cancellation_user_type": null,
"cancellation_user_name": null,
"marketplace_status": "RETURNED",
"merchant_status": "",
"due_date": "2024-07-19T22:00:00Z",
"created_at": "2024-07-17T11:47:58.109Z",
"updated_at": "2024-08-17T08:10:22.268Z",
"deleted_at": null,
"variant": null,
"order": null,
"package_items": null,
"marketplace_variant_history": null,
"esd_notification_sent": false,
"subject_to_penalty": true,
"locked": false,
"fin_product": "14.55",
"fin_cargo": "8.14",
"fin_custom": "0",
"company": null,
"order_item_campaigns": null,
"refund_date": "2024-07-18T08:17:57.83Z",
"currency_to_tl_rate": "0",
"currency_usd_to_tl_rate": "34",
"currency_eur_to_usd_rate": "0",
"is_weight_checked": null,
"hb_order_line_id": "6697af820c5fcf35d3c393e7",
"hb_warehouse_id": null
},
"variant": {
"id": 235577,
"company_id": 3235,
"product_id": 104187,
"supplier_id": null,
"remote_supplier_id": null,
"name": "Vestel Mix Go Green Blender",
"description": "Vestel Mix Go Green Blender<p>Vestel Mix Go Green Blender is a product that stands out with its compact design and functional features. You can prepare delicious and healthy recipes thanks to the blender, which is a candidate to be among the favorite parts of your kitchen.</p>",
"sku": "MTVESMIXGOY",
"extra_sku": "MTVESMIXGO1",
"barcode": "00MTVESMIXGOY",
"hs_code": "850940000013",
"gtin": "",
"default_image_url": "https://productimages.hepsiburada.net/s/8/500-500/9016877973554.jpg",
"extra_images": "https://storage.googleapis.com/global-api-qa/qa/media/3101/20240222/134a44bd-5580-4e7e-8500-2915fcd7033f.png,https://storage.googleapis.com/global-api-qa/qa/media/3340/20240227/9d0e9e15-6342-431d-9ee9-13b5be06af0a.jpg,https://storage.googleapis.com/global-api-qa/qa/media/3340/20240227/bc1c5fcc-37cc-4605-8430-1de0dfaf4be4.jpg",
"price": "24",
"retail_price": "26",
"old_price": null,
"currency": "USD",
"stock": 923,
"is_active": true,
"freight": 2,
"weight": 500,
"height": 0,
"width": 0,
"length": 0,
"created_at": "2023-11-29T08:39:18.72Z",
"updated_at": "2025-01-13T06:52:19.12Z",
"deleted_at": null,
"product": null,
"sync_sku": null,
"attribute_values": null,
"integration_attribute_values": null,
"supplier": null,
"variants_media": null,
"variant_translations": null,
"company": null,
"activation_date": "2024-12-25T08:23:11.474Z",
"deactivation_date": null,
"hb_listing_id": null,
"hb_buying_category_name": null,
"hb_buying_category_id": null,
"hb_buying_product_type": null,
"hb_definition_id": null,
"hb_definition_name": null,
"made_in": null,
"price_lock_reason": 0,
"commission_rate": "10",
"commission_vat_rate": "20"
},
"refunded_product_price": "0",
"refunded_shipping_price": "0",
"refunded_customs_price": "0"
}
],
"order": {
"id": 33907,
"company_id": 3235,
"marketplace_id": 10,
"marketplace_order_id": "1222-CE-TEST-35453",
"marketplace_bank_order_id": "1222-CE-TEST-35453",
"hb_order_number": "1609444508",
"is_sync": false,
"customer_id": 32237,
"customer_identity_number": "af385c047a7e982c811db999a7ec15f3",
"customer_full_name": "Berke Bağıröz",
"customer_shipping_address_id": 79394,
"customer_billing_address_id": 76415,
"customer_tax_number": "",
"gift_cert": null,
"currency": "USD",
"base_currency": "USD",
"base_price_total": "9.09",
"commission_fee_total": "4.55",
"commission_vat_fee_total": "0.91",
"marketplace_fee_total": "0",
"customs_currency": "USD",
"customs_fee_total": "0",
"otv_fee_total": "0",
"tax_label_fee_total": "0",
"original_tax_label_fee_total": "0",
"original_tax_label_fee_currency": "USD",
"shipping_currency": "USD",
"logistic_fee_total": "8.14",
"service_fee_total": "0",
"buffer_fee_total": "0",
"total_price": "22.69",
"tax_total": "0",
"discount_total": "13.6",
"grand_total": "22.69",
"original_grand_total": "22.69",
"original_currency": "USD",
"marketplace_commission_fee_total": "0",
"marketplace_base_commission_fee_total": "0",
"marketplace_service_fee_total": "0",
"marketplace_service_vat_fee_total": "0",
"new_notification": "open",
"sap_sync": true,
"order_date": "2024-07-17T08:44:35.601Z",
"created_at": "2024-07-17T11:47:58.101Z",
"updated_at": "2024-07-17T12:00:27.438Z",
"deleted_at": null,
"order_items": null,
"company": null,
"marketplace": null,
"customer": null,
"customer_billing_address": null,
"customer_shipping_address": null,
"packages": null,
"customer_pay_uuid": "588c1024756c5ff078b70d60a5a0e526",
"customer_address_key": "588c1024756c5ff078b70d60a5a0e526",
"shipping_provider_id": 1,
"shipping_provider": null,
"marketplace_channel_id": 4,
"marketplace_channel": null,
"marketplace_channel_order_id": "CE-TEST-35453",
"mega_merchant_id": 2,
"mega_merchant": null,
"is_one_click": true
},
"marketplace": {
"id": 2,
"name": "hepsiglobal",
"adapter": "hepsiglobal",
"image": null,
"is_active": true,
"created_at": "2023-07-12T12:40:46Z",
"updated_at": "2023-10-12T11:48:34.758Z",
"deleted_at": null,
"order_commission_rate": 110,
"has_channels": true,
"rate_cap": 125,
"has_mega_merchants": true,
"uses_buybox": true,
"is_reverse": 0
},
"claim_packages": [],
"updated_by_user": null,
"ticket": null,
"updated_by": 988,
"refund_date": "2024-07-18T08:17:57.83Z",
"hb_claim_number": "733961540"
}
],
"count": 355,
"search": {
"id": null,
"marketplace_id": null,
"status": null,
"order_id": null,
"marketplace_order_id": null,
"marketplace_customer_name": null,
"sort_by": null,
"order_by": null,
"marketplace_type": null
},
"start": 0,
"length": 10
},
"error_code": 0,
"message": ""
}
This endpoint retrieves all your claims depending on the filters you apply.
POST https://api.hepsiglobal.com/api/v1/claims/search
| Parameter | Type | Description |
|---|---|---|
| start | int | Offset of the search results. |
| length | int | Required result count in response. Default 100, maximum 1000. |
| search. id |
int | If there is a specific claim ID you would like to search. |
| search. marketplace_id |
string | If there is a specific marketplace id you would like to search. |
| search. status |
string | If there is a specific status you would like to search.(approved, rejected_request, waiting etc.) |
| search. order_id |
string | If there is a specific order id you would like to search. |
| search. marketplace_order_id |
string | If there is a specific marketplace order id you would like to search. |
| search. marketplace_customer_name |
string | If there is a specific customer name you would like to search. |
| search. marketplace_type |
string | If there is a specific marketplace type you would like to search. (Return, MissingPart, MissingInvoice etc.) |
*None of the fields are required.
Claim Get By Id
curl --location
--request GET 'https://api.hepsiglobal.com/api/v1/claims/:id' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw ''
Response:
{
"data": {
"data": [
{
"id": 1,
"company_id": 2,
"marketplace_id": 1,
"quantity": 1,
"status": "approved",
"order_id": 1,
"explanation": null,
"marketplace_number": ,
"marketplace_type": "return" ,
"marketplace_order_id": 1234512345,
"marketplace_status": "AwaitingAction",
"marketplace_customer_id": null,
"marketplace_customer_name": "cemre yasar",
"marketplace_claim_date":"2021-04-20T18:22:49Z",
"report_by_customer_images":null,
"report_by_merchant_images":null,
"delivery_info":[
{
"code":"",
"status":"",
"direction":"",
"createdDate":"0001-01-01T00:00:00Z"
}
],
"reject_reason": null,
"sap_sync":"1",
"created_at": "2021-05-20T08:33:20Z",
"updated_at":"2021-05-20T08:33:20Z",
"deleted_at": null,
"explanation_en": null,
"updated_by_id": null,
"updated_by": null,
"reason_en": null,
"reason": null
}
],
"count": 1,
"search": {
"id": null
},
"start": 0,
"length": 1
},
"error_code": 0,
"message": ""
}
This endpoint retrieves the specific claim depending on the ID that you would like to search.
GET https://api.hepsiglobal.com/api/v1/claims/:id
| Parameter | Type | Description |
|---|---|---|
| start | int | Offset of the search results. |
| length | int | Required result count in response. Default 100, maximum 1000. |
| search. id |
int | The specific claim ID you would like to search. |
*ID is required.
Claim Approve
curl --location
--request POST 'https://api.hepsiglobal.com/api/v1/claims/approve/:id' \
--header 'Authorization: Bearer {token}' \
--data-raw ''
Response:
{
"data":true,
"error_code":0,
"message":""
}
For the claim process of marketplace sellers;
If the claim control of the relevant marketplace seller is provided by Radium, the claim status is directly approved. If is not provided by Radium, it becomes an approved request to make it manually approvable.
POST https://api.hepsiglobal.com/api/v1/claims/approve/:id
Claim Reject
curl --location
--request POST 'https://api.hepsiglobal.com/api/v1/claims/reject/:id' \
--header 'Authorization: Bearer {token}' \
--data-raw '{
"reason": "WrongProduct"
}'
Response:
{
"data":true,
"error_code":0,
"message":""
}
For the claim process of marketplace sellers;
If the claim control of the relevant marketplace seller is provided by Radium, the claim status is directly rejected. If is not provided by Radium, it becomes a rejected request to make it manually rejectable.
POST https://api.hepsiglobal.com/api/v1/claims/reject/:id
Claim Reject Reason List
curl --location
--request POST 'https://api.hepsiglobal.com/api/v1/claims/reject-reason-list/:marketplace_adapter' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"start":0,
"length":10
}'
Response:
{
"data": {
"0": "BoxIsEmpty",
"1": "WrongProduct",
"2": "ProductIsDamaged",
"3": "NoSuchAccessory",
"4": "ItHasBeenSentWithOtherProducts",
"5": "ThereIsNoCargoReport",
"6": "CustomerReturnedWrongItem",
"7": "CustomerPackageIsNotInTheConditionISent",
"8": "ProductHasBeenUsed",
"9": "ProductIsNotInSellableCondition",
"10": "MissingInvoice",
"11": "SomePartsOrSomeAccessoriesOrSomePapersAreMissing"
},
"error_code": 0,
"message": ""
}
This endpoint retrieves all reject reason depending on the marketplace.
POST https://api.hepsiglobal.com/api/v1/claims/reject-reason-list/:marketplace_adapter
Tickets (for non-TR sellers making sales to TR)
Reply Tickets
curl --location 'https://api-qa.hepsiglobal.com/api/v1/tickets/123/reply' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {token}' \
--data-raw '{
"message": "test 1",
"files": null,
"file_urls": null
}'
Response:
{
"data": null,
"error_code": 0,
"message": ""
}
This endpoint is used to reply tickets.
POST https://api-qa.hepsiglobal.com/api/v1/tickets/:ticket_id/reply
| Parameter | Type | Required | Description |
|---|---|---|---|
| message | string | Yes | |
| files | array | - | Files in Base64 format. |
| files_urls | array | - | Files URL list. |
Search Tickets
curl --location 'https://api-qa.hepsiglobal.com/api/v1/tickets' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {token}' \
--data-raw '{
"start": 0,
"length": 10,
"search": {
"id": null,
"status": null,
"claim_id": null,
"marketplace_id": null
}
}'
Response:
{
"data": {
"data": [
{
"id": 536,
"company": null,
"company_id": 1,
"marketplace_id": 1,
"status": "DONE",
"created_at": "2022-09-15T14:25:54.095Z",
"updated_at": "2022-09-15T14:25:54.095Z",
"deleted_at": null,
"updated_by_user": null,
"updated_by": null,
"remote_id": "1000",
"type": "",
"sub_label": "",
"marketplace_updated_at": "2021-07-28T13:00:11.927Z",
"marketplace_created_at": "2021-07-26T13:05:29.896Z",
"orders": null,
"marketplace_state": "AutoClosed",
"products": {
"sku": "643689330282",
"name": "",
"imageUrl": "",
"stockCode": ""
},
"product_sku": "",
"product_name": "",
"product_image_url": "",
"product_stock_code": "643689330282",
"customer_id": "8ccccffa-3521-42a1-b8b7-1f83c11b5f98",
"customer_locale": "",
"customer_name": "",
"replies": null,
"merchant_id": "f149605f-9d8e-4c64-9251-7f28991b2769",
"merchant_name": "",
"refund_reason": "",
"subject_id": "1232fb094f3f076cf97b123e",
"subject_description": "Ürün Özellikleri",
"subject_description_en": "Product features",
"resolution_info": null,
"messages": [],
"marketplace_ticket_id": "1232fb094f3f076cf97b123e",
"order_number": "",
"line_item_id": "",
"last_content": "Sorunuz satıcı tarafından yanıtlanmamıştır. Başka bir satıcıya soru sorabilir veya Çözüm Merkezi üzerinden ilgili sorulara cevap bulabilirsiniz.",
"expire_date": "2022-09-28T13:00:11.927Z",
"schema_version": 0
}
],
"count": 1,
"search": {
"id": null,
"marketplace_id": null,
"status": null,
"claim_id": null
},
"start": 0,
"length": 10
},
"error_code": 0,
"message": ""
}
This endpoint retrieves all your tickets depending on the filters you apply.
POST https://api-qa.hepsiglobal.com/api/v1/tickets
| Parameter | Type | Description |
|---|---|---|
| start | int | Offset of the search results. |
| length | int | Required result count in response. Default 100, maximum 1000. |
| search. id |
int | If there is a specific ticket ID you would like to search. |
| search. status |
string | If there is a specific status you would like to search.(done, open, expired.) |
| search. claim_id |
int | If there is a specific claim id you would like to search. |
| search. marketplace_id |
int | If there is a specific marketplace id you would like to search. |
*None of the fields are required.
Create Ready Answers
curl --location 'https://api-qa.hepsiglobal.com/api/v1/tickets/ready-answers' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {token}' \
--data-raw '{
"title": "test 1",
"answer": "test 2"
}'
Response:
{
"data": {
"id": 1,
"company_id": 1,
"title": "test 1",
"answer": "test 2",
"created_at": "2023-06-16T12:36:57.345Z",
"updated_at": "2023-06-16T12:36:57.345Z",
"deleted_at": null
},
"error_code": 0,
"message": ""
}
This endpoint is used to create a ready answer.
POST https://api-qa.hepsiglobal.com/api/v1/tickets/ready-answers
| Parameter | Type | Required | Description |
|---|---|---|---|
| title | string | Yes | |
| answer | string | Yes |
Filter Ready Answers
curl --location 'https://api-qa.hepsiglobal.com/api/v1/tickets/ready-answers/search' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {token}' \
--data-raw '{
"start": 0,
"length": 10,
"search": {
"title": "test 1"
}}'
Response:
{
"data": {
"data": [
{
"id": 1,
"company_id": 1,
"title": "test 1",
"answer": "test 2",
"created_at": "2023-06-16T12:36:57.345Z",
"updated_at": "2023-06-16T12:36:57.345Z",
"deleted_at": null
}
],
"count": 1,
"search": {
"title": "test 1"
},
"start": 0,
"length": 10
},
"error_code": 0,
"message": ""
}
This endpoint is used to filter the generated ready answers.
POST https://api-qa.hepsiglobal.com/api/v1/tickets/ready-answers/search
| Parameter | Type | Description |
|---|---|---|
| start | int | Offset of the search results. |
| length | int | Required result count in response. Default 100, maximum 1000. |
| search. title |
string | If there is a specific title you would like to search. |
*None of the fields are required.
Delete Ready Answer
curl --location --request DELETE 'https://api-qa.hepsiglobal.com/api/v1/tickets/ready-answers/123' \
--header 'Authorization: Bearer {token}' \
--data-raw ''
Response:
{
"data": null,
"error_code": 0,
"message": ""
}
This endpoint is used to delete the generated ready answers.
DELETE https://api-qa.hepsiglobal.com/api/v1/tickets/ready-answers/:answer_id
Errors
| Error Code | Meaning |
|---|---|
| 400 | Bad Request -- Your request is invalid. |
| 401 | Unauthorized -- Your API key is wrong. |
| 403 | Forbidden -- The kitten requested is hidden for administrators only. |
| 404 | Not Found -- The specified kitten could not be found. |
| 405 | Method Not Allowed -- You tried to access a kitten with an invalid method. |
| 406 | Not Acceptable -- You requested a format that isn't json. |
| 410 | Gone -- The kitten requested has been removed from our servers. |
| 418 | I'm a teapot. |
| 429 | Too Many Requests -- You're requesting too many kittens! Slow down! |
| 500 | Internal Server Error -- We had a problem with our server. Try again later. |
| 503 | Service Unavailable -- We're temporarily offline for maintenance. Please try again later. |
ETGB
Search ETGB
curl -X GET "https://api.hepsiglobal.com/api/oneclick/etgb/search?trackingBarcode=ABC123&page=1&pageSize=50" \
-H "Accept: application/json"
Response:
{
"data": {
"data": [
{
"etgb_number": "ETGBOKAN14",
"etgb_date": "2023-07-17T00:00:00Z",
"tracking_barcode": "WWETA0002397196TE",
"tracking_provider": "wwe"
}
],
"pagination": {
"current_page": 1,
"per_page": 50,
"total": 1
}
},
"error_code": 0,
"message": ""
}
GET https://api.hepsiglobal.com/api/oneclick/etgb/search
This endpoint allows you to retrieve ETGB information based on a single identifier. You must provide one and only one of the following query parameters:
hbOrderNumber: The order number.trackingBarcode: The tracking barcode.hbPackageId: The package ID.
If more than one parameter is provided, the API will prioritize them in the following order:
1. trackingBarcode
2. hbOrderNumber
3. hbPackageId
Only the highest-priority parameter will be used for the query.
Query Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
hbOrderNumber |
string | optional | HB Order number |
trackingBarcode |
string | optional | Tracking barcode |
hbPackageId |
string | optional | Package ID |
page |
int | optional | Page number for pagination. Default is 1. |
pageSize |
int | optional | Number of items per page. Default is 50. |
⚠️ If multiple identifiers are provided, only one will be used according to the priority order listed above.
Notes:
- If
pageorpageSizeis not specified, the API will setpage=1andpageSize=50as default. - The
itemsarray will be empty if no records match the provided identifier.