Introduction
Beymen API Integration is a system that allows companies participating in the Beymen Marketplace platform to perform many operations such as product transfer, stock and price updates, and order transactions through Beymen API services.
Authentication
You can access your API user information, which you will use in the live environment, from the "Account Information - Integration Information" heading that opens when you click on your store name in the upper right corner of the partner portal.
You can access your API user information in the test environment from the "Account Information - Integration Information" heading that opens when you click on your store name in the upper right corner of the partner portal.
Beymen Partner Services performs user authentication using the Basic Authentication method. First, Authorization header should be created using "API Key" and "API Password" obtained from Partner Portal.
Authorization: Basic Base64(ApiKey:ApiPassword)
Http Status 401 is returned if there is no Authorization header in the requests or if an operation is performed with an invalid value.
curl "Api Endpoint Url" \
-H "Authorization: Base64(ApiKey:ApiPassword)"
{
"status": 401,
"traceId": "ee905b40-bfa3-4eb6-ac11-ebf49dccac2f",
"errors": {
"MicroservicesCommon.Exceptions.UnauthorizedException": [
"Request Header [authorization] not found"
]
}
}
| Http Statü | Açıklama |
|---|---|
| 401 | Unauthorized -- Authorization Header not found or invalid ApiKey ApiPassword. |
Product Integration
In this section, there is API documentation related to product management in Beymen.
Bulk Product Creation
This method enables the creation of bulk products in Beymen.
HTTP Request
TEST ENV POST https://stage-partner-api.beymen.com/batch/products
PROD ENV POST https://partner-api.beymen.com/batch/products
HTTP Response
{
"processId": "a218a046-08dc-476d-a1d6-5d463ea2e418"
}
Request Parameters
| Parameter | Type | Explanation |
|---|---|---|
| RequestBody | Json(List[CreateProduct]) | Request Body Payload required to create a product |
CreateProduct Değerleri
| Parameter | Required | Type | Explanation |
|---|---|---|---|
| name | yes | String | Product Name |
| barcode | yes | String | Product Barcode |
| modelCode | yes | String | Product Model Code |
| description | yes | String | Product Description |
| brandId | yes | String | Product Beymen Brand information |
| categoryId | yes | String | Product Beymen Category information |
| platformColor | yes | String | Product Beymen Color Information |
| size | yes | String | Product Beymen size information |
| gender | yes | String | Product Beymen Gender information |
| stockRequest | yes | StockRequest | Product Stock information |
| priceRequest | yes | PriceRequest | Product Price information |
| vatRate | yes | Integer | Product VAT information. Possible values (0,1,10,20) |
| images | yes | List[String] | Information about the product's image links. |
| desi | no | Double | Product Desi information |
| attributes | yes/no | List[Attribute] | Product Beymen Feature information category-based required attributes must be added when creating a product |
| merchantColorCode | no | String | Product Seller Color information(e.g. light pink) |
| stockCode | no | String | Stock code information of the seller |
Example product creation payload
[
{
"name": "Generic Concrete Mouse",
"barcode": "barcode1asd",
"modelCode": "modelCode1asd",
"description": "Ut consequuntur cum suscipit debitis accusantium rem quisquam quos quis. Velit nihil facere. Itaque eligendi molestiae repellendus quae quisquam consectetur laudantium earum. Omnis ullam perspiciatis laudantium rem vel sed ducimus consectetur. Libero quasi rerum dolores. Qui excepturi totam.",
"stockCode": "QQTAACD1",
"brandId": "8158",
"categoryId": "96826",
"merchantColorCode": "Bej",
"size": "416",
"platformColor": "2474",
"gender": "4392",
"desi": 1,
"stockRequest": {
"stock": {
"count": "787"
}
},
"priceRequest": {
"salesPrice": {
"value": "83.38",
"currency": "TRY"
},
"platformPrice": {
"value": "83.38",
"currency": "TRY"
}
},
"vatRate": "0",
"images": ["https://placeimg.com/640/480/city"],
"attributes": [
{
"attributeId": "228",
"attributeOptionValue": "44486"
},
{
"attributeId": "203",
"attributeOptionValue": "freetext attributelar icin herhangi bir deger girilebilir"
}
]
}
]
Check Bulk Product Creation Result
This method allows viewing the process results after mass product production at Beymen.
HTTP Request
TEST ENV GET https://stage-partner-api.beymen.com/batch/products/{process_id}
PROD ENV GET https://partner-api.beymen.com/batch/products/{process_id}
HTTP Response
[
{
"request": {
"name": "Generic Concrete Mouse",
"stockCode": "QQTAACD1",
"barcode": "barcode1asd",
"description": "Ut consequuntur cum suscipit debitis accusantium rem quisquam quos quis. Velit nihil facere. Itaque eligendi molestiae repellendus quae quisquam consectetur laudantium earum. Omnis ullam perspiciatis laudantium rem vel sed ducimus consectetur. Libero quasi rerum dolores. Qui excepturi totam.",
"brandId": "8158",
"categoryId": "96826",
"priceRequest": {
"salesPrice": {
"value": 83.38,
"currency": "TRY"
},
"platformPrice": {
"value": 83.38,
"currency": "TRY"
}
},
"stockRequest": {
"stock": {
"count": 787
}
},
"vatRate": 0,
"images": ["https://placeimg.com/640/480/city"],
"modelCode": "modelCode1asd",
"merchantColorCode": "Bej",
"size": "416",
"gender": "4392",
"platformColor": "2474",
"commission": 0,
"desi": 1,
"attributes": [
{
"attributeId": "228",
"attributeOptionValue": "44486"
},
{
"attributeId": "203",
"attributeOptionValue": "freetext attributelar icin herhangi bir deger girilebilir"
}
]
},
"productId": "e9e5261a-5be1-430d-9ee4-34e0ee7ddd92",
"isSuccess": true,
"processResult": "İşlem Başarılı"
}
]
Return Values
| Parameter | Type | Explanation |
|---|---|---|
| ResponseBody | Json(List[CreateProductResponse]) | Product creation result Values |
CreateProductResponse
| Parameter | Type | Explanation |
|---|---|---|
| request | CreateProduct | Information about the product that is being created |
| productId | String | Product ID of the created product |
| isSuccess | Boolean | Transaction Status |
| processResult | String | Validation information of the product to be created |
Bulk Product Update
This method provides batch product update in Beymen. In order to be able to update the product, the product ID must be used for each successfully created product. It creates an identity for the visual after each product is made. If there is no change in the image, you must update with these Ids while the product is being updated. If a new addition is desired, the images can be updated by adding the image path.
HTTP Request
TEST ENV POST https://stage-partner-api.beymen.com/batch/update/products
PROD ENV POST https://partner-api.beymen.com/batch/update/products
HTTP Response
{
"processId": "s418a046-08dc-476d-a1d6-5d463ea2e431"
}
Request Parameters
| Parameter | Type | Explanation |
|---|---|---|
| RequestBody | Json(List[CreateProduct]) | Request Body Payload required to update product |
UpdateProduct Values
| Parameter | Imperative | Type | Explanation |
|---|---|---|---|
| name | yes | String | Product Name |
| modelCode | no | String | Product Model Code |
| description | yes | String | Product Description |
| brandId | no | String | Product Beymen Brand information |
| categoryId | no | String | Product Beymen Category information |
| platformColor | no | String | Product Beymen Color Information |
| size | no | String | Product Beymen size information |
| gender | no | String | Product Beymen Gender information |
| vatRate | no | Integer | Product VAT information. Possible values (0,1,10,20) |
| images | no | List[String] | Information about the product's image links |
| desi | no | Integer | Product Desi information |
| attributes | yes/no | List[Attribute] | Product Beymen Feature information category-based required attributes must be added when updating a product |
| merchantColor | no | String | Product Seller Color information |
| stockCode | no | String | Stock code information of the seller |
Example product update payload
[
{
"id": "e9e5261a-5be1-430d-9ee4-34e0ee7ddd92",
"name": "Kadın Trekking Botu",
"stockCode": "0Mwesdf",
"description": "..................................................",
"brandId": "60163",
"categoryId": "10128",
"vatRate": 8,
"images": [
"61589",
"61590",
"https://placeimg.com/640/480/city" // İlk 2 görseli degistirilmemis, 3. olarak yeni bir gorsel eklenmis guncelleme ornegidir.
],
"modelCode": "ASOLO0051",
"merchantColor": "Sarı,Yavruağzı,Mavi, Lacivert,Pembe",
"size": "14",
"gender": "5",
"platformColor": "2471",
"desi": 1,
"attributes": []
}
]
Check Bulk Product Update Result
This method allows viewing the transaction results after a mass product update in Beymen.
HTTP Request
TEST ENV GET https://stage-partner-api.beymen.com/batch/products/{process_id}
PROD ENV GET https://partner-api.beymen.com/batch/products/{process_id}
HTTP Response
[
{
"request": {
"id": "e9e5261a-5be1-430d-9ee4-34e0ee7ddd92",
"name": "Kadın Trekking Botu",
"stockCode": "0Mwesdf",
"description": "..................................................",
"brandId": "60163",
"categoryId": "10128",
"priceRequest": null,
"stockRequest": null,
"vatRate": 8,
"desi": 1,
"images": [
"61589",
"61590",
"https://placeimg.com/640/480/city" // İlk 2 görseli degistirilmemis, 3. olarak yeni bir gorsel eklenmis guncelleme ornegidir.
],
"platformColor": "2471",
"merchantColor": "Sarı,Yavruağzı,Mavi, Lacivert,Pembe",
"size": "14",
"attributes": [],
"modelCode": "ASOLO0051",
"gender": "5",
"version": "cd19da5dd13dbe680c7ee77d0f38192a"
},
"isSuccess": false,
"processResult": "Hata - Satıcı Renk alanı maksimum 30 karakter olmalıdır."
}
]
Return Values
| Parameter | Type | Explanation |
|---|---|---|
| ResponseBody | Json(List[UpdateProductResponse]) | Product update result Values |
UpdateProductResponse
| Parameter | Type | Explanation |
|---|---|---|
| request | UpdateProduct | Information about the product that is being updated |
| productId | String | The product id of the updated product |
| isSuccess | Boolean | Transaction Status |
| processResult | String | Validation information of the product to be updated |
Single Product Display
This method allows to view product details with product Id after product creation / update.
HTTP Request
TEST ENV GET https://stage-partner-api.beymen.com/products/{product_id}
PROD ENV GET https://partner-api.beymen.com/products/{product_id}
HTTP Response
{
"id": "e9e5261a-5be1-430d-9ee4-34e0ee7ddd92",
"externalId": "37328361057225503517635257286_639",
"merchantId": "2f421666-cac5-41dc-988f-438f89607fb3",
"name": "Generic Concrete Mouse",
"barcode": "barcode1asd",
"modelCode": "modelCode1asd",
"stockCode": "QQTAACD1",
"brand": {
"id": "8158",
"name": "13R"
},
"category": {
"id": "96826",
"name": "Dijital Oyun"
},
"description": "Ut consequuntur cum suscipit debitis accusantium rem quisquam quos quis. Velit nihil facere. Itaque eligendi molestiae repellendus quae quisquam consectetur laudantium earum. Omnis ullam perspiciatis laudantium rem vel sed ducimus consectetur. Libero quasi rerum dolores. Qui excepturi totam.",
"merchantColorCode": "Bej",
"size": {
"id": "416",
"name": "25"
},
"gender": {
"id": "4392",
"name": "Erkek Bebek"
},
"platformColor": {
"id": "2474",
"name": "Bej"
},
"commission": 40,
"salesPrice": {
"value": 83.38,
"currency": "TRY"
},
"platformSalesPrice": {
"value": 83.38,
"currency": "TRY"
},
"vatRate": 0,
"desi": 1,
"stock": {
"count": 787
},
"status": {
"status": "WaitingBeymenApproval",
"localizedDescription": "Beymen Onayı Bekleniyor"
},
"subStatus": {
"status": "WaitingForSelection",
"localizedDescription": "Beymen Onayı Bekleniyor"
},
"images": [
{
"id": 6727,
"thumbnailPath": "https://img-beymen-marketplace.mncdn.com/mnresize/57/93/2f421666-cac5-41dc-988f-438f89607fb3/888356cc-9c81-4d96-9499-cbf6008bab35.jpg",
"originalPath": "https://img-beymen-marketplace.mncdn.com/2f421666-cac5-41dc-988f-438f89607fb3/888356cc-9c81-4d96-9499-cbf6008bab35.jpg",
"isImageRevised": false
}
],
"revisionText": "",
"selectedAttributes": [
{
"id": "228",
"name": "Garanti Tipi",
"items": {
"id": 44486,
"value": "Distribütör Garantili"
}
}
],
"customAttributes": [],
"version": "cd19da5dd13dbe680c7ee77d0f38192a"
}
Product Activation/Deactivation
This method allows you to active and deactive the products you have uploaded on Beymen.
HTTP Request
TEST ENV PUT https://stage-partner-api.beymen.com/products/{productId}/status/onSale
PROD ENV PUT https://partner-api.beymen.com/products/{productId}/status/onSale
TEST ENV PUT https://stage-partner-api.beymen.com/products/{productId}/status/notOnSale
PROD ENV PUT https://partner-api.beymen.com/products/{productId}/status/notOnSale
HTTP Response
{
"status": 400,
"traceId": "09ea7c8c-7652-4048-ae6e-67b6a5d383a3",
"errors": {
"MicroservicesCommon.Exceptions.BusinessRuleException": [
"Ürün zaten satışa kapalıdır, kapatma aksiyonu alınamaz."
]
}
}
Status Code 200
Product Listing
This method allows you to damage products in the relevant state defined in Beymen.
HTTP Request
TEST ENV GET https://stage-partner-api.beymen.com/products
PROD ENV GET https://partner-api.beymen.com/products
HTTP Response
{
"items": [
{
"id": "d4cc05d9-52fb-49b1-8074-e2e6af8e5440",
"externalId": "08835032226439641154841273973_209",
"merchantId": "2f421666-cac5-41dc-988f-438f89607fb3",
"name": "cilt bakım serum kozmetik",
"barcode": "SERUM66666",
"modelCode": "serum3211",
"stockCode": "",
"brand": {
"id": "717",
"name": "10 Crosby Derek Lam"
},
"category": {
"id": "98267",
"name": "Cilt Serumu"
},
"description": "cilt bakım serum kozmetik",
"merchantColorCode": "",
"size": {
"id": "13483",
"name": "Standart"
},
"gender": {
"id": "191",
"name": "Cinsiyetsiz (Tanımsız)"
},
"platformColor": {
"id": "2481",
"name": "Kahverengi"
},
"commission": 12.5,
"salesPrice": {
"value": 2000.0,
"currency": "TRY"
},
"platformSalesPrice": {
"value": 2000.0,
"currency": "TRY"
},
"vatRate": 18,
"desi": 0,
"stock": {
"count": 19
},
"status": {
"status": "OnSale",
"localizedDescription": "Satışta"
},
"subStatus": null,
"images": [
{
"id": 4352,
"thumbnailPath": "https://img-beymen-marketplace.mncdn.com/mnresize/57/93/2f421666-cac5-41dc-988f-438f89607fb3/e5a28a14-dc59-48da-90ef-7ca85963ba73.jpg",
"originalPath": "https://img-beymen-marketplace.mncdn.com/2f421666-cac5-41dc-988f-438f89607fb3/e5a28a14-dc59-48da-90ef-7ca85963ba73.jpg",
"isImageRevised": true
},
{
"id": 4355,
"thumbnailPath": "https://img-beymen-marketplace.mncdn.com/mnresize/57/93/2f421666-cac5-41dc-988f-438f89607fb3/c5799eba-25cf-4105-833d-bb82cbaedc7e.jpg",
"originalPath": "https://img-beymen-marketplace.mncdn.com/2f421666-cac5-41dc-988f-438f89607fb3/c5799eba-25cf-4105-833d-bb82cbaedc7e.jpg",
"isImageRevised": true
},
{
"id": 4337,
"thumbnailPath": "https://img-beymen-marketplace.mncdn.com/mnresize/57/93/2f421666-cac5-41dc-988f-438f89607fb3/f9120ac3-4455-47a4-8d91-61b7bf74b690.jpg",
"originalPath": "https://img-beymen-marketplace.mncdn.com/2f421666-cac5-41dc-988f-438f89607fb3/f9120ac3-4455-47a4-8d91-61b7bf74b690.jpg",
"isImageRevised": true
}
],
"revisionText": "",
"selectedAttributes": null,
"customAttributes": null,
"version": "aca02de30bec45a4662eaaa4b47d87f8",
"isReturnForbidden": false
}
],
"page": 0,
"itemsPerPage": 20,
"pageCount": 0,
"total": 1
}
Query Parameters
| Parameter | Imperative | Type | Explanation |
|---|---|---|---|
| size | no | Integer | The number of products to be listed. Default value is 10 |
| page | no | Integer | The page with the product to be listed. default value is 0 |
| barcode | no | String | Barcode value to be searched |
| modelcode | no | String | Model Code value to be searched |
| brand | no | Integer | Brand value to be searched |
| stockcode | no | String | StockCode value to searched |
| status | no | Status | The status value to be searched. |
| substatus | no | SubStatus | Status value to be searched |
Status Values
| Parameter | Explanation |
|---|---|
| OnSale | On Sale |
| NotOnSale | Not On Sale |
| OutOfStock | Out of Stock |
| WaitingBeymenApproval | Waiting Beymen Approval |
| WaitingRevised | Waiting Revised |
| NotSelectedBeymen | Not Selected Beymen |
Sub Status Values
| Parameter | Explanation |
|---|---|
| DeactivatedByBeymen | The product has been closed for sale by Beymen |
| PriceMissing | Missing price |
| DeactivatedBySeller | The product has been closed for sale by the seller |
| DeactivatedByCriticalPriceChange | Due to the critical price change, the product has been closed for sale |
| SellerActionNeeded | Seller's action is awaited |
| WaitingForSelection | The product is in the selection process in beymen |
| WaitingForImageRevised | The product is in the image revised process at Beymen |
| WaitingForProductControl | The product is in the control process at Beymen. |
| StockOut | Stock Out |
| DeactivatedByStoreClosed | The product has been deactivated because the store was closed |
Return Values
| Parameter | Type | Explanation |
|---|---|---|
| items | List[Product] | List of products |
| page | Integer | Result returned page number |
| itemsPerPage | Integer | Information on how many products are in each request |
| pageCount | Integer | Total Page Count |
| total | Integer | Total Product Count |
Product
| Parameter | Type | Explanation |
|---|---|---|
| id | String | Product ID |
| name | String | Product Name |
| barcode | String | Product Barcode |
| modelCode | String | Product Model Code |
| stockCode | String | Stock code information of the seller |
| brand | Brand | Product Beymen Brand information |
| category | Category | Product Beymen Category information |
| description | String | Product Description |
| merchantColorCode | Color | Product Seller Color information |
| size | Size | Product Beymen size information |
| commission | Integer | Product Commission rate |
| salesPrice | Price | Information on the undiscounted selling price of the product |
| platformSalesPrice | Price | Undiscounted sales price information of the product |
| vatRate | Integer | Beymen sales price information of the product |
| desi | Double | Product Desi information |
| stock | Stock | Product Stock information |
| status | Status | Current status of the product |
| subStatus | SubStatus | Current substatus of the product |
| images | List[Image] | Product Photographs |
| revisionText | String | Information on the changes requested by the Beymen platform regarding the product |
Bulk Attribute Listing
This method allows you to access a single list of brands, genders, sizes, and colors registered in Beymen without the need for pagination.
Http Request
TEST ENV GET https://stage-partner-api.beymen.com/attributes/all?type=Brand
PROD ENV GET https://partner-api.beymen.com/attributes/all?type=Brand
Http Response
[
{
"id": "717",
"value": "10 Crosby Derek Lam",
"type": 3
},
{
"id": "41050",
"value": "1017 Alyx 9sm",
"type": 3
},
{
"id": "41725",
"value": "108 Niyettaşı",
"type": 3
},
{
"id": "15412",
"value": "111Skin",
"type": 3
},
{
"id": "8158",
"value": "13R",
"type": 3
}
]
Type Values
| Parameter | Type | Explanation |
|---|---|---|
| Brand | 3 | Brand |
| Gender | 6 | Gender |
| Color | 23 | Beymen Color |
| Size | 2 | Size |
Brands
This method allows you to access the brands defined in Beymen. There is pagination when querying endpoints, when itemsPerPage is 100, not all brands are available, all brands can be accessed by proceeding from pagination.
"page":0,"itemsPerPage":100,"pageCount":87,"total":8772} (for example, the total count will change as the number of brands increases)
Http Request
TEST ENV GET https://stage-partner-api.beymen.com/attributes?type=Brand&size=100
PROD ENV GET https://partner-api.beymen.com/attributes?type=Brand&size=100
Http Response
{
"items": [
{
"id": "717",
"value": "10 Crosby Derek Lam",
"type": 3
},
{
"id": "41050",
"value": "1017 Alyx 9sm",
"type": 3
},
{
"id": "41725",
"value": "108 Niyettaşı",
"type": 3
},
{
"id": "15412",
"value": "111Skin",
"type": 3
},
{
"id": "8158",
"value": "13R",
"type": 3
}
],
"page": 0,
"itemsPerPage": 5,
"pageCount": 199,
"total": 999
}
Return Values
| Parameter | Type | Explanation |
|---|---|---|
| items | List[Brand] | Brand list |
| page | Integer | The result of which page is returned |
| itemsPerPage | Integer | Information on how many brands are in each request |
| pageCount | Integer | Total Page Count |
| total | Integer | Total Brand Count |
Brand
| Parameter | Type | Explanation |
|---|---|---|
| id | String | Brand ID |
| value | String | Brand Name |
Gender
This method allows you to access the gender information defined in Beymen. There is pagination when querying endpoints, when itemsPerPage is 2, not all gender values are displayed, all gender values can be reached by proceeding from pagination.
"page":0,"itemsPerPage":2,"pageCount":5,"total":xx} (for example, the total count will change as the gender value increases)
Http Request
TEST ENV GET https://stage-partner-api.beymen.com/attributes?type=Gender&size=5
PROD ENV GET https://partner-api.beymen.com/attributes?type=Gender&size=5
Http Response
{
"items": [
{
"id": "31",
"value": "Erkek",
"type": 6
},
{
"id": "5",
"value": "Kadın",
"type": 6
},
{
"id": "173",
"value": "Unisex",
"type": 6
},
{
"id": "4402",
"value": "Kız Bebek",
"type": 6
},
{
"id": "4379",
"value": "Kız Çocuk",
"type": 6
},
{
"id": "4377",
"value": "Unisex Çocuk",
"type": 6
},
{
"id": "4392",
"value": "Erkek Bebek",
"type": 6
},
{
"id": "4393",
"value": "Erkek Çocuk",
"type": 6
},
{
"id": "4524",
"value": "Unisex Bebek",
"type": 6
},
{
"id": "191",
"value": "Cinsiyetsiz (Tanımsız)",
"type": 6
}
],
"page": 0,
"itemsPerPage": 10,
"pageCount": 1,
"total": 10
}
Return Values
| Parameter | Type | Explanation |
|---|---|---|
| items | List[Gender] | Gender list |
| page | Integer | The result of which page is returned |
| itemsPerPage | Integer | Information on how many genders are in each request |
| pageCount | Integer | Total Page Count |
| total | Integer | Total Size Count |
Gender
| Parameter | Type | Explanation |
|---|---|---|
| id | String | Gender ID |
| value | String | Gender Information |
Sizes
This method allows you to access the body information defined in Beymen. There is pagination when querying endpoints, when itemsPerPage is 10, not all sizes are available, all sizes can be accessed by proceeding from pagination.
"page":0,"itemsPerPage":10,"pageCount":x,"total":xx} (for example, the total count will change as the size increases)
Http Request
TEST ENV GET https://stage-partner-api.beymen.com/attributes?type=Size&size=5
PROD ENV GET https://partner-api.beymen.com/attributes?type=Size&size=5
Http Response
{
"items": [
{
"id": "561",
"value": "XXS",
"type": 2
},
{
"id": "81",
"value": "XS",
"type": 2
},
{
"id": "63",
"value": "S",
"type": 2
},
{
"id": "66",
"value": "M",
"type": 2
},
{
"id": "64",
"value": "L",
"type": 2
}
],
"page": 0,
"itemsPerPage": 5,
"pageCount": 25,
"total": 128
}
Return Values
| Parameter | Type | Explanation |
|---|---|---|
| items | List[Size] | Size list |
| page | Integer | The result of which page is returned |
| itemsPerPage | Integer | Information on how many genders are in each request |
| pageCount | Integer | Total Page Count |
| total | Integer | Total Size Count |
Size
| Parameter | Type | Explanation |
|---|---|---|
| id | String | Size ID |
| value | String | Size Information |
Colors
This method allows you to access color information defined in Beymen. There is pagination when querying endpoints, when itemsPerPage is 5, not all colors are available, all colors can be accessed by proceeding from pagination.
"page":0,"itemsPerPage":5,"pageCount":x,"total":xx} (for example, the total count will change as the number of colors increases)
Http Request
TEST ENV GET https://stage-partner-api.beymen.com/attributes?type=Color&size=5
PROD ENV GET https://partner-api.beymen.com/attributes?type=Color&size=5
Http Response
{
"items": [
{
"id": "2488",
"value": "Altın",
"type": 1
},
{
"id": "2474",
"value": "Bej",
"type": 1
},
{
"id": "2472",
"value": "Beyaz",
"type": 1
},
{
"id": "2478",
"value": "Bordo",
"type": 1
},
{
"id": "2486",
"value": "Çok Renkli",
"type": 1
}
],
"page": 0,
"itemsPerPage": 5,
"pageCount": 3,
"total": 18
}
Return Values
| Parameter | Type | Explanation |
|---|---|---|
| items | List[Color] | Color list |
| page | Integer | The result of which page is returned |
| itemsPerPage | Integer | Information on how many genders are in each request |
| pageCount | Integer | Total Page Count |
| total | Integer | Total Size Count |
Color
| Parameter | Type | Explanation |
|---|---|---|
| id | String | Color ID |
| value | String | Color Information |
Categories
This method allows you to access the category information defined in Beymen. We recommend that you get the current category list periodically, as new categories can be added in case the product variety increases.
The category ID in the lowest break should be used to make the product loading process. If there are subcategories of the category you have selected (hasChild: true), you cannot install /update products with this category information.
After getting the main categories, there are subcategories of the categories that are hasChild:true, you can follow the path below to get to these subcategories. For example, if you want to get a sub-breakdown of the main category of Electronics, you can get a sub- breakdown of Electronics with the parentıd,
https://partner-api.beymen.com/categories?parentId=96794
- By taking the parentids of those who are hasChild:true, you can progress to the lowest fractures until hasChild:false.
Http Request
TEST ENV GET https://stage-partner-api.beymen.com/categories
PROD ENV GET https://partner-api.beymen.com/categories
Http Response
{
"items": [
{
"id": "96583",
"name": "Anne & Bebek & Oyuncak",
"hasChild": true
},
{
"id": "10004",
"name": "ERKEK",
"hasChild": true
},
{
"id": "96794",
"name": "Elektronik",
"hasChild": true
},
{
"id": "96928",
"name": "Ev & Mobilya",
"hasChild": true
},
{
"id": "10006",
"name": "KADIN",
"hasChild": true
},
{
"id": "30894",
"name": "KOZMETİK",
"hasChild": true
},
{
"id": "94137",
"name": "Spor & Outdoor",
"hasChild": true
},
{
"id": "97258",
"name": "Yaşam",
"hasChild": true
},
{
"id": "31210",
"name": "ÇOCUK",
"hasChild": true
}
],
"page": 0,
"itemsPerPage": 10,
"pageCount": 0,
"total": 9
}
Request Parameters
| Parameter | Required | Type | Explanation |
|---|---|---|---|
| size | no | Integer | The number of categories to be listed. The default value is 10 |
| page | no | Integer | The page where the category to be listed is located. The default value is 0 |
| parentId | no | String | The value of the upper refraction of the category |
| name | no | String | The desired name value to search for |
Return Values
| Parameter | Type | Explanation |
|---|---|---|
| items | List[Category] | Category list |
| page | Integer | The result of which page is returned |
| itemsPerPage | Integer | Information on how many genders are in each request |
| pageCount | Integer | Total Page Count |
| total | Integer | Total Size Count |
Category
| Parameter | Type | Explanation |
|---|---|---|
| id | String | ID information of the category |
| name | String | Category name |
| hasChild | Boolean | The sub-current refraction information belonging to the category |
Category Attributes
This method allows you to access the category product features information defined in Beymen. We recommend that you get the current category product features list periodically, as new product features can be added in case the product variety increases.
Product features are defined by category IDs in the lowest breakdown. You can check the product attributes in the sub-category breakdown with hasChild:false and use these attribute Ids during product upload and update stages. Note: Not every subcategory has an attribute value.
Http Request
TEST ENV GET https://stage-partner-api.beymen.com/categories/95729
PROD ENV GET https://partner-api.beymen.com/categories/95729
Http Response
{
"name": "3 Tekerlekli Bebek Arabası",
"parentId": "95728",
"hasChild": false,
"canHaveProduct": true,
"level": 4,
"attributes": [
{
"id": "111",
"name": "Araba Ağırlığı",
"isFreeText": false,
"required": true,
"items": [
{
"id": 48363,
"value": "0-7 kg"
},
{
"id": 48364,
"value": "10-14 kg"
},
{
"id": 48365,
"value": "14+ kg"
},
{
"id": 48366,
"value": "7-10 kg"
},
{
"id": 70427,
"value": "Diğer"
}
]
},
{
"id": "174",
"name": "Ek Özellik",
"isFreeText": false,
"required": true,
"items": [
{
"id": 49158,
"value": "Çift Yönlü"
},
{
"id": 49159,
"value": "Tek Elle Katlama"
},
{
"id": 49160,
"value": "Tek Yönlü"
},
{
"id": 49161,
"value": "Yatış Pozisyonlu"
},
{
"id": 70442,
"value": "Diğer"
}
]
},
{
"id": "203",
"name": "Garanti Süresi (Ay)",
"isFreeText": false,
"required": false,
"items": [
{
"id": 70732,
"value": "6 Ay "
},
{
"id": 70733,
"value": "12 Ay"
},
{
"id": 70734,
"value": "24 Ay"
},
{
"id": 70735,
"value": "48 Ay"
},
{
"id": 70736,
"value": "36 Ay"
},
{
"id": 70934,
"value": "Diğer"
}
]
},
{
"id": "303",
"name": "Materyal",
"isFreeText": false,
"required": false,
"items": [
{
"id": 50524,
"value": "Hakiki Deri"
},
{
"id": 50525,
"value": "Suni Deri"
},
{
"id": 50526,
"value": "Tekstil"
},
{
"id": 50643,
"value": "Diğer"
}
]
},
{
"id": "411",
"name": "Taşıma Kapasitesi (kg)",
"isFreeText": false,
"required": true,
"items": [
{
"id": 68546,
"value": "0-9 kg"
},
{
"id": 68547,
"value": "9-18 kg"
},
{
"id": 68548,
"value": "0-18 kg"
},
{
"id": 68549,
"value": "15-36 kg"
},
{
"id": 68550,
"value": "9-25 kg"
},
{
"id": 68552,
"value": "0-13 kg"
},
{
"id": 68553,
"value": "3,5 - 13 kg"
},
{
"id": 68793,
"value": "0-25 kg"
},
{
"id": 68621,
"value": "0-15 kg"
},
{
"id": 70502,
"value": "Diğer"
}
]
},
{
"id": "412",
"name": "Taşma Emniyeti",
"isFreeText": false,
"required": true,
"items": [
{
"id": 51745,
"value": "Var"
},
{
"id": 51746,
"value": "Yok"
}
]
}
],
"hierarchy": [95726, 95727, 95728, 95729],
"createdBy": "system",
"createdDate": "2023-03-06T07:39:16.913Z",
"lastModifiedBy": "system",
"lastModifiedDate": "2023-03-06T07:39:16.913Z",
"id": "95729"
}
Price and Stock Update
This method ensures that the stock and or price information of the related product defined in Beymen is updated.
HTTP Request
TEST ENV PUT https://stage-partner-api.beymen.com/products/{product_id}/price-stock
PROD ENV PUT https://partner-api.beymen.com/products/{product_id}/price-stock
{
"priceRequest": {
"salesPrice": {
"value": 700,
"currency": "TRY"
},
"platformPrice": {
"value": 699,
"currency": "TRY"
}
},
"stockRequest": {
"stock": {
"count": 112
}
}
}
Request Parameters
| Parameter | Required | Type | Explanation |
|---|---|---|---|
| priceRequest | no | PriceRequest | Price information of the product to be updated |
| stockRequest | no | StockRequest | Stock information of the product to be updated |
PriceRequest
| Parameter | Required | Type | Explanation |
|---|---|---|---|
| salesPrice | no | Price | Sales price information of the product to be updated |
| platformPrice | no | Price | Beymen sales information of the product to be updated |
Price
| Parameter | Required | Type | Explanation |
|---|---|---|---|
| value | yes | Double | Price Value |
| currency | yes | String | Currency Information |
StockRequest
| Parameter | Required | Type | Explanation |
|---|---|---|---|
| stock | yes | Stock | Stock information of the product to be updated |
Stock
| Parameter | Required | Type | Explanation |
|---|---|---|---|
| count | yes | Integer | Stock quantity |
HTTP Response
Status Code 202
Adding/Updating Product in English
This method enables the updating or addition of English information related to the specified product at Beymen.
HTTP Request
TEST ENVIRONMENT PUT https://stage-partner-api.beymen.com/products/{product_id}/language-definition
PRODUCTION ENVIRONMENT PUT https://partner-api.beymen.com/products/{product_id}/language-definition
{
"code": "en",
"name": "Yellow Tshirt",
"description": "This product will make you very happy",
"merchantColor": "pink-yellow"
}
Request Parameters
| Parameter | Required | Type | Explanation |
|---|---|---|---|
| code | yes | string | Code information about in which language the addition/update will be made for the product to be updated |
| name | yes | string | The translation of the product name in the desired language for the product to be updated |
| description | yes | string | The translation of the product description in the desired language for the product to be updated |
| merchantColor | yes | string | The translation of the product seller's color in the desired language for the product to be updated |
HTTP Response
Status Code 202
Order Integration
In this section, there is API documentation about order management in Beymen.
Order Listing
This method shows the information about your orders created in Beymen.
HTTP Request
TEST ENV GET https://stage-partner-api.beymen.com/orders
PROD ENV GET https://partner-api.beymen.com/orders
HTTP Response
{
"items":[
{
"id":"5671f644-4c19-4bcc-ba4b-5d49ae2590a7",
"merchantId":"2f421666-cac5-41dc-988f-438f89607fb3",
"externalMerchantId":"0009000111",
"orderId":"BEY-20220913-000000",
"mpOrderId": "MP000001002433-000000" // Entegrasyonda siparis Id olarak bu Id de kullanılabilir.
"orderNumber":"BEY-20220913-000000",
"orderDate":"2022-09-13T12:27:32.483",
"customerDeliveryDate":null,
"shipmentNumber":"MP000001002433",
"shipmentProvider":"YRTICI",
"shipmentTrackingNumber":null,
"customerName":"Test Test",
"totalAmount":1200,
"totalVatAmount":183.05,
"totalCouponAmount":0,
"currencyCode":"TRY",
"maxPermittedShippingTime":"2022-09-15T12:27:32.483",
"shipmentStatus":1,
"shipmentLines":[
{
"status":"Yeni Sipariş",
"id":null,
"productId":"d1cb82e3-e047-4335-aa92-3831b95bfecb",
"quantity":1,
"orderLineId":"36097",
"currencyCode":"TRY",
"price":1016.95,
"couponPrice":0,
"vatAmount":183.05,
"commission":12,
"desi":0,
"vatRate":18,
"gift":false,
"giftNote":null,
"product":{
"id":"d1cb82e3-e047-4335-aa92-3831b95bfecb",
"name":"Kupon test 12",
"barcode":"Kupontest12",
"modelCode":"Kupontest12",
"stockCode":"",
"color":"Bej",
"size":{
"id":"13483",
"name":"Standart"
},
"brand":{
"id":"8867",
"name":"18 K"
},
"category":{
"id":"97213",
"name":"Süzgeç"
},
"merchantColorCode":"Bej",
"description":"Kupon test 12",
"gender":{
"id":"191",
"name":"Cinsiyetsiz (Tanımsız)"
},
"platformColor":{
"id":"2474",
"name":"Bej"
},
"images":[
"https://img-beymen-marketplace.mncdn.com/2f421666-cac5-41dc-988f-438f89607fb3/studio/dbd9cde4-86e7-4ba3-831b-00cd8223586a.jpg"
]
},
"cancelReasonStatus":null
}
],
"shipmentAddress":{
"id":"1",
"externalId":"1",
"customerName":"Test Test",
"company":"Test Test",
"address":"Bahçelievler",
"cityCode":"34",
"city":"İstanbul",
"districtCode":null,
"district":"Bahçelievler",
"neighborhood":"Bahçelievler",
"neighborhoodCode":null,
"postcode":null,
"phone":null,
"email":null
},
"invoiceAddress":{
"id":"85b66802-738d-44f3-b69a-7579d8b44927",
"externalId":null,
"customerName":"Test Test",
"company":"Test Test",
"address":"Bahçelievler",
"cityCode":"34",
"city":"İstanbul",
"districtCode":null,
"district":"Bahçelievler",
"neighborhood":"Bahçelievler",
"neighborhoodCode":null,
"postcode":null,
"phone":null,
"email":null,
"tcIdentityNumber":"11111111111",
"taxNumber":null,
"taxHouse":null
},
"sellerAddress":{
"name":"test testt",
"email":"gizem.test@gmail.com",
"phone":"05110571111",
"city":"Adana",
"country":"TR",
"cityCode":"1",
"district":"Ceyhan",
"neighborhood":"Toktamış",
"postCode":null,
"address":"toktamış adress",
"taxNo":"20452495203"
},
"fraudCheck": false,
"isAwaiting": false,
}
],
"page":0,
"itemsPerPage":20,
"pageCount":0,
"total":1
}
Query Parameters
| Parameter | Required | Type | Explanation |
|---|---|---|---|
| size | no | Integer | The order quantity to be listed. Default value is 10 |
| page | no | Integer | The page with the order to be listed. Default value is 0 |
| orderNumber | no | String | Order number value to be searched |
| packetNo | no | String | The value of the package number to be searched(shipmentnumber) |
| barcode | no | Integer | Barcode value to be searched |
| shipmentStatus | no | ShipmentStatus | The order status value to be searched for - eg: NewOrder |
| startDate | no | DateTime | Order start date to be searched |
| endDate | no | DateTime | The end date of the order to be searched |
| subStatus | no | SubStatus | Status value to be searched |
| fraudCheck | no | Boolean | The fraud status to be searched for |
| isAwaiting | no | Boolean | The payment pending status of the order to be searched |
ShipmentStatus Values
| Parameter | Value | Explanation |
|---|---|---|
| NewOrder | 1 | New Order |
| ReadyToShip | 2 | Ready to Ship |
| Shipped | 4 | Shipped |
| DeliveredToCustomer | 8 | Deliverd to Customer |
| Cancelled | 16 | Cancel |
| Divided | 32 | Divided Package |
Return Values
| Parameter | Type | Explanation |
|---|---|---|
| items | List[Order] | Order List |
| page | Integer | which page the result is returned |
| itemsPerPage | Integer | Information on how many products are in each request |
| pageCount | Integer | Total number of pages |
| total | Integer | Total product of pages |
Order
| Parameter | Type | Explanation |
|---|---|---|
| id | String | Id information of the order |
| merchantId | String | Merchant Id information of the order |
| orderId | String | Platform Order Id information |
| orderNumber | String | Platform Order Id Number |
| orderDate | DateTime | Order Formation Date |
| customerDeliveryDate | DateTime | Order Delivery Date |
| shipmentNumber | String | Shipping Number |
| shipmentProvider | String | Cargo Name |
| shipmentTrackingNumber | String | Order tracking number |
| customerName | String | Customer Name |
| totalAmount | Double | Order Total amount |
| totalVatAmount | Double | Order VAT amount |
| currencyCode | String | Currency information for the order |
| maxPermittedShippingTime | DateTime | The last time the cargo should be delivered |
| shipmentStatus | Integer | Order status information numerical value |
| shipmentLines | List[ShipmentLine] | Delivery items information of the order |
| shipmentAddress | ShipmentAddress | Order Delivery Address |
| invoiceAddress | InvoiceAddress | Order Invoice Address |
| canceledDateTime | DateTime | Cancellation Date |
| merchantName | String | Merchant Name |
| companyName | String | Merchant Store Name |
| fraudCheck | Boolean | Fraud control (Payment Awaiting) |
| fraudDate | DateTime | Fraud Control Date |
| isAwaiting | Boolean | The payment pending status of the orde |
| isAlternativeDelivery | Boolean | Alternative delivery status |
ShipmentLine
| Parameter | Type | Explanation |
|---|---|---|
| id | String | Id information of the Order Item |
| status | String | Status information to Order Item |
| productId | String | Product Id of the Order Item |
| quantity | Integer | Quantity of Order Item |
| orderLineId | String | Order Item Id of Order Item |
| currencyCode | String | Currency information of the Order Item |
| price | Double | Price information of the Order Item Id |
| vatAmount | Double | VAT information of the Order Item |
| commission | Double | Commission information of the Order Item |
| desi | Integer | Deci information of the Order Item |
| vatRate | Double | VAT rate information of the Order Item |
| gift | Boolean | Gift information of the Order Item |
| giftNote | String | Gift note information of the Order Item |
| cancelReasonStatus | CancellationReason | Cancellation reason information for the Order Item |
| product | Product | Product information of the Order Item |
ShipmentAddress
| Parameter | Type | Explanation |
|---|---|---|
| id | String | Delivery Address Id |
| customerName | String | TDelivery Customer name |
| company | String | Delivery Company name |
| address | String | Delivery Address information |
| cityCode | String | Delivery City code |
| city | String | Delivery City name |
| districtCode | String | Delivery DistrictCode |
| district | String | Delivery District name |
| neighborhoodCode | String | Delivery Neighborhood code |
| neighborhood | String | Delivery Neighborhood name |
| postcode | String | Delivery Postcode |
| phone | String | Delivery Phone number |
| String | Delivery email |
InvoiceAddress
| Parameter | Type | Explanation |
|---|---|---|
| id | String | Invoice Address Id |
| customerName | String | Invoice Customer name |
| company | String | Invoice Company name |
| address | String | Invoice Address information |
| cityCode | String | Invoice City code |
| city | String | Invoice City name |
| districtCode | String | Invoice District code |
| district | String | Invoice District name |
| neighborhoodCode | String | Invoice neighborhood code |
| neighborhood | String | Invoice neighborhood name |
| postcode | String | Invoice Postcode |
| phone | String | Invoice Phone number |
| String | Invoice Email address | |
| tcIdentityNumber | String | Invoice TR Identity Number |
| taxNumber | String | Invoice Tax no |
| taxHouse | String | Invoice Tax office |
SellerAddress
| Parameter | Type | Explanation |
|---|---|---|
| name | String | Seller Name |
| String | Seller Email | |
| phone | String | Seller Phone Number |
| address | String | Seller Address |
| city | String | Seller City Name |
| country | String | Seller Country Name |
| cityCode | String | Seller City Code |
| district | String | Seller District Code |
| neighborhood | String | Seller Neighborhood name |
| postCode | String | Seller Postal Code |
| taxNo | String | Seller Tax No |
Order Processing (Picking Status Submission)
It is the method to be applied in order to switch an order in New Order status to Ready to Ship status (processing the order).
HTTP Request
TEST ENV PUT https://stage-partner-api.beymen.com/orders/{id}/status/picking
PROD ENV PUT https://partner-api.beymen.com/orders/{id}/status/picking
or
TEST ENV PUT https://stage-partner-api.beymen.com/orders/{mpOrderId}/status/picking
PROD ENV PUT https://partner-api.beymen.com/orders/{mpOrderId}/status/picking
Split packages in orders
It is the method to be applied to divide the deliveries of an order with New Order and Ready to Ship statuses. In the splitting process, a new package will be created with 2 items of product ID fbda506c-9ef5-451c-948c-ae5bb60215d0 and 1 item of product ID 13078d8d-76d3-4bbb-93fd-2941be39d117, and if there are remaining products, another package will be created for them.
HTTP Request
TEST ENV POST https://stage-partner-api.beymen.com/orders/{id}/divide
PROD ENV POST https://partner-api.beymen.com/orders/{id}/divide
or
TEST ENV POST https://stage-partner-api.beymen.com/orders/{mpOrderId}/divide
PROD ENV POST https://partner-api.beymen.com/orders/{mpOrderId}/divide
HTTP Body
{
"products": [
{
"productId": "fbda506c-9ef5-451c-948c-ae5bb60215d0",
"quantity": 2
},
{
"productId": "13078d8d-76d3-4bbb-93fd-2941be39d117",
"quantity": 1
}
]
}
HTTP Response
Status Code 200
Split packages multiple in orders
It is the method to be applied to divide the deliveries of an order with New Order and Ready to Ship statuses. In the split process, one package will be created for orderLines 1, 2, and 3, a separate package for orderLine 4, and if there are any remaining orderLines, a third package will be created for them.
HTTP Request
TEST ENV POST https://stage-partner-api.beymen.com/orders/{id}/divide/multiple
PROD ENV POST https://partner-api.beymen.com/orders/{id}/divide/multiple
veya
TEST ENV POST https://stage-partner-api.beymen.com/orders/{mpOrderId}/divide/multiple
PROD ENV POST https://partner-api.beymen.com/orders/{mpOrderId}/divide/multiple
HTTP Body
{
"orderLineGroups": [
{
"orderLineIds": ["1", "2", " 3"]
},
{
"orderLineIds": ["4"]
}
]
}
HTTP Response
Status Code 200
Note: Divided packages are marked with the 'Divided' status and can be cancelled. You can use the Order Listing endpoint with the parameters 'shipmentNumber' and 'shipmentStatus' to list the divided packages.
AlternativeDeliveryTypes
It is the method to be applied for alternative deliveries of an order with New Order and Ready to Ship statuses.
HTTP Request
TEST ENV PUT https://stage-partner-api.beymen.com/orders/{id}/alternativeDelivery
PROD ENV PUT https://partner-api.beymen.com/orders/{id}/alternativeDelivery
HTTP Body
{
"ShipmentTrackingUrl": "http://testurl",
"DeliveryType": 0,
"ShipmentTrackingNumber": "123456",
"CargoCompanyCode": "YRTICI"
}
Body Paremters
| Paremater | Type | Description |
|---|---|---|
| ShipmentTrackingUrl | String | Information about the shipment tracking URL |
| DeliveryType | DeliveryType | Type of delivery |
| ShipmentTrackingNumber | String | Tracking number for the shipment |
| CargoCompanyCode | String | Code of the cargo company Click here for cargo companies |
AlternativeDeliveryTypes:
| Parameter | Explanation |
|---|---|
| AlternativeCargoCompany | I want to send it with a different cargo company that does not have a Beymen agreement. |
| AuthorizedService | I want to send it with my own vehicle or authorized service |
public enum DeliveryType
{
AlternativeCargoCompany = 0
AuthorizedService = 1
}
HTTP Response
Status Code 200
Delivering a Package Sent via Alternative Delivery
This service can be used to update orders sent via the alternative delivery method, which are in the Shipping status and have been delivered to the customer, to the Delivered status.
HTTP Request
TEST ORTAM PATCH https://stage-partner-api.beymen.com/orders/{id}/alternativeDelivery/deliveredToCustomer
PROD ORTAM PATCH https://partner-api.beymen.com/orders/{id}/alternativeDelivery/deliveredToCustomer
HTTP Response
Status Code 202
Returning a Package via Alternative Delivery
This service can be used for orders sent via the alternative delivery method that remain in the Shipping status but were not delivered to the customer and were returned to your warehouse, preventing them from being updated to the Delivered status.
When this request is used, the order will be processed as a customer cancellation.
HTTP Request
TEST ORTAM PATCH https://stage-partner-api.beymen.com/orders/{id}/alternativeDelivery/undeliverable
PROD ORTAM PATCH https://partner-api.beymen.com/orders/{id}/alternativeDelivery/undeliverable
HTTP Response
Status Code 202
Order Invoice Upload
The method to upload invoices for the deliveries of orders in any status.
HTTP Request
TEST ENV POST https://stage-partner-api.beymen.com/orders/{id}/invoice
PROD ENV POST https://partner-api.beymen.com/orders/{id}/invoice
or
TEST ENV POST https://stage-partner-api.beymen.com/orders/{mpOrderId}/invoice
PROD ENV POST https://partner-api.beymen.com/orders/{mpOrderId}/invoice
HTTP Body
{
"InvoiceNumber": "invoce1-2-3-4",
"InvoiceUrl": "https://mp-cdn-prod.beymen.com/assets/Dummy_PDF.pdf"
}
HTTP Response
Status Code 200
Legal Requirement
Invoice links sent via this service must remain accessible for 10 years as per legal obligation.
Delete Invoice from Order
Previously incorrectly uploaded invoices can be deleted through this service and can be re-uploaded using the Order Invoice Upload service.
HTTP Request
TEST ENV DELETE https://stage-partner-api.beymen.com/orders/{id}/invoice
PROD ENV DELETE https://partner-api.beymen.com/orders/{id}/invoice
or
TEST ENV DELETE https://stage-partner-api.beymen.com/orders/{mpOrderId}/invoice
PROD ENV DELETE https://partner-api.beymen.com/orders/{mpOrderId}/invoice
HTTP Response
Status Code 200
Cancel Listing
This method displays the information of the order/orders canceled by the Beymen Backoffice user, the Seller or the Customer. Cancellations can be listed by filtering ShipmentStatus: Cancelled.
HTTP Request
TEST ENV GET https://stage-partner-api.beymen.com/orders?shipmentStatus=Cancelled
PROD ENV GET https://partner-api.beymen.com/orders?shipmentStatus=Cancelled
HTTP Response
{
"items": [
{
"id": "a962815c-5a66-4a83-9e20-088a1b006df8",
"merchantId": "2f421666-cac5-41dc-988f-438f89607222",
"externalMerchantId": "0009000000",
"orderId": "BEY-20220906-019687",
"mpOrderId": "MP000001002358-019687" // Entegrasyonda siparis Id olarak bu Id de kullanılabilir.
"orderNumber": "BEY-20220906-019687",
"orderDate": "2022-09-06T14:43:04.907",
"customerDeliveryDate": null,
"shipmentNumber": "MP000001002358",
"shipmentProvider": "YRTICI",
"shipmentTrackingNumber": null,
"customerName": "test test",
"totalAmount": 1120,
"totalVatAmount": 201.6,
"totalCouponAmount": 280,
"currencyCode": "TRY",
"maxPermittedShippingTime": "2022-09-08T14:43:04.907",
"shipmentStatus": 16,
"shipmentLines": [
{
"status": "Satıcı İptali",
"id": null,
"productId": "15fd597c-246c-4900-972d-b978fa11ac4a",
"quantity": 1,
"orderLineId": "34583",
"currencyCode": "TRY",
"price": 459.2,
"couponPrice": 140,
"vatAmount": 100.8,
"commission": 12,
"desi": 0,
"vatRate": 18,
"gift": false,
"giftNote": null,
"product": {
"id": "15fd597c-246c-4900-972d-b978fa11ac4a",
"name": "Kupon test 7",
"barcode": "Kupontest7",
"modelCode": "Kupontest7",
"stockCode": "",
"color": "Bej",
"size": {
"id": "13483",
"name": "Standart"
},
"brand": {
"id": "8867",
"name": "18 K"
},
"category": {
"id": "97213",
"name": "Süzgeç"
},
"merchantColorCode": "Bej",
"description": "Kupon test 7",
"gender": {
"id": "191",
"name": "Cinsiyetsiz (Tanımsız)"
},
"platformColor": {
"id": "2474",
"name": "Bej"
},
"images": [
"https://img-beymen-marketplace.mncdn.com/2f421666-cac5-41dc-988f-438f89607fb3/studio/2b0bbf6c-5ab7-48f1-ae86-961315463412.jpg"
]
},
"cancelReasonStatus": 4
}
],
"shipmentAddress": {
"id": "1",
"externalId": "1",
"customerName": "Test Test",
"company": "Test Test",
"address": "alaçeşme mh no:1",
"cityCode": "7",
"city": "Antalya",
"districtCode": null,
"district": "Akseki",
"neighborhood": "Alaçeşme",
"neighborhoodCode": null,
"postcode": null,
"phone": null,
"email": null
},
"invoiceAddress": {
"id": null,
"externalId": null,
"customerName": "Test Test",
"company": "Test Test",
"address": "alaçeşme mh no:1",
"cityCode": "7",
"city": "Antalya",
"districtCode": null,
"district": "Akseki",
"neighborhood": "Alaçeşme",
"neighborhoodCode": null,
"postcode": null,
"phone": null,
"email": null,
"tcIdentityNumber": null,
"taxNumber": null,
"taxHouse": null
},
"sellerAddress": {
"name": "test testt",
"email": "test.test@gmail.com",
"phone": "05550570000",
"city": "Adana",
"country": "TR",
"cityCode": "1",
"district": "Ceyhan",
"neighborhood": "Toktamış",
"postCode": null,
"address": "toktamış adress",
"taxNo": "20452495203"
},
"canceledDateTime": "2022-09-06T11:43:59.5230338+00:00",
"merchantName": "test testt",
"companyName": "test testt",
"paymentPeriod": 7,
"shipmentTrackingUrl": null,
"fraudCheck": false,
"fraudDate": null,
"isAlternativeDelivery": false,
"customerPhoneNumber": null,
"deliveryType": null,
"isReturnedShipment": false
}
],
"page": 0,
"itemsPerPage": 20,
"pageCount": 0,
"total": 1
}
Query Parameters
| Parameter | Required | Type | Explanation |
|---|---|---|---|
| size | no | Integer | The order quantity to be listed. Default value is 10 |
| page | no | Integer | The page with the order to be listed. Default value is 0 |
| orderNumber | no | String | Order number value to be searched |
| shipmentNumber | no | String | The value of the package number to be searched |
| barcode | no | Integer | Barcode value to be searched |
| shipmentStatus | no | ShipmentStatus | Order status value to be searched (must be Cancelled) |
| startDate | no | DateTime | Order start date to be searched |
| endDate | no | DateTime | The end date of the order to be searched |
| substatus | no | SubStatus | Status value to be searched |
| fraudCheck | no | Boolean | Fraud status to be searched |
ShipmentStatus Values
| Parameter | Value | Explanation |
|---|---|---|
| Cancelled | 16 | Cancel |
NOTE1 : You can track undeliverable orders with the isreturnedshipment parameter. If this parameter is true, the order could not be delivered to the customer.
NOTE2 : While orders are filtered by orderDate, canceled orders are filtered by CanceledDateTime parameter.
Order Cancellation
This method, the order can be canceled by the Seller.
HTTP Request
TEST ENV PUT https://stage-partner-api.beymen.com/orders/{id}/status/cancel
PROD ENV PUT https://partner-api.beymen.com/orders/{id}/status/cancel
HTTP Body
{
"products": [
{
"productId": "string",
"quantity": 0,
"cancelReasonStatus": 1,
"shipmentLineStatus": 1
}
]
}
CancelReasonStatus:
| Parameter | Explanation |
|---|---|
| IntegrationFailed | Integration error/Failed |
| StockOut | Stock out |
| WrongPrice | Wrong price |
| DefectiveOrFaultyProduct | Defective/defective/broken product |
| WrongImageOrBarcode | WrongImageOrBarcode |
| ForceMajor | Force majeure |
| Returned | Returned |
public enum CancelReasonStatus
{
IntegrationFailed = 1,
StockOut = 2,
WrongPrice = 4,
DefectiveOrFaultyProduct = 8,
WrongImageOrBarcode = 16,
ForceMajor = 32,
Returned = 64
}
As the integrator company, it is required to send the default shipmentLineStatus: 32.
shipmentLineStatusler
public enum ShipmentLineStatus
{
NewOrder = 1,
ReadyToShip = 2,
Shipped = 4,
DeliveredToCustomer = 8,
CancelledByBeymen = 16,
CancelledBySeller = 32,
CancelledByCustomer = 64,
Reorder = 128
}
Note : For orders containing two or more products, the shipping code of the order is canceled when at least one of the products is canceled by the seller or customer (when a partial cancellation is made). A new shipping code for the same order number is created for other products that have not been canceled.
Return Listing
This method shows Beymen return information.
HTTP Request
TEST ENV GET https://stage-partner-api.beymen.com/claims
PROD ENV GET https://partner-api.beymen.com/claims
HTTP Response
{
"items": [
{
"id": "0ef04ec6-c8fb-4572-8d08-9a184c234dfc",
"merchantId": "2f421666-cac5-41dc-988f-438f89607fb3",
"externalMerchantId": "0009000000",
"orderId": "BEY-20220915-020111",
"orderNumber": "BEY-20220915-020111",
"orderDate": "2022-09-15T14:16:34.887",
"customerDeliveryDate": "2022-09-15T13:30:47.176Z",
"shipmentNumber": "MP13606201734",
"shipmentProvider": "YRTICI",
"shipmentTrackingNumber": "555511112",
"customerName": "test test",
"totalAmount": 1901.8,
"totalVatAmount": 18.82,
"currencyCode": "TRY",
"maxPermittedShippingTime": "2022-09-17T11:19:50.3147712+00:00",
"shipmentLines": [
{
"quantity": 1,
"id": "89377dfa-bdaa-4b20-848c-462ee6e951ff",
"productId": "8cf7864b-fd60-44d4-8cf6-95ea5eb82285",
"orderLineId": "36311",
"status": 4,
"confirmType": null,
"currencyCode": "TRY",
"price": 941.49,
"vatAmount": 9.41,
"commission": 400,
"desi": 5,
"vatRate": 1,
"gift": false,
"giftNote": null,
"product": {
"id": "8cf7864b-fd60-44d4-8cf6-95ea5eb82285",
"name": "test deneme test deneme",
"barcode": "436324254",
"modelCode": "R444444",
"stockCode": "test",
"color": "Beyaz",
"size": {
"id": "63",
"name": "S"
},
"brand": {
"id": "41050",
"name": "1017 Alyx 9sm"
},
"category": {
"id": "96800",
"name": "Akıllı Cep Telefonu"
},
"merchantColorCode": "Beyaz",
"description": "test deneme test denemetest deneme test denemetest deneme test denemetest deneme test deneme",
"gender": {
"id": "4402",
"name": "Kız Bebek"
},
"platformColor": {
"id": "2472",
"name": "Beyaz"
},
"images": [
"https://img-beymen-marketplace.mncdn.com/2f421666-cac5-41dc-988f-438f89607fb3/studio/1a724db9-3a6a-48b4-95d1-aabfe2710794.jpg"
]
},
"customerReason": {
"code": "1",
"description": "Cayma Hakkımı Kullanmak İstiyorum"
},
"sellerReason": {
"type": 5,
"description": "3rd party claim dispute first try",
"images": [
"https://img-beymen-marketplace.mncdn.com/2f421666-cac5-41dc-988f-438f89607fb3/images/claim/0ef04ec6-c8fb-4572-8d08-9a184c234dfc/dispute/a90f07a6-ccdd-4072-8fbb-bc9d9bc5218e"
]
},
"shipmentNumber": null
}
],
"shipmentAddress": {
"id": "1",
"externalId": "1",
"customerName": "test test",
"company": "test test",
"address": "istanbul pendik yeni adress deneme",
"cityCode": "34",
"city": "İstanbul",
"districtCode": null,
"district": "Beyoğlu",
"neighborhood": "Emekyemez",
"neighborhoodCode": null,
"postcode": null,
"phone": null,
"email": null
},
"invoiceAddress": {
"id": "2574d973-145e-40fd-8c00-4966051b95be",
"externalId": null,
"customerName": "test test",
"company": "test test",
"address": "istanbul pendik yeni adress deneme",
"cityCode": "34",
"city": "İstanbul",
"districtCode": null,
"district": "Beyoğlu",
"neighborhood": "Emekyemez",
"neighborhoodCode": null,
"postcode": null,
"phone": null,
"email": null,
"tcIdentityNumber": "null",
"taxNumber": null,
"taxHouse": null
},
"merchantName": "test testt",
"companyName": "test testt",
"paymentPeriod": 7,
"shipmentTrackingUrl": "https://test.beymen.com/takip",
"claimDate": "2022-09-15T11:19:12.0688887+00:00"
}
],
"page": 0,
"itemsPerPage": 20,
"pageCount": 0,
"total": 1
}
Query Parameters
| Parameter | Required | Type | Explanation |
|---|---|---|---|
| size | no | Integer | The order quantity to be listed. Default value is 10 |
| page | no | Integer | The page with the order to be listed. Default value is 0 |
| orderNumber | no | String | Order number value to be searched |
| shipmentCode | no | String | The cargo tracking number value to be searched |
| shipmentNumber | no | String | The value of the package number to be searched |
| Status | no | ShipmentLineStatus | Return status value to be searched (, , , , ) |
| shipmentStatus | no | ShipmentStatus | Order status value to be searched |
| startDate | no | DateTime | Return start date to be searched |
| endDate | no | DateTime | Return end date to be searched |
| customerName | no | string | Name of the customer to be searched |
ShipmentStatus Values
| Parameter | Value | Explanation |
|---|---|---|
| New | 0 | New Returns |
| ActionNeeded | 1 | Action Awaits |
| Approved | 2 | Approved |
| Reject | 3 | Reject |
| Dispute | 4 | Dispute |
Taking "I Have Received" Action on Refund
If the return status is not delivered from the cargo, it enables the seller to switch the return to Action Awaited status in order to take action to approve the return/report a problem.
HTTP Request
TEST ENV PATCH https://stage-partner-api.beymen.com/claims/{id}/receive
PROD ENV PATCH https://partner-api.beymen.com/claims/{id}/receive
HTTP Response
202 Accepted
Confirmation of the Return
This method ensures that the returns received at Beymen are approved.
HTTP Request
TEST ENV PATCH https://stage-partner-api.beymen.com/claims/{id}/approve
PROD ENV PATCH https://partner-api.beymen.com/claims/{id}/approve
HTTP Body
[
{
"productId": "string",
"quantity": 1
}
]
HTTP Response
202 Accepted
Problem Reporting of Return (Disputed Return)
This method ensures that problems are reported to the returns received at Beymen.
HTTP Request
TEST ENV PATCH https://stage-partner-api.beymen.com/claims/{id}/dispute
PROD ENV PATCH https://partner-api.beymen.com/claims/{id}/dispute
HTTP Body
{
"items": [
{
"productId": "string",
"images": ["string"],
"reasonType": 0,
"quantity": 0,
"description": "string" // freetext Requireddeğil
}
]
}
HTTP Response
202 Accepted
Query Parameters
| Parameter | Required | Type | Explanation |
|---|---|---|---|
| productId | yes | String | Id information of the product for which a return problem is requested |
| images | yes | String[] | Image is required field for all selected types except PackageIsEmpty reasonType |
| reasonType | yes | ReasonType | Reason for return problem report |
| quantity | yes | Integer | Refund issue requested amount information |
| description | no | String | Detailed description of return problem reporting |
ReasonTypes:
| Parameter | Explanation |
|---|---|
| ReceivedProductNotMine | The product received is not mine |
| ProductIsDefectiveOrDamaged | Incoming product is defective/damaged |
| ProductQuantityIsMissing | Incoming product quantity is missing |
| ProductIsWrong | Incoming product is wrong |
| ProductUsedOrOpenedPacking | Incoming product used/opened packaging |
| ProductIsFake | Incoming product is fake |
| ProductPartIsMissing | Part/accessory of the received product is missing |
| ProductIsNotDefective | The product I sent is not defective |
| ProductIsNotWrong | The product I sent is not wrong |
| PackageIsEmpty | Return package came empty |
| PackageNotFound | I did not receive the return package |
| ExcessProductReceived | The customer returned the excess product I sent |
reasonTypelar
public enum SellerReasonType
{
ReceivedProductNotMine = 0
ProductIsDefectiveOrDamaged = 1
ProductQuantityIsMissing = 2
ProductIsWrong = 3
ProductUsedOrOpenedPacking = 4
ProductIsFake = 5
ProductPartIsMissing = 6
ProductIsNotDefective = 7
ProductIsNotWrong = 8
PackageIsEmpty = 9
PackageNotFound = 10
ExcessProductReceived = 11
}
Manual Progression Of Order Statuses
This method can be used when you want to advance the shipment statuses of your orders.
HTTP Request
TEST ENV PUT https://stage-partner-api.beymen.com/orders/{id}/shipment/status
PROD ENV PUT https://partner-api.beymen.com/orders/{id}/shipment/status
HTTP Body
{
"trackingNumber": "string",
"trackingUrl": "string",
"cargoCompanyCode": "YRTICI",
"status": 8
}
HTTP Response
202 Accepted
Query Paremeters
| Parameter | Required | Type | Explanation |
|---|---|---|---|
| trackingNumber | yes | String | The necessary code to track the shipment status. |
| trackingUrl | no | String | The URL required to track the shipment status. |
| cargoCompanyCode | yes | String | The information about which company will be responsible for shipping the package. Click here for cargo companies |
| status | yes | Integer | The information about the status of the shipment. |
Status Values
| Parameter | Value | Explanation |
|---|---|---|
| Shipped | 4 | Shipped |
| DeliveredToCustomer | 8 | Delivered To Customer |
| Undeliverable | 16 | Could Not Be Delivered To The Customer |
Cargo Companies
| Code | Description |
|---|---|
| BexVizyon | VİZYON KURYE HİZMETLERİ ULUSLARARASI TAŞIMACILIK BİLGİ SİSTEMLERİ TURİZM SAN.TİC.LTD.ŞTİ. |
| Mng | MNG KARGO YURTİÇİ VE YURTDIŞI TAŞ. A.Ş |
| AKN | AKIN NAKLİYAT TURZ İNŞ.SAN.TİC.LTD.ŞTİ |
| UD | EKOL LOJİSTİK A.Ş |
| YRTICI | YURTICI KARGO SERVISI A.S |
| BYMExprANK | BİR GÜNDE KARGO LOJİSTİK DAĞITIM NAKLİYAT ORMAN ÜRÜNLERİ GIDA SANAYİ VE TİCARET LİMİTED ŞİRKET |
| BYMExprIZM | BİR GÜNDE KARGO LOJİSTİK DAĞITIM NAKLİYAT ORMAN ÜRÜNLERİ GIDA SANAYİ VE TİCARET LİMİTED ŞİRKET |
| YRTICIPartner | YURTICI KARGO SERVISI A.S |
| BexTaskin | TAŞKIN LOJİSTİK HİZMETLERİ TİCARET LİMİTED ŞİRKETİ |
| BexBirgun | BİR GÜNDE KARGO LOJİSTİK DAĞITIM NAKLİYAT ORMAN ÜRÜNLERİ GIDA SANAYİ VE TİCARET LİMİTED ŞİRKET |
| HepsiJet | D FAST DAGITIM HIZMETLERI VE LOJISTIK ANONIM SIRKETI |
| BYMExpress | TAŞKIN LOJİSTİK HİZMETLERİ TİCARET LİMİTED ŞİRKETİ |
| KolGel | Ekol Ekspres Kargo A.Ş. |
| ups | UPS KARGO |
| Aras | Aras Kargo |
| ptt | PTT Kargo |
| kolaygelsin | Kolay Gelsin |
| Sürat | Sürat Kargo |
| Borusan | Borusan Lojistik |
| ty | Trendyol Express |
| Ceva | Ceva Lojistik |
| Kargoist | Kargo İst |
| Horoz | Horoz Lojistik |
| Ekol | Ekol Lojistik |
| DHL | DHL |
| tnt | TNT |
| Nettrack | Nettrack |
| Scotty | Scotty |
| Kargom Sende | Kargom Sende |
| Jetizz | Jetizz |
| BoltKargo | Bolt Kargo |
| AGT | AGT Kurye |
Finance Integration
This section contains the API documentation related to financial management at Beymen.
Daily Logs
This method enables the reporting of financial records at Beymen. The records displayed here provide an item-based representation of the orders.
HTTP Request
TEST ORTAM GET https://stage-partner-api.beymen.com/financial/transactions
PROD ORTAM GET https://partner-api.beymen.com/financial/transactions
HTTP Response
{
"items": [
{
"id": "597fcf25-b499-4718-b92d-9cbbc8edbd29",
"merchantId": "981ef35a-85db-49c8-9ba7-1566a3485922",
"transactionNumber": "46632",
"transactionType": "Satış",
"orderNo": "BEY-20230609-025078",
"orderDate": "2023-06-09T10:19:10.89",
"transactionDate": "2023-06-20T11:12:47.177",
"amount": 1180.0,
"paymentPeriod": 0
},
{
"id": "60650d78-b4ac-4b84-82aa-f38020fe68e6",
"merchantId": "981ef35a-85db-49c8-9ba7-1566a3485922",
"transactionNumber": "46631",
"transactionType": "Satış",
"orderNo": "BEY-20230609-025078",
"orderDate": "2023-06-09T10:19:10.89",
"transactionDate": "2023-06-20T11:12:47.177",
"amount": 1180.0,
"paymentPeriod": 0
},
{
"id": "2b7f5bf8-7cb0-41dd-ba60-697d400deb92",
"merchantId": "981ef35a-85db-49c8-9ba7-1566a3485922",
"transactionNumber": "46628",
"transactionType": "Satış",
"orderNo": "BEY-20230609-025078",
"orderDate": "2023-06-09T10:19:10.89",
"transactionDate": "2023-06-20T11:12:47.177",
"amount": 800.0,
"paymentPeriod": 0
},
{
"id": "64d01e2c-9835-4ed3-b153-e17579923e07",
"merchantId": "981ef35a-85db-49c8-9ba7-1566a3485922",
"transactionNumber": "46685",
"transactionType": "Satış",
"orderNo": "BEY-20230614-025116",
"orderDate": "2023-06-14T15:03:11.937",
"transactionDate": "2023-06-20T09:42:47.177",
"amount": 300.0,
"paymentPeriod": 0
},
{
"id": "77c5e227-93f4-49ea-9ea9-f1fca76d29af",
"merchantId": "981ef35a-85db-49c8-9ba7-1566a3485922",
"transactionNumber": "46659",
"transactionType": "Satış",
"orderNo": "BEY-20230613-025095",
"orderDate": "2023-06-13T09:20:32.297",
"transactionDate": "2023-06-19T13:33:43.757",
"amount": 650.0,
"paymentPeriod": 0
},
{
"id": "6f1da75c-8d0e-494b-833f-b59985c05624",
"merchantId": "981ef35a-85db-49c8-9ba7-1566a3485922",
"transactionNumber": "46658",
"transactionType": "Satış",
"orderNo": "BEY-20230613-025095",
"orderDate": "2023-06-13T09:20:32.297",
"transactionDate": "2023-06-19T13:33:43.757",
"amount": 650.0,
"paymentPeriod": 0
},
{
"id": "ff647d38-d102-4163-94c1-7a722832c7fc",
"merchantId": "981ef35a-85db-49c8-9ba7-1566a3485922",
"transactionNumber": "46205",
"transactionType": "Satış",
"orderNo": "BEY-20230531-024880",
"orderDate": "2023-05-31T08:51:54.76",
"transactionDate": "2023-06-16T14:42:47.177",
"amount": 800.0,
"paymentPeriod": 5
},
{
"id": "e2f5df4f-e071-416e-a170-6ebc93c30a04",
"merchantId": "981ef35a-85db-49c8-9ba7-1566a3485922",
"transactionNumber": "45828",
"transactionType": "Satış",
"orderNo": "BEY-20230522-024704",
"orderDate": "2023-05-22T15:11:53.963",
"transactionDate": "2023-06-16T14:42:47.177",
"amount": 800.0,
"paymentPeriod": 14
},
{
"id": "da262d7a-4cb5-4bf7-a38c-b2226080cca7",
"merchantId": "981ef35a-85db-49c8-9ba7-1566a3485922",
"transactionNumber": "45934",
"transactionType": "Satış",
"orderNo": "BEY-20230525-024757",
"orderDate": "2023-05-25T11:39:36.67",
"transactionDate": "2023-06-01T09:55:26.073",
"amount": 800.0,
"paymentPeriod": 5
},
{
"id": "c064440c-7598-4deb-ac6b-f9a40da3a91e",
"merchantId": "981ef35a-85db-49c8-9ba7-1566a3485922",
"transactionNumber": "46307",
"transactionType": "Satış",
"orderNo": "BEY-20230531-024931",
"orderDate": "2023-05-31T15:48:50.417",
"transactionDate": "2023-05-31T16:08:12.177",
"amount": 1180.0,
"paymentPeriod": 0
}
],
"page": 0,
"itemsPerPage": 10,
"pageCount": 31,
"total": 301
}
Query Paremeters
| Parameter | Required | Type | Explanation |
|---|---|---|---|
| size | no | Integer | The number of orders to be listed. The default value is 10. |
| page | no | Integer | The page where the orders are located to be listed. The default value is 0. |
| orderNumber | no | String | The value of the order number to be searched. |
| orderStartDate | no | DateTime | The start date of the order to be searched. |
| orderEndDate | no | DateTime | The end date of the order to be searched. |
Return Values
| Parameter | Type | Explanation |
|---|---|---|
| items | List[FinancialTransaction] | List of Transaction |
| page | Integer | which page the result is returned |
| itemsPerPage | Integer | Information on how many products are in each request |
| pageCount | Integer | Total number of pages |
| total | Integer | Total product of pages |
FinancialTransaction
| Parameter | Type | Explanation |
|---|---|---|
| id | String | The Id information of the transaction. |
| merchantId | String | The Merchant Id information of the transaction. |
| transactionNumber | String | The Order Item ID related to the transaction. |
| transactionType | String | The Type information of the transaction. |
| orderNo | String | The Order Number related to the transaction. |
| orderDate | String | The Order Date related to the transaction. |
| transactionDate | String | The Date related to the transaction. |
| amount | Double | The Amount related to the transaction. |
| paymentPeriod | Integer | The agreed payment term with the supplier. |
Invoice Listing
This method enables the reporting of financial invoices at Beymen.
HTTP Request
TEST ORTAM GET https://stage-partner-api.beymen.com/financial/invoices
PROD ORTAM GET https://partner-api.beymen.com/financial/invoices
HTTP Response
{
"items": [
{
"id": "bf746521-752f-41c2-b061-d82336abde39",
"merchantId": "981ef35a-85db-49c8-9ba7-1566a3485922",
"invoiceNumber": "ca15c5cf-7f0d-426e-8e8c-f9949ae4533d",
"invoiceTypeDescription": "Reklam",
"invoiceType": 5,
"invoiceDate": "2023-06-14T12:30:16.53",
"paymentDate": "2023-06-15T00:00:00",
"amount": -11.26,
"couponPrice": null,
"eInvoiceUrl": "https://sites.fitbulut.com/eBelgeGoruntuleyici/ViewDocument.aspx?ID=012460008975&UUID=11505697-42E8-1EED-9EB7-8BCB864D0254&download=PDF&doctype=outinvoice",
"eInvoiceNumber": "123456"
},
{
"id": "05e1ea97-d660-41e0-9798-663948b8eb16",
"merchantId": "981ef35a-85db-49c8-9ba7-1566a3485922",
"invoiceNumber": "1905535e-3f7c-4a79-be27-f7c73d203555",
"invoiceTypeDescription": "Reklam",
"invoiceType": 5,
"invoiceDate": "2023-06-14T12:27:11.237",
"paymentDate": "2023-06-15T00:00:00",
"amount": -11.26,
"couponPrice": null,
"eInvoiceUrl": null,
"eInvoiceNumber": null
},
{
"id": "5d8b3932-9434-48b6-9766-1b8b5a662e7d",
"merchantId": "981ef35a-85db-49c8-9ba7-1566a3485922",
"invoiceNumber": "a637d587-a947-4822-b43b-76748aadb554",
"invoiceTypeDescription": "Kargo",
"invoiceType": 1,
"invoiceDate": "2023-06-07T00:00:00",
"paymentDate": "2023-06-08T00:00:00",
"amount": -41.89,
"couponPrice": null,
"eInvoiceUrl": null,
"eInvoiceNumber": null
},
{
"id": "b5d62e62-472d-4311-a377-97bebdba0865",
"merchantId": "981ef35a-85db-49c8-9ba7-1566a3485922",
"invoiceNumber": "58afa13c-c391-4d63-a7cf-0f3083527413",
"invoiceTypeDescription": "Komisyon",
"invoiceType": 0,
"invoiceDate": "2023-06-07T00:00:00",
"paymentDate": "2023-06-08T00:00:00",
"amount": -176.0,
"couponPrice": null,
"eInvoiceUrl": null,
"eInvoiceNumber": null
},
{
"id": "578b36f4-311b-4dbd-adc3-c6d47847b7eb",
"merchantId": "981ef35a-85db-49c8-9ba7-1566a3485922",
"invoiceNumber": "afe8c8bb-71a7-488e-9eae-de606ecf7617",
"invoiceTypeDescription": "Reklam",
"invoiceType": 5,
"invoiceDate": "2023-06-07T15:14:06.21",
"paymentDate": "2023-06-08T00:00:00",
"amount": -563.0,
"couponPrice": null,
"eInvoiceUrl": null,
"eInvoiceNumber": null
},
{
"id": "2cd02e3a-9fb4-4d6d-9afa-07001f765926",
"merchantId": "981ef35a-85db-49c8-9ba7-1566a3485922",
"invoiceNumber": "020ed068-b4e6-4ae7-b150-b57297ea47ab",
"invoiceTypeDescription": "Reklam",
"invoiceType": 5,
"invoiceDate": "2023-06-07T10:06:07.44",
"paymentDate": "2023-06-08T00:00:00",
"amount": -2252.0,
"couponPrice": null,
"eInvoiceUrl": null,
"eInvoiceNumber": null
},
{
"id": "ecb83f8a-265d-4359-b811-17e482f0bc6e",
"merchantId": "981ef35a-85db-49c8-9ba7-1566a3485922",
"invoiceNumber": "38d20546-075d-4314-80c7-f5cefa3f1904",
"invoiceTypeDescription": "Reklam",
"invoiceType": 5,
"invoiceDate": "2023-06-06T13:57:05.847",
"paymentDate": "2023-06-08T00:00:00",
"amount": -2252.0,
"couponPrice": null,
"eInvoiceUrl": null,
"eInvoiceNumber": null
},
{
"id": "72762a66-0b81-41c4-891c-478de7cb073e",
"merchantId": "981ef35a-85db-49c8-9ba7-1566a3485922",
"invoiceNumber": "29a908b2-dc4e-47d9-b42d-98e989dd4d65",
"invoiceTypeDescription": "Komisyon",
"invoiceType": 0,
"invoiceDate": "2023-05-31T00:00:00",
"paymentDate": "2023-06-15T00:00:00",
"amount": -288.0,
"couponPrice": null,
"eInvoiceUrl": null,
"eInvoiceNumber": null
},
{
"id": "3d371ebe-1458-496a-b0c6-48ffa3f18f5d",
"merchantId": "981ef35a-85db-49c8-9ba7-1566a3485922",
"invoiceNumber": "b831eaeb-4330-4e4d-a3ce-1e5e44eb8b20",
"invoiceTypeDescription": "Komisyon",
"invoiceType": 0,
"invoiceDate": "2023-05-31T00:00:00",
"paymentDate": "2023-06-08T00:00:00",
"amount": -120.32,
"couponPrice": null,
"eInvoiceUrl": null,
"eInvoiceNumber": null
},
{
"id": "0d49e28a-2fd9-41bd-8251-c00b0cc1503b",
"merchantId": "981ef35a-85db-49c8-9ba7-1566a3485922",
"invoiceNumber": "60802db5-cfe6-4d72-a49d-f2e1964ad406",
"invoiceTypeDescription": "Komisyon",
"invoiceType": 0,
"invoiceDate": "2023-05-31T00:00:00",
"paymentDate": "2023-06-01T00:00:00",
"amount": -66.08,
"couponPrice": null,
"eInvoiceUrl": null,
"eInvoiceNumber": null
}
],
"page": 0,
"itemsPerPage": 10,
"pageCount": 11,
"total": 107
}
Query Paremeters
| Parameter | Required | Type | Explanation |
|---|---|---|---|
| invoiceTypes | no | Integer[] | The invoice types to be searched for. |
| size | no | Integer | The number of orders to be listed. The default value is 10. |
| page | no | Integer | The page where the orders are located to be listed. The default value is 0. |
| startDate | no | DateTime | The start date of the invoice to be searched. |
| endDate | no | DateTime | The end date of the invoice to be searched. |
InvoiceType Values
| Parameter | Type | Explanation |
|---|---|---|
| Commission | 0 | Commission Invoice |
| Shipment | 1 | Shipment Invoice |
| InsufficientSupply | 2 | InsufficientSupply Invoice |
| Delay | 3 | Delay Invoice |
| MissingProduct | 4 | Defective Product Invoice |
| Advertising | 5 | Advertising Invoice |
Dönüş Values
| Parameter | Type | Explanation |
|---|---|---|
| items | List[Invoice] | Invoice Listing |
| page | Integer | which page the result is returned |
| itemsPerPage | Integer | Information on how many products are in each request |
| pageCount | Integer | Total number of pages |
| total | Integer | Total product of pages |
Invoice
| Parameter | Type | Explanation |
|---|---|---|
| id | String | The Id information of the invoice. |
| merchantId | String | The MerchantId information of the invoice. |
| invoiceNumber | String | Invoice Number |
| invoiceTypeDescription | String | The description of the invoice type. |
| invoiceType | String | The type of the invoice. |
| invoiceDate | String | Invoice Date |
| paymentDate | String | Payment Date of the invoice |
| amount | String | The price of the invoice. |
| couponPrice | String | The used coupon of the invoice. |
| eInvoiceUrl | String | The e-invoice Url of the invoice. |
| eInvoiceNumber | String | The e-invoice number of the invoice. |
Invoice Detail
This method enables the reporting of the details of a financial invoice at Beymen.
HTTP Request
TEST ORTAM GET https://stage-partner-api.beymen.com/financial/invoice/{invoiceNumber}
PROD ORTAM GET https://partner-api.beymen.com/financial/invoice/{invoiceNumber}
HTTP Response
[
{
"transactionNumber": "53506",
"commissionType": "Sales",
"orderNo": "BEY-20231005-028046",
"orderDate": "2023-10-05T13:13:45.41",
"transactionDate": "2023-10-11T11:18:28",
"productName": "test urunu",
"barcode": "testBarcode",
"amount": 4000.00000,
"couponPrice": 0.00000,
"commission": 22,
"platformPayment": 880.00,
"sellerPayment": 3120.00,
"paymentPeriod": 5,
"paymentDate": "2023-10-19T00:00:00",
"merchantName": "test test",
"companyName": "test company",
"mpOrderId": "MP100000052-028046"
},
{
"transactionNumber": "51029",
"commissionType": "Returned",
"orderNo": "BEY-20230828-026965",
"orderDate": "2023-08-28T09:28:30.407",
"transactionDate": "2023-09-13T06:19:34.913",
"productName": "test urunu",
"barcode": "testBarcode",
"amount": -200.00000,
"couponPrice": null,
"commission": 22,
"platformPayment": -44.00,
"sellerPayment": -156.00,
"paymentPeriod": 0,
"paymentDate": "2023-09-14T00:00:00",
"merchantName": "test test",
"companyName": "test company",
"mpOrderId": "MP231534581-026965"
}
]
InvoiceDetail Response
| Parameter | Type | Explanation |
|---|---|---|
| orderNo | String | The order number associated with the invoice line item. |
| shipmentType | String | The type of the invoice line item. |
| orderDate | String | The date information of the order associated with the invoice line item. |
| transactionDate | String | The transaction date information of the invoice line item. |
| shipmentNumber | String | The package number information of the invoice line item. |
| quantity | String | The quantity information of the invoice line item. |
| amount | String | The price information of the invoice line item. |
| shipmentCost | String | The shipping cost information of the invoice line item. |
| desi | String | The volume information (desi) of the invoice line item. |
| merchantName | String | The seller name information of the invoice line item. |
| mpOrderId | String | The unique order ID information of the invoice line item. |
Future Payment
This method enables the notification of your upcoming payments at Beymen.
HTTP Request
TEST ORTAM GET https://stage-partner-api.beymen.com/financial/transaction/future
PROD ORTAM GET https://partner-api.beymen.com/financial/transaction/future
HTTP Response
{
"totalSaleAmount": 5560.0,
"commissionCut": 1223.2,
"shipmentCut": 0.0,
"penaltyCut": 0.0,
"adCut": 0.0,
"total": 4336.8,
"futureTransactionActivities": [
{
"date": "2023-06-22",
"amount": 4336.8
},
{
"date": "2023-06-29",
"amount": 0
},
{
"date": "2023-07-06",
"amount": 656.0
}
],
"historyTransactionActivities": [
{
"date": "2023-06-01",
"amount": 2038.92
},
{
"date": "2023-06-08",
"amount": 18712.44
},
{
"date": "2023-06-15",
"amount": 636.0
}
],
"futureTotal": 4992.8,
"lastUpdateDate": "2023-06-21T08:06:41.6202353+00:00"
}
FutureTransaction Response
| Parameter | Type | Explanation |
|---|---|---|
| totalSaleAmount | Double | The total sales amount for this week. |
| commissionCut | Double | The total commission deduction amount for this week. |
| shipmentCut | Double | The total shipping deduction amount for this week. |
| penaltyCut | Double | The total penalty deduction amount for this week. |
| adCut | Double | The total advertising deduction amount for this week. |
| total | Double | The total earnings amount for this week. |
| futureTransactionActivities | FutureTransactionActivities | The total earnings amount for future weeks on a weekly basis. |
| historyTransactionActivities | HistoryTransactionActivities | The total earnings amount for past weeks on a weekly basis. |
| futureTotal | Double | The total earnings amount for future weeks. |
| lastUpdateDate | Datetime | The last update date information. |
Statements
This method allows listing your statements in Beymen.
HTTP Request
TEST ENV GET https://stage-partner-api.beymen.com/financial/statements?startDate=2023-08-01&endDate=2023-10-30
PROD ENV GET https://partner-api.beymen.com/financial/statements?startDate=2023-08-01&endDate=2023-10-30
HTTP Response
[
{
"sellerCode": "0009000095",
"documentDate": "2022-04-26T00:00:00",
"documentDueDate": "2022-05-26T00:00:00",
"documentAmount": -429.9,
"currencyLoc": "TRY",
"orderNo": "4583590",
"description": "Sipariş",
"itemText": "BEYMEN.COM"
},
{
"sellerCode": "0009000095",
"documentDate": "2022-04-28T00:00:00",
"documentDueDate": "2022-05-26T00:00:00",
"documentAmount": 98.88,
"currencyLoc": "TRY",
"orderNo": "",
"description": "MY12022000001072",
"itemText": "MARKETPLACE KOMİSYON BEDELİ"
},
{
"sellerCode": "0009000095",
"documentDate": "2022-04-28T00:00:00",
"documentDueDate": "2022-05-05T00:00:00",
"documentAmount": 20.06,
"currencyLoc": "TRY",
"orderNo": "",
"description": "MY12022000001073",
"itemText": "MARKETPLACE KARGO BEDELİ"
}
]
Query Parameters
| Parametre | Required | Type | Descripton |
|---|---|---|---|
| startDate | Yes | Date | Start Date |
| endDate | Yes | Date | End Date |
The duration between the Start and End dates must be at least 30 days and no more than 90 days."
Return Values
| Parametre | Descripton |
|---|---|
| sellerCode | Your current code in Beymen. |
| documentDate | The date when the document record was created. |
| documentDueDate | The date when the payment of the document record will be made. |
| documentAmount | The amount that will constitute your entitlement for the related record. |
| currencyLoc | TL (Turkish Lira) |
| orderNo | Records with the order no cell filled in the order no parameter are Sales or Return records. |
| description | In the Description Parameter; 1- Invoice numbers for shipping charges are located. 2- Order descriptions for Sales and Return records. Records with an order description that have a negative amount are sales records, and those with a positive amount are return records. |
| itemText | Records containing your seller title in the text parameter are payment records made to your account by Beymen. |
Question-Answer Integration
Customer Questions
This method allows you to filter questions on Beymen according to specific criteria.
HTTP Request
TEST ENV GET https://stage-partner-api.beymen.com/questions/filter
PROD ENV GET https://partner-api.beymen.com/questions/filter
HTTP Response
{
"items": [
{
"id": 551,
"productName": "string",
"modelCode": "string",
"color": "string",
"size": "string",
"brandName": "string",
"question": "string", // Question
"answer": "string", // Your Answer
"imageUrl": "string",
"status": 0,
"maxPermittedResponseTime": "2024-12-26T13:12:07.547", // Last date to answer the question
"actionDate": null, // Last action date
"createdDate": "2024-12-25T13:12:07.56"
}
],
"page": 0,
"itemsPerPage": 10,
"pageCount": 1,
"total": 1
}
Query Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| size | No | Integer | Number of questions to list. Default value is 10 |
| page | No | Integer | Page number of questions to list. Default value is 0 |
| productName | No | String | Product name to search for |
| modelCode | No | String | Model code to search for |
| color | No | String | Color to search for |
| brandName | No | String | Brand name to search for |
| status | No | Integer | Question status to search for |
| startDate | No | DateTime | Start date to search for questions |
| endDate | No | DateTime | End date to search for questions |
Status Values:
public enum QnAStatus
{
PendingResponse, // Waiting for response
IssueReported, // Issue reported
Rejected, // Rejected
PendingPlatformReview, // Waiting for Beymen review
MerchantResponded, // Answered by merchant
PlatformResponded // Answered by Beymen
}
Answering Questions
This method allows you to respond to a specific question. The ID of the relevant question must be used to add a response.
HTTP Request
TEST ENV POST https://stage-partner-api.beymen.com/questions/{id}/answer
PROD ENV POST https://partner-api.beymen.com/questions/{id}/answer
HTTP Body
{
"Answer": "Thank you for your question about this product. According to the relevant information..."
}
HTTP Response
Status Code 200
Reporting Issues
This method allows you to report an issue related to a specific question. The ID of the relevant question must be used to report an issue.
HTTP Request
TEST ENV POST https://stage-partner-api.beymen.com/questions/{id}/report-issue
PROD ENV POST https://partner-api.beymen.com/questions/{id}/report-issue
HTTP Body
{
"ReportReason": "The question contains inappropriate content."
}
HTTP Response
Status Code 200