Başlangıç
Beymen API Entegrasyonu, Beymen Pazaryeri platformuna katılan firmaların Beymen API servisleri aracılığıyla ürün aktarımı, stok ve fiyat yönetimi, sipariş işlemleri gibi bir çok işlemi yapmasına olanak sağlayan bir sistemdir.
Kimlik Doğrulama
Canlı ortamda kullanacağınız API kullanıcı bilgilerinize partner portali sağ üst köşede yer alan mağaza adınıza tıkladığınızda açılan “Hesap Bilgilerim- Entegrasyon Bilgileri” başlığından ulaşabilirsiniz.
Test ortamında kullanacağınız API kullanıcı bilgilerinize partner portali sağ üst köşede yer alan mağaza adınıza tıkladığınızda açılan “Hesap Bilgilerim- Entegrasyon Bilgileri” başlığından ulaşabilirsiniz.
Beymen Partner Servisleri Basic Authentication metodunu kullanarak kullanıcı doğrulaması yapmaktadır. Öncelikle Partner Portal’den temin edilen API Key ve API Password kullanarak Authorization header oluşturulmalıdır.
Authorization: Basic Base64(ApiKey:ApiPassword)
Yapılan istekler içerisinde Authorization header bulunmadığı ya da geçersiz bir değer ile işlem yapılması durumunda Http Status 401 dönülmektedir.
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 bulunamadı veya geçersiz ApiKey ApiPassword. |
Ürün Entegrasyonu
Bu bölümde Beymen'de ürün yönetimi ile ilgili API dokümantasyonu bulunmaktadır.
Toplu Ürün Oluşturma
Bu metod Beymen'de toplu ürün oluşturmayı sağlamaktadır.
HTTP Request
TEST ORTAM POST https://stage-partner-api.beymen.com/batch/products
PROD ORTAM POST https://partner-api.beymen.com/batch/products
HTTP Response
{
"processId": "a218a046-08dc-476d-a1d6-5d463ea2e418"
}
İstek Parametreleri
| Parametre | Tip | Açıklama |
|---|---|---|
| RequestBody | Json(List[CreateProduct]) | Ürün yaratmak için gerekli Request Body Payload |
CreateProduct Değerleri
| Parametre | Zorunlu | Tip | Açıklama |
|---|---|---|---|
| name | evet | String | Ürün Adı |
| barcode | evet | String | Ürün'e ait barkod bilgisi |
| modelCode | evet | String | Ürün'e ait model kodu bilgisi |
| description | evet | String | Ürün'e ait açıklama |
| brandId | evet | String | Ürün'e ait Beymen Marka bilgisi |
| categoryId | evet | String | Ürün'e ait Beymen Kategori bilgisi |
| platformColor | evet | String | Ürün'e ait Beymen Renk bilgisi |
| size | evet | String | Ürün'e ait Beymen Beden bilgisi |
| gender | evet | String | Ürün'e ait Beymen Cinsiyet bilgisi |
| stockRequest | evet | StockRequest | Ürün'e ait Stok bilgisi |
| priceRequest | evet | PriceRequest | Ürün'e ait Fiyat bilgisi |
| vatRate | evet | Integer | Ürün'e ait KDV bilgisi. Olası değerler (0,1,10,20) |
| images | evet | List[String] | Ürün'e ait görsel linkleri bilgisi. |
| desi | hayır | Double | Ürün'e ait Desi bilgisi |
| attributes | evet/hayır | List[Attribute] | Ürün'e ait Beymen Özellik bilgisi (kategori bazlı zorunlu attributelar ürün oluştururken eklenmelidir) |
| merchantColorCode | hayır | String | Ürün'e ait Satıcı Renk bilgisi (Freetext bir değerdir. örn: yavruağzı) |
| stockCode | hayır | String | Satıcıya ait stok kodu bilgisi |
Örnek ürün oluşturma 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"
}
]
}
]
Toplu Ürün Oluşturma Sonuç Görüntüleme
Bu metod Beymen'de toplu ürün oluşturulduktan sonra işlem sonuçlarını görüntülemeyi sağlamaktadır.
HTTP Request
TEST ORTAM GET https://stage-partner-api.beymen.com/batch/products/{process_id}
PROD ORTAM 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ı"
}
]
Dönüş Değerleri
| Parametre | Tip | Açıklama |
|---|---|---|
| ResponseBody | Json(List[CreateProductResponse]) | Ürün oluşturma sonuç Değerleri |
CreateProductResponse
| Parametre | Tip | Açıklama |
|---|---|---|
| request | CreateProduct | Oluşturulmaya çalışılan ürüne ait bilgiler |
| productId | String | Oluşturulan ürüne ait product id |
| isSuccess | Boolean | İşlem Durumu |
| processResult | String | Oluşturulmak istenilen ürüne ait validasyon bilgisi |
Toplu Ürün Güncelleme
Bu metod Beymen'de toplu ürün güncellemeyi sağlamaktadır. Ürün güncelleyebilmek için başarılı bir şekilde oluşturulmuş her ürün için oluşturulan product Id'yi kullanılması gerekmektedir. Her ürün oluşturulduktan sonra her görsel için bir Id oluşturulur. Eğer görselde bir değişiklik yoksa ürün güncelleme işlemi yapılırken bu Id'ler ile güncelleme yapmak gerekmektedir. Yeni görsel eklenmek isteniyorsa image path'i eklenerek görseller update edilebilir.
HTTP Request
TEST ORTAM POST https://stage-partner-apibeymen.com/batch/update/products
PROD ORTAM POST https://partner-api.beymen.com/batch/update/products
HTTP Response
{
"processId": "s418a046-08dc-476d-a1d6-5d463ea2e431"
}
İstek Parametreleri
| Parametre | Tip | Açıklama |
|---|---|---|
| RequestBody | Json(List[CreateProduct]) | Ürün güncellemek için gerekli Request Body Payload |
UpdateProduct Değerleri
| Parametre | Zorunlu | Tip | Açıklama |
|---|---|---|---|
| name | evet | String | Ürün Adı |
| modelCode | hayır | String | Ürün'e ait model kodu bilgisi |
| description | evet | String | Ürün'e ait açıklama |
| brandId | hayır | String | Ürün'e ait Beymen Marka bilgisi |
| categoryId | hayır | String | Ürün'e ait Beymen Kategori bilgisi |
| platformColor | hayır | String | Ürün'e ait Beymen Renk bilgisi |
| size | hayır | String | Ürün'e ait Beymen Beden bilgisi |
| gender | hayır | String | Ürün'e ait Beymen Cinsiyet bilgisi |
| vatRate | hayır | Integer | Ürün'e ait KDV bilgisi. Olası değerler (0,1,10,20) |
| images | hayır | List[String] | Ürün'e ait görsel linkleri bilgisi. |
| desi | hayır | Integer | Ürün'e ait Desi bilgisi |
| attributes | evet/hayır | List[Attribute] | Ürün'e ait Beymen Özellik bilgisi (kategori bazlı zorunlu attributelar ürün oluştururken eklenmelidir) |
| merchantColor | hayır | String | Ürün'e ait Satıcı Renk bilgisi |
| stockCode | hayır | String | Satıcıya ait stok kodu bilgisi |
Örnek ürün güncelleme 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": []
}
]
Toplu Ürün Güncelleme Sonuç Görüntüleme
Bu metod Beymen'de toplu ürün güncellemeden sonra işlem sonuçlarını görüntülemeyi sağlamaktadır.
HTTP Request
TEST ORTAM GET https://stage-partner-api.beymen.com/batch/products/{process_id}
PROD ORTAM 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."
}
]
Dönüş Değerleri
| Parametre | Tip | Açıklama |
|---|---|---|
| ResponseBody | Json(List[UpdateProductResponse]) | Ürün güncelleme sonuç Değerleri |
UpdateProductResponse
| Parametre | Tip | Açıklama |
|---|---|---|
| request | UpdateProduct | Güncellenmeye çalışılan ürüne ait bilgiler |
| productId | String | Güncellenen ürüne ait product id |
| isSuccess | Boolean | İşlem Durumu |
| processResult | String | Güncellenmek istenilen ürüne ait validasyon bilgisi |
Tekli Ürün Görüntüleme
Bu metod ürün oluşturma / güncelleme sonrası product Id ile ürünün detayını görüntülemeyi sağlamaktadır.
HTTP Request
TEST ORTAM GET https://stage-partner-api.beymen.com/products/{product_id}
PROD ORTAM 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"
}
Ürün Açma/Kapatma
Bu metod Beymen'de yüklemiş olduğunuz ürünlerinizi açıp kapatabilmenizi sağlamaktadır.
HTTP Request
TEST ORTAM PUT https://stage-partner-api.beymen.com/products/{productId}/status/onSale
PROD ORTAM PUT https://partner-api.beymen.com/products/{productId}/status/onSale
TEST ORTAM PUT https://stage-partner-api.beymen.com/products/{productId}/status/notOnSale
PROD ORTAM 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
Ürün Listeleme
Bu metod Beymen'de tanımlanmış ilgili durumdaki ürünlere erişmenizi sağlamaktadır.
HTTP Request
TEST ORTAM GET https://stage-partner-api.beymen.com/products
PROD ORTAM 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 Parametreleri
| Parametre | Zorunlu | Tip | Açıklama |
|---|---|---|---|
| size | hayır | Integer | Listelenecek ürün adeti. Varsayılan değer 10 |
| page | hayır | Integer | Listelenecek ürünün bulunduğu sayfa. Varsayılan değer 0 |
| barcode | hayır | String | Aratılmak istenilen barcode değeri |
| modelcode | hayır | String | Aratılmak istenilen modelcode değeri |
| brand | hayır | Integer | Aratılmak istenilen marka değeri |
| stockcode | hayır | String | Aratılmak istenilen stockcode değeri |
| status | hayır | Status | Aratılmak istenilen status değeri. |
| substatus | hayır | SubStatus | Aratılmak istenilen status değeri |
Status Değerleri
| Parametre | Açıklama |
|---|---|
| OnSales | Satışta |
| NotOnSale | Satışta Değil |
| OutOfStock | Stoğu Tükendi |
| WaitingBeymenApproval | Beymen Onayı Bekleniyor |
| WaitingRevised | Beymen Tarafından Revizeniz Bekleniyor |
| NotSelectedBeymen | Beymen Tarafından Reddedilen |
Sub Status Değerleri
| Parametre | Açıklama |
|---|---|
| DeactivatedByBeymen | Beymen tarafından ürün satışa kapatıldı |
| PriceMissing | Eksik fiyat |
| DeactivatedBySeller | Satıcı tarafından ürün satışa kapatıldı |
| DeactivatedByCriticalPriceChange | Kritik fiyat değişikliği nedeniyle ürün satışa kapatıldı |
| SellerActionNeeded | Satıcının aksiyonu beklenmektedir |
| WaitingForSelection | Beymen tarafından ürün seçki sürecindedir |
| WaitingForImageRevised | Beymen tarafından ürün görsel kontrol sürecindedir |
| WaitingForProductControl | Beymen tarafından ürün bilgileri kontrol ediliyor |
| StockOut | Stoğu Tükendi |
| DeactivatedByStoreClosed | Ürün mağaza kapatıldığı için satışa kapatılmıştır. |
Dönüş Değerleri
| Parametre | Tip | Açıklama |
|---|---|---|
| items | List[Product] | Ürün listesi |
| page | Integer | Hangi sayfaya ait sonuç dönüldüğü |
| itemsPerPage | Integer | Her requestte kac adet ürün olduğunun bilgisi |
| pageCount | Integer | Toplam sayfa adeti |
| total | Integer | Toplam ürün adeti |
Product
| Parametre | Tip | Açıklama |
|---|---|---|
| id | String | Ürüne ait id bilgisi |
| name | String | Ürüne ait başlık bilgisi |
| barcode | String | Ürüne ait barcode bilgisi |
| modelCode | String | Ürüne ait modelcode bilgisi |
| stockCode | String | Ürüne ait satıcıya özel stockcode bilgisi |
| brand | Brand | Ürüne ait Marka bilgisi |
| category | Category | Ürünnün bağlı Karegori bilgisi |
| description | String | Ürüne ait açıklama bilgisi |
| merchantColorCode | Color | Ürüne ait renk bilgisi |
| size | Size | Ürüne ait beden bilgisi |
| commission | Integer | Ürüne ait komisyon oranı |
| salesPrice | Price | Ürüne ait indirimsiz satış fiyat bilgisi |
| platformSalesPrice | Price | Ürüne ait Beymen satış fiyat bilgisi |
| vatRate | Integer | Ürüne ait KDV oranı bilgisi |
| desi | Double | Ürüne ait desi bilgisi |
| stock | Stock | Ürüne ait kalan stok bilgisi |
| status | Status | Ürünün güncel durumu |
| subStatus | SubStatus | Ürünün güncel alt durumu |
| images | List[Image] | Ürünün fotograflar bilgisi |
| revisionText | String | Ürün ile ilgili Beymen platformu tarafından istenilen değişikliklerin bilgisi |
Toplu Özellik Listeleme
Bu metod, Beymen'de kayıtlı olan markaları, cinsiyetleri, bedenleri ve renkleri sayfalama yapmaksızın tek bir liste haline erişebilmenizi sağlar.
Http Request
TEST ORTAM GET https://stage-partner-api.beymen.com/attributes/all?type=Brand
PROD ORTAM 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 Değerleri
| Parametre | Değer | Açıklama |
|---|---|---|
| Brand | 3 | Marka |
| Gender | 6 | Cinsiyet |
| Color | 23 | Beymen Renk |
| Size | 2 | Beden |
Markalar
Bu metod Beymen'de tanımlanmış markalara erişmenizi sağlamaktadır. Endpointlerde sorgu atarken pagination bulunmaktadır, itemsPerPage 100 olduğunda tüm markalar gelmemektedir, paginationdan ilerlenerek tüm markalara ulaşılabilir.
"page":0,"itemsPerPage":100,"pageCount":87,"total":8772} (örnektir, marka sayısı arttıkça total count değişecektir)
Http Request
TEST ORTAM GET https://stage-partner-api.beymen.com/attributes?type=Brand&size=100
PROD ORTAM 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
}
Dönüş Değerleri
| Parametre | Tip | Açıklama |
|---|---|---|
| items | List[Brand] | Marka listesi |
| page | Integer | Hangi sayfaya ait sonuç dönüldüğü |
| itemsPerPage | Integer | Her requestte kac adet marka olduğunun bilgisi |
| pageCount | Integer | Toplam sayfa adeti |
| total | Integer | Toplam marka adeti |
Brand
| Parametre | Tip | Açıklama |
|---|---|---|
| id | String | Markaya ait id bilgisi |
| value | String | Marka adı |
Cinsiyet
Bu metod Beymen'de tanımlanmış cinsiyet bilgilerine erişmenizi sağlamaktadır. Endpointlerde sorgu atarken pagination bulunmaktadır, itemsPerPage 2 olduğunda tüm cinsiyet değerleri gelmemektedir, paginationdan ilerlenerek tüm cinsiyet değerlerine ulaşılabilir.
"page":0,"itemsPerPage":2,"pageCount":5,"total":xx} (örnektir, cinsiyet değeri arttıkça total count değişecektir)
Http Request
TEST ORTAM GET https://stage-partner-api.beymen.com/attributes?type=Gender&size=5
PROD ORTAM 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
}
Dönüş Değerleri
| Parametre | Tip | Açıklama |
|---|---|---|
| items | List[Size] | Cinsiyet listesi |
| page | Integer | Hangi sayfaya ait sonuç dönüldüğü |
| itemsPerPage | Integer | Her requestte kac adet cinsiyet olduğunun bilgisi |
| pageCount | Integer | Toplam sayfa adeti |
| total | Integer | Toplam beden adeti |
Gender
| Parametre | Tip | Açıklama |
|---|---|---|
| id | String | Cinsiyete ait id bilgisi |
| value | String | Cinsiyet bilgisi |
Bedenler
Bu metod Beymen'de tanımlanmış beden bilgilerine erişmenizi sağlamaktadır. Endpointlerde sorgu atarken pagination bulunmaktadır, itemsPerPage 10 olduğunda tüm bedenler gelmemektedir, paginationdan ilerlenerek tüm bedenlere ulaşılabilir.
"page":0,"itemsPerPage":10,"pageCount":x,"total":xx} (örnektir, beden sayısı arttıkça total count değişecektir)
Http Request
TEST ORTAM GET https://stage-partner-api.beymen.com/attributes?type=Size&size=5
PROD ORTAM 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
}
Dönüş Değerleri
| Parametre | Tip | Açıklama |
|---|---|---|
| items | List[Size] | Beden listesi |
| page | Integer | Hangi sayfaya ait sonuç dönüldüğü |
| itemsPerPage | Integer | Her requestte kac adet beden olduğunun bilgisi |
| pageCount | Integer | Toplam sayfa adeti |
| total | Integer | Toplam beden adeti |
Size
| Parametre | Tip | Açıklama |
|---|---|---|
| id | String | Bedene ait id bilgisi |
| value | String | Beden bilgisi |
Renkler
Bu metod Beymen'de tanımlanmış renk bilgilerine erişmenizi sağlamaktadır. Endpointlerde sorgu atarken pagination bulunmaktadır, itemsPerPage 5 olduğunda tüm renkler gelmemektedir, paginationdan ilerlenerek tüm renklere ulaşılabilir.
"page":0,"itemsPerPage":5,"pageCount":x,"total":xx} (örnektir, renk sayısı arttıkça total count değişecektir)
Http Request
TEST ORTAM GET https://stage-partner-api.beymen.com/attributes?type=Color&size=5
PROD ORTAM 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
}
Dönüş Değerleri
| Parametre | Tip | Açıklama |
|---|---|---|
| items | List[Color] | Renk listesi |
| page | Integer | Hangi sayfaya ait sonuç dönüldüğü |
| itemsPerPage | Integer | Her requestte kac adet renk olduğunun bilgisi |
| pageCount | Integer | Toplam sayfa adeti |
| total | Integer | Toplam renk adeti |
Color
| Parametre | Tip | Açıklama |
|---|---|---|
| id | String | Renk ait id bilgisi |
| value | String | Renk bilgisi |
Kategoriler
Bu metod Beymen'de tanımlanmış kategori bilgilerine erişmenizi sağlamaktadır. Ürün çeşitliliği arttığı durumda yeni kategoriler eklenebileceği için güncel kategori listesini belirli periyotlarda almanızı öneririz.
Ürün yükleme işlemi yapmak için en alt kırılımdaki kategori ID kullanılmalıdır. Seçtiğiniz kategorinin alt kategorileri var ise (hasChild: true) bu kategori bilgisi ile ürün yükleme/güncelleme yapamazsınız.
Ana kategorileri aldıktan sonra hasChild: true olan kategorilerin alt kategorileri bulunmaktadır, bu alt kategorilere ulaşmak için aşağıdaki şekilde yol izleyebilirsiniz.
Örneğin Elektronik ana kategorisinin bir alt kırılımını almak istiyorsanız, Elektronik’in parentId'si ile bir alt kırılımlarına ulaşabilirsiniz,
https://partner-api.beymen.com/categories?parentId=96794
- hasChild: true olanların parentId'lerini alarak hasChild: false olana kadar en alt kırılımlara ilerleyebilirsiniz.
Http Request
TEST ORTAM GET https://stage-partner-api.beymen.com/categories
PROD ORTAM 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
}
İstek Parametreleri
| Parametre | Zorunlu | Tip | Açıklama |
|---|---|---|---|
| size | hayır | Integer | Listelenecek kategori adeti. Varsayılan değer 10 |
| page | hayır | Integer | Listelenecek kategori bulunduğu sayfa. Varsayılan değer 0 |
| parentId | hayır | String | Kategorinin üst kırılımının değeri |
| name | hayır | String | Aratıklmak istenilen isim değeri |
Dönüş Değerleri
| Parametre | Tip | Açıklama |
|---|---|---|
| items | List[Category] | Kategori listesi |
| page | Integer | Hangi sayfaya ait sonuç dönüldüğü |
| itemsPerPage | Integer | Her istekte kac adet kategori olduğunun bilgisi |
| pageCount | Integer | Toplam sayfa adeti |
| total | Integer | Toplam kategori adeti |
Category
| Parametre | Tip | Açıklama |
|---|---|---|
| id | String | Kategoriye ait id bilgisi |
| name | String | Kategori adı |
| hasChild | Boolean | Kategoriye ait alt mevcut kırılım bilgisi |
Kategori Ürün Özellikleri (Category Attributes)
Bu metod Beymen'de tanımlanmış kategori ürün özellikleri bilgilerine erişmenizi sağlamaktadır. Ürün çeşitliliği arttığı durumda yeni ürün özellikleri eklenebileceği için güncel kategori ürün özellikleri listesini belirli periyotlarda almanızı öneririz.
Ürün özellikleri en alt kırılımdaki kategori ID'lere tanımlanmaktadır. hasChild: false olan en alt kategori kırılımlarında ürün özelliklerini kontrol edip ürün yükleme ve güncelleme aşamalarında bu attribute Id'leri kullanabilirsiniz. Not: Her alt kategorinin attribute değeri bulunmamaktadır.
Http Request
TEST ORTAM GET https://stage-partner-api.beymen.com/categories/95729
PROD ORTAM 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"
}
Fiyat ve Stok Güncelleme
Bu metod Beymen'de tanımlanmış ilgili ürüne ait stok ve veya fiyat bilgisinin güncellenmesini sağlamaktadır.
HTTP Request
TEST ORTAM PUT https://stage-partner-api.beymen.com/products/{product_id}/price-stock
PROD ORTAM 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
}
}
}
İstek Parametreleri
| Parametre | Zorunlu | Tip | Açıklama |
|---|---|---|---|
| priceRequest | hayır | PriceRequest | Güncellenecek ürüne ait fiyat bilgileri |
| stockRequest | hayır | StockRequest | Güncellenecek ürüne ait stok bilgileri |
PriceRequest
| Parametre | Zorunlu | Tip | Açıklama |
|---|---|---|---|
| salesPrice | hayır | Price | Güncellenecek ürüne ait satış fiyat bilgileri |
| platformPrice | hayır | Price | Güncellenecek ürüne ait beymen satış bilgileri |
Price
| Parametre | Zorunlu | Tip | Açıklama |
|---|---|---|---|
| value | evet | Double | Fiyat Değeri |
| currency | evet | String | Kur Bilgisi |
StockRequest
| Parametre | Zorunlu | Tip | Açıklama |
|---|---|---|---|
| stock | evet | Stock | Güncellenecek ürüne ait stok bilgisi |
Stock
| Parametre | Zorunlu | Tip | Açıklama |
|---|---|---|---|
| count | evet | Integer | Stok adeti |
HTTP Response
Status Code 202
İngilizce Ürün Ekleme/Güncelleme
Bu metod Beymen'de tanımlanmış ilgili ürüne ait ingilizce bilgisinin güncellenmesini/eklenmesini sağlamaktadır.
HTTP Request
TEST ORTAM PUT https://stage-partner-api.beymen.com/products/{product_id}/language-definition
PROD ORTAM PUT https://partner-api.beymen.com/products/{product_id}/language-definition
{
"code":"en",
"name": "Yellow Tshirt",
"description": "This product will be happy you very much",
"merchantColor": "pink-yellow"
}
İstek Parametreleri
| Parametre | Zorunlu | Tip | Açıklama |
|---|---|---|---|
| code | evet | string | Güncellenecek ürüne ait hangi dilde ekleme yapılacağına ait kod bilgisi |
| name | evet | string | Güncellenecek ürüne ait ürün adının istenilen dildeki karşılığı |
| description | evet | string | Güncellenecek ürüne ait ürün açıklamasının istenilen dildeki karşılığı |
| merchantColor | evet | string | Güncellenecek ürüne ait ürün satıcı renginin istenilen dildeki karşılığı |
HTTP Response
Status Code 202
Sipariş Entegrasyonu
Bu bölümde Beymen'de sipariş yönetimi ile ilgili API dokümantasyonu bulunmaktadır.
Sipariş Listeleme
Bu method Beymen'de yaratılmış siparişlerinize ait bilgileri göstermektedir.
HTTP Request
TEST ORTAM GET https://stage-partner-api.beymen.com/orders
PROD ORTAM 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"
}
}
],
"page":0,
"itemsPerPage":20,
"pageCount":0,
"total":1
}
Query Parametreleri
| Parametre | Zorunlu | Tip | Açıklama |
|---|---|---|---|
| size | hayır | Integer | Listelenecek sipariş adeti. Varsayılan değer 10 |
| page | hayır | Integer | Listelenecek sipariş bulunduğu sayfa. Varsayılan değer 0 |
| orderNumber | hayır | String | Aratılmak istenilen sipariş numarası değeri |
| packetNo | hayır | String | Aratılmak istenilen paket numarası değeri(shipmentnumber) |
| barcode | hayır | Integer | Aratılmak istenilen barcode değeri |
| shipmentStatus | hayır | ShipmentStatus | Aratılmak istenilen sipariş durum değeri - örn: NewOrder |
| startDate | hayır | DateTime | Aratılmak istenilen sipariş başlangıç tarihi |
| endDate | hayır | DateTime | Aratılmak istenilen sipariş bitiş tarihi |
| subStatus | hayır | SubStatus | Aratılmak istenilen status değeri |
| fraudCheck | hayır | Boolean | Aratılmak istenilen fraud durumu |
ShipmentStatus Değerleri
| Parametre | Değer | Açıklama |
|---|---|---|
| NewOrder | 1 | Yeni Sipariş |
| ReadyToShip | 2 | Gönderime Hazır |
| Shipped | 4 | Gönderildi |
| DeliveredToCustomer | 8 | Müşteriye Teslim Edildi |
| Cancelled | 16 | İptal |
| Divided | 32 | Bölünmüş Paket |
Dönüş Değerleri
| Parametre | Tip | Açıklama |
|---|---|---|
| items | List[Order] | Sipariş listesi |
| page | Integer | Hangi sayfaya ait sonuç dönüldüğü |
| itemsPerPage | Integer | Her requestte kac adet ürün olduğunun bilgisi |
| pageCount | Integer | Toplam sayfa adeti |
| total | Integer | Toplam ürün adeti |
Order
| Parametre | Tip | Açıklama |
|---|---|---|
| id | String | Siparişe ait id bilgisi |
| merchantId | String | Siparişe ait Tedarikçi Id bilgisi |
| orderId | String | Platform Sipariş Id bilgisi |
| orderNumber | String | Platform Sipariş numarası |
| orderDate | DateTime | Sipariş Oluşma Tarihi |
| customerDeliveryDate | DateTime | Sipariş Teslimat Tarihi |
| shipmentNumber | String | Sevkiyat Numarası |
| shipmentProvider | String | Kargo firması |
| shipmentTrackingNumber | String | Sipariş takip numarası |
| customerName | String | Müşteri Adı |
| totalAmount | Double | Sipariş Toplam tutarı |
| totalVatAmount | Double | Sipariş KDV tutarı |
| currencyCode | String | Siparişe ait kur bilgisi |
| maxPermittedShippingTime | DateTime | Kargoya verilmesi gereken en son zaman |
| shipmentStatus | Integer | Sipariş status bilgisi numerik değeri |
| shipmentLines | List[ShipmentLine] | Siparişe ait teslimat kalemleri bilgisi |
| shipmentAddress | ShipmentAddress | Sipariş Teslimat Adresi |
| invoiceAddress | InvoiceAddress | Sipariş Fatura Adresi |
| canceledDateTime | DateTime | İptal Edilme Tarihi |
| merchantName | String | Satıcı Cari Ünvanı |
| companyName | String | Satıcı Mağaza Adı |
| fraudCheck | Boolean | Fraud kontrolü (Ödeme Bekleniyor) |
| fraudDate | DateTime | Fraud Kontrol Tarihi |
| isAlternativeDelivery | Boolean | Alternatif teslimat durumu |
ShipmentLine
| Parametre | Tip | Açıklama |
|---|---|---|
| id | String | Sipariş Kalemine ait Id bilgisi |
| status | String | Sipariş Kalemine durum bilgisi |
| productId | String | Sipariş Kalemine ait ürün Id |
| quantity | Integer | Sipariş Kalemine ait miktar |
| orderLineId | String | Sipariş Kalemine ait sipariş kalem Id |
| currencyCode | String | Sipariş Kalemine ait kur bilgisi |
| price | Double | Sipariş Kalemine ait fiyat bilgisi Id |
| vatAmount | Double | Sipariş Kalemine ait KDV bilgisi |
| commission | Double | Sipariş Kalemine ait komisyon bilgisi |
| desi | Integer | Sipariş Kalemine ait desi bilgisi |
| vatRate | Double | Sipariş Kalemine ait KDV oran bilgisi |
| gift | Boolean | Sipariş Kalemine ait hediye bilgisi |
| giftNote | String | Sipariş Kalemine ait hediye notu bilgisi |
| cancelReasonStatus | CancellationReason | Sipariş Kalemine ait iptal sebebi bilgisi |
| product | Product | Sipariş Kalemine ait ürün bilgileri |
ShipmentAddress
| Parametre | Tip | Açıklama |
|---|---|---|
| id | String | Teslimat Adres Id |
| customerName | String | Teslimat Müşteri ismi |
| company | String | Teslimat Firma ismi |
| address | String | Teslimat Adres bilgisi |
| cityCode | String | Teslimat Şehir kodu |
| city | String | Teslimat Şehir adı |
| districtCode | String | Teslimat İlçe kodu |
| district | String | Teslimat İlçe adı |
| neighborhoodCode | String | Teslimat Mahalle kodu |
| neighborhood | String | Teslimat Mahalle adı |
| postcode | String | Teslimat Posta kodu |
| phone | String | Teslimat Telefon numarası |
| String | Teslimat Eposta adresi |
InvoiceAddress
| Parametre | Tip | Açıklama |
|---|---|---|
| id | String | Fatura Adres Id |
| customerName | String | Fatura Müşteri ismi |
| company | String | Fatura Firma ismi |
| address | String | Fatura Adres bilgisi |
| cityCode | String | Fatura Şehir kodu |
| city | String | Fatura Şehir adı |
| districtCode | String | Fatura İlçe kodu |
| district | String | Fatura İlçe adı |
| neighborhoodCode | String | Fatura Mahalle kodu |
| neighborhood | String | Fatura Mahalle adı |
| postcode | String | Fatura Posta kodu |
| phone | String | Fatura Telefon numarası |
| String | Fatura Eposta adresi | |
| tcIdentityNumber | String | Fatura TC kimlik no |
| taxNumber | String | Fatura Vergi no |
| taxHouse | String | Fatura Vergi dairesi |
SellerAddress
| Parametre | Tip | Açıklama |
|---|---|---|
| name | String | Satıcı ismi |
| String | Satıcı Eposta adresi | |
| phone | String | Satıcı Telefon numarası |
| address | String | Satıcı Adres bilgisi |
| city | String | Satıcı Şehir adı |
| country | String | Satıcı Ülke kodu |
| cityCode | String | Satıcı Şehir kodu |
| district | String | Satıcı İlçe adı |
| neighborhood | String | Satıcı Mahalle adı |
| postCode | String | Satıcı Posta kodu |
| taxNo | String | Satıcı Vergi no |
Siparişi İşleme Alma (Picking Status İletilmesi)
Yeni Sipariş statusundeki bir siparişi Gönderime Hazır statusune geçirebilmek için (siparişi işleme almak) uygulanacak methoddur.
HTTP Request
TEST ORTAM PUT https://stage-partner-api.beymen.com/orders/{id}/status/picking
PROD ORTAM PUT https://partner-api.beymen.com/orders/{id}/status/picking
veya
TEST ORTAM PUT https://stage-partner-api.beymen.com/orders/{mpOrderId}/status/picking
PROD ORTAM PUT https://partner-api.beymen.com/orders/{mpOrderId}/status/picking
Siparişte Paket Bölme
Yeni Sipariş ve Gönderime Hazır statulerindeki bir siparişin teslimatlarının bölünebilmesi için uygulanacak methoddur. Bölme işleminde fbda506c-9ef5-451c-948c-ae5bb60215d0 ID'li üründen 2 adet ve 13078d8d-76d3-4bbb-93fd-2941be39d117 ID'li üründen 1 adet olacak şekilde yeni bir paket oluşacaktır ve eğer kalan ürünler varsa, bunlar için de başka bir paket oluşturulacaktır.
HTTP Request
TEST ORTAM POST https://stage-partner-api.beymen.com/orders/{id}/divide
PROD ORTAM POST https://partner-api.beymen.com/orders/{id}/divide
veya
TEST ORTAM POST https://stage-partner-api.beymen.com/orders/{mpOrderId}/divide
PROD ORTAM 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
Siparişte Çoklu Paket Bölme
Yeni Sipariş ve Gönderime Hazır statulerindeki bir siparişin teslimatlarının bölünebilmesi için uygulanacak methoddur. Bölme işleminde 1, 2 ve 3 numaralı orderLine'lar için bir paket, 4 numaralı orderLine için ayrı bir paket oluşturulacak, ve eğer kalan orderLine'lar varsa, bunlar için de üçüncü bir paket oluşturulacaktır.
HTTP Request
TEST ORTAM POST https://stage-partner-api.beymen.com/orders/{id}/divide/multiple
PROD ORTAM POST https://partner-api.beymen.com/orders/{id}/divide/multiple
veya
TEST ORTAM POST https://stage-partner-api.beymen.com/orders/{mpOrderId}/divide/multiple
PROD ORTAM POST https://partner-api.beymen.com/orders/{mpOrderId}/divide/multiple
HTTP Body
{
"orderLineGroups": [
{
"orderLineIds": [
"1", "2"," 3"
]
},
{
"orderLineIds": [
"4"
]
}
]
}
HTTP Response
Status Code 200
Not : Bölünen paketler "Divided" statüsüne alınır ve iptal edilir. Bölünmüş paketleri listelemek için 'shipmentNumber' ve 'shipmentStatus' parametreleri ile Siparişleri Listeleme endpointini kullanabilirsiniz.
Siparişin Alternatif Teslimat Yapılması (Alternative Delivery)
Yeni Sipariş ve Gönderime Hazır statulerindeki bir siparişin teslimatlarının alternatif teslimat yapılabilmesi için uygulanacak methoddur.
HTTP Request
TEST ORTAM PUT https://stage-partner-api.beymen.com/orders/{id}/alternativeDelivery
PROD ORTAM PUT https://partner-api.beymen.com/orders/{id}/alternativeDelivery
HTTP Body
{
"ShipmentTrackingUrl":"http://testurl",
"DeliveryType":0,
"ShipmentTrackingNumber":"123456",
"CargoCompanyCode": "YRTICI"
}
Body Değerleri
| Parametre | Tip | Açıklama |
|---|---|---|
| ShipmentTrackingUrl | String | Kargo Takip Url bilgisi |
| DeliveryType | DeliveryType | Gönderim tipi |
| ShipmentTrackingNumber | String | Kargoya ait takip numarası |
| CargoCompanyCode | String | Kargoya ait firma kodu Kargo firmaları için tıklayın |
AlternativeDeliveryTypes:
| Parametre | Açıklama |
|---|---|
| AlternativeCargoCompany | Beymen anlaşması olmayan farklı bir kargo firmasıyla göndermek istiyorum |
| AuthorizedService | Kendi aracımla veya yetkili servisle göndermek istiyorum |
public enum DeliveryType
{
AlternativeCargoCompany = 0
AuthorizedService = 1
}
HTTP Response
Status Code 200
Alternatif Teslimat ile Gönderilmiş Paketi Teslim Etme
Bu servisi, alternatif teslimat yöntemiyle Taşıma Durumunda statüsüne geçirilmiş ve ardından müşteriye teslim edilmiş siparişleri Teslim Edildi statüsüne güncellemek için kullanabilirsiniz.
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
Alternatif Teslimat İle Iade Gerçekleştirme
Bu servisi, alternatif teslimat yöntemiyle Taşıma Durumunda statüsüne geçirilmiş ancak müşteriye teslim edilemeyip deponuza geri dönmüş ve bu nedenle Teslim Edildi statüsüne geçirilememiş siparişler için kullanabilirsiniz.
Bu isteği kullandığınızda, sipariş müşteri iptali olarak işlem görecektir.
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
Siparişe Fatura Yükleme
Herhangi bir statüde olan siparişin teslimatlarının oluşturulan faturalarının yüklenebilmesi için uygulanacak methoddur. jpeg, jpg, png ve pdf formatlarında fatura yüklenebilir.
HTTP Request
TEST ORTAM POST https://stage-partner-api.beymen.com/orders/{id}/invoice
PROD ORTAM POST https://partner-api.beymen.com/orders/{id}/invoice
veya
TEST ORTAM POST https://stage-partner-api.beymen.com/orders/{mpOrderId}/invoice
PROD ORTAM 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
Siparişten Fatura Silme
Daha önce hatalı beslenen faturalar bu servis üzerinden silinip, Siparişe Fatura Yükleme servisi ile tekrar beslenebilmektedir.
HTTP Request
TEST ORTAM DELETE https://stage-partner-api.beymen.com/orders/{id}/invoice
PROD ORTAM DELETE https://partner-api.beymen.com/orders/{id}/invoice
veya
TEST ORTAM DELETE https://stage-partner-api.beymen.com/orders/{mpOrderId}/invoice
PROD ORTAM DELETE https://partner-api.beymen.com/orders/{mpOrderId}/invoice
HTTP Response
Status Code 200
İptal Listeleme
Bu metod Beymen Backoffice kullanıcısı, Satıcı veya Müşteri tarafından iptal edilen sipariş/siparişlere ait bilgileri göstermektedir. ShipmentStatus: Cancelled filtrelemesi yapılarak iptaller listelenebilir.
HTTP Request
TEST ORTAM GET https://stage-partner-api.beymen.com/orders?shipmentStatus=Cancelled
PROD ORTAM 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 Parametreleri
| Parametre | Zorunlu | Tip | Açıklama |
|---|---|---|---|
| size | hayır | Integer | Listelenecek sipariş adeti. Varsayılan değer 10 |
| page | hayır | Integer | Listelenecek sipariş bulunduğu sayfa. Varsayılan değer 0 |
| orderNumber | hayır | String | Aratılmak istenilen sipariş numarası değeri |
| shipmentNumber | hayır | String | Aratılmak istenilen paket numarası değeri |
| barcode | hayır | Integer | Aratılmak istenilen barcode değeri |
| shipmentStatus | hayır | ShipmentStatus | Aratılmak istenilen sipariş durum değeri (Cancelled olmalı) |
| startDate | hayır | DateTime | Aratılmak istenilen sipariş başlangıç tarihi |
| endDate | hayır | DateTime | Aratılmak istenilen sipariş bitiş tarihi |
| substatus | hayır | SubStatus | Aratılmak istenilen status değeri |
ShipmentStatus Değerleri
| Parametre | Değer | Açıklama |
|---|---|---|
| Cancelled | 16 | İptal |
Not 1: Teslim edilemeyen siparişleri isReturnedShipment parametresi ile takip edebilirsiniz. Bu parametre true ise sipariş müşteriye teslim edilememiştir.
Not 2 : Siparişler orderDate'e göre filtrelenirken, iptaller CanceledDateTime parametresine göre filtrelenmektedir.
Sipariş İptal Etme
Bu metod ile Satıcı tarafından sipariş iptali yapılabilmektedir.
HTTP Request
TEST ORTAM PUT https://stage-partner-api.beymen.com/orders/{id}/status/cancel
PROD ORTAM PUT https://partner-api.beymen.com/orders/{id}/status/cancel
HTTP Body
{
"products": [
{
"productId": "string",
"quantity": 0,
"cancelReasonStatus": 1,
"shipmentLineStatus": 1
}
]
}
CancelReasonStatus:
| Parametre | Açıklama |
|---|---|
| IntegrationFailed | Entegrasyon hatası |
| StockOut | Stok tükendi |
| WrongPrice | Hatalı fiyat |
| DefectiveOrFaultyProduct | Kusurlu/defolu/bozuk ürün |
| WrongImageOrBarcode | Hatalı görsel/barkod |
| ForceMajor | Mücbir sebep |
| Returned | Teslim Edilemedi |
public enum CancelReasonStatus
{
IntegrationFailed = 1,
StockOut = 2,
WrongPrice = 4,
DefectiveOrFaultyProduct = 8,
WrongImageOrBarcode = 16,
ForceMajor = 32,
Returned = 64
}
Entegrator firma olarak default shipmentLineStatus : 32 yollaması gerekmektedir.
shipmentLineStatusler
public enum ShipmentLineStatus
{
NewOrder = 1,
ReadyToShip = 2,
Shipped = 4,
DeliveredToCustomer = 8,
CancelledByBeymen = 16,
CancelledBySeller = 32,
CancelledByCustomer = 64,
Reorder = 128
}
Kısmi İptal Not : İki veya daha fazla ürün içeren siparişlerde ürünlerin en az 1 adedi satıcı veya müşteri tarafından iptal edildiğinde yani kısmi iptal yapıldığında siparişe ait sevkiyat kodu iptal edilmektedir ve sipariş içerisinde iptal edilmeyen ürünler için aynı sipariş numarası ile yeni bir sevkiyat yaratılmaktadır.
İade Listeleme
Bu metod Beymen iade bilgilerini göstermektedir.
HTTP Request
TEST ORTAM GET https://stage-partner-api.beymen.com/claims
PROD ORTAM 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 Parametreleri
| Parametre | Zorunlu | Tip | Açıklama |
|---|---|---|---|
| size | hayır | Integer | Listelenecek sipariş adeti. Varsayılan değer 10 |
| page | hayır | Integer | Listelenecek sipariş bulunduğu sayfa. Varsayılan değer 0 |
| orderNumber | hayır | String | Aratılmak istenilen sipariş numarası değeri |
| shipmentCode | hayır | String | Aratılmak istenilen kargo takip numarası değeri |
| shipmentNumber | hayır | String | Aratılmak istenilen paket numarası değeri |
| Status | hayır | ShipmentLineStatus | Aratılmak istenilen iade durum değeri (, , , , ) |
| shipmentStatus | hayır | ShipmentStatus | Aratılmak istenilen sipariş durum değeri |
| startDate | hayır | DateTime | Aratılmak istenilen iade başlangıç tarihi |
| endDate | hayır | DateTime | Aratılmak istenilen iade bitiş tarihi |
| customerName | hayır | string | Aratılmak istenilen müşterinin adı |
ShipmentStatus Değerleri
| Parametre | Değer | Açıklama |
|---|---|---|
| New | 0 | Yeni İade |
| ActionNeeded | 1 | Aksiyon Bekliyor |
| Approved | 2 | Onaylandı |
| Reject | 3 | Reddedildi |
| Dispute | 4 | İhtilaflı İade |
İadeye "Teslim Aldım" Aksiyonu Alınması
Bu metod iadenin teslim edildi statüsü kargodan gelmediği durumda satıcının iadeyi onaylama/sorun bildirme aksiyonlarını alabilmesi için iadeyi Aksiyon Bekleyenler statusune çekebilmesini sağlamaktadır.
HTTP Request
TEST ORTAM PATCH https://stage-partner-api.beymen.com/claims/{id}/receive
PROD ORTAM PATCH https://partner-api.beymen.com/claims/{id}/receive
HTTP Response
202 Accepted
İadenin Onaylanması
Bu metod Beymen'de gelen iadelerin onaylanmasını sağlamaktadır.
HTTP Request
TEST ORTAM PATCH https://stage-partner-api.beymen.com/claims/{id}/approve
PROD ORTAM PATCH https://partner-api.beymen.com/claims/{id}/approve
HTTP Body
[
{
"productId": "string",
"quantity": 1
}
]
HTTP Response
202 Accepted
İadenin Sorun Bildirilmesi (İhtilaflı İade)
Bu metod Beymen'de gelen iadelere sorun bildirilmesini sağlamaktadır.
HTTP Request
TEST ORTAM PATCH https://stage-partner-api.beymen.com/claims/{id}/dispute
PROD ORTAM PATCH https://partner-api.beymen.com/claims/{id}/dispute
HTTP Body
{
"items": [
{
"productId": "string",
"images": [
"string"
],
"reasonType": 0,
"quantity": 0,
"description": "string" // freetext zorunlu değil
}
]
}
HTTP Response
202 Accepted
Query Parametreleri
| Parametre | Zorunlu | Tip | Açıklama |
|---|---|---|---|
| productId | evet | String | İade sorun bildirilmesi istenen ürünün Id bilgisi |
| images | evet | String[] | PackageIsEmpty reasonType'ı dışında seçilen bütün tipler için resim zorunlu alandır |
| reasonType | evet | ReasonType | İade sorun bildirme nedeni |
| quantity | evet | Integer | İade sorun bildirilmesi istenen adet bilgisi |
| description | hayır | String | İade sorun bildirme detaylı açıklaması |
ReasonTypes:
| Parametre | Açıklama |
|---|---|
| ReceivedProductNotMine | Gelen ürün bana ait değil |
| ProductIsDefectiveOrDamaged | Gelen ürün defolu/zarar görmüş |
| ProductQuantityIsMissing | Gelen ürün adedi eksik |
| ProductIsWrong | Gelen ürün yanlış |
| ProductUsedOrOpenedPacking | Gelen ürün kullanılmış/ambalajı açılmış |
| ProductIsFake | Gelen ürün sahte |
| ProductPartIsMissing | Gelen ürünün parçası/aksesuarı eksik |
| ProductIsNotDefective | Gönderdiğim ürün kusurlu değil |
| ProductIsNotWrong | Gönderdiğim ürün yanlış değil |
| PackageIsEmpty | İade paketi boş geldi |
| PackageNotFound | İade paketi elime ulaşmadı |
| ExcessProductReceived | Müşteri gönderdiğim fazla ürünü iade etti |
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
}
Sipariş Statülerin Manuel İlerletilmesi
Bu method siparişlerinizin kargo statülerini ilerletmek istediğiniz zaman kullanılabilir.
HTTP Request
TEST ORTAM PUT https://stage-partner-api.beymen.com/orders/{id}/shipment/status
PROD ORTAM 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 Parametreleri
| Parametre | Zorunlu | Tip | Açıklama |
|---|---|---|---|
| trackingNumber | evet | String | Kargo durumunun takip edilmesi için gerekli kod. |
| trackingUrl | hayır | String | Kargonun durumunu takip edilmesi için gerekli url. |
| cargoCompanyCode | evet | String | Kargonun hangi firma tarafından gönderileceği bilgisi. Kargo firmaları için tıklayın |
| status | evet | Integer | Kargo durumu bilgisi. |
Status Değerleri
| Parametre | Değer | Açıklama |
|---|---|---|
| Shipped | 4 | Gönderildi |
| DeliveredToCustomer | 8 | Müşteriye Teslim Edildi |
| Undeliverable | 16 | Müşteriye Teslim Edilemedi |
Kargo Firmaları
| Code | Açıklama |
|---|---|
| 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 |
Finans Entegrasyonu
Bu bölümde Beymen'de finansal yönetimi ile ilgili API dokümantasyonu bulunmaktadır.
Günlük Kayıtlar
Bu metod Beymen'de ki finansal kayıtların bildirilmesini sağlamaktadır. Buradaki kayıtlar siparişi kalem bazlı gösterimini sağlar.
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 Parametreleri
| Parametre | Zorunlu | Tip | Açıklama |
|---|---|---|---|
| size | hayır | Integer | Listelenecek sipariş adeti. Varsayılan değer 10 |
| page | hayır | Integer | Listelenecek sipariş bulunduğu sayfa. Varsayılan değer 0 |
| orderNumber | hayır | String | Aratılmak istenilen sipariş numarası değeri |
| orderStartDate | hayır | DateTime | Aratılmak istenilen sipariş başlangıç tarihi |
| orderEndDate | hayır | DateTime | Aratılmak istenilen sipariş bitiş tarihi |
Dönüş Değerleri
| Parametre | Tip | Açıklama |
|---|---|---|
| items | List[FinancialTransaction] | Transaction listesi |
| page | Integer | Hangi sayfaya ait sonuç dönüldüğü |
| itemsPerPage | Integer | Her requestte kac adet ürün olduğunun bilgisi |
| pageCount | Integer | Toplam sayfa adeti |
| total | Integer | Toplam ürün adeti |
FinancialTransaction
| Parametre | Tip | Açıklama |
|---|---|---|
| id | String | Transactiona ait id bilgisi |
| merchantId | String | Transactiona ait Tedarikçi Id bilgisi |
| transactionNumber | String | Transactiona ait Sipariş Kalem Id bilgisi |
| transactionType | String | Transactiona ait tip bilgisi |
| orderNo | String | Transactiona ait Sipariş No bilgisi |
| orderDate | String | Transactiona ait Sipariş Tarihi bilgisi |
| transactionDate | String | Transactiona ait tarih bilgisi |
| amount | Double | Transactiona ait fiyat bilgisi |
| paymentPeriod | Integer | Tedarikçinin anlaştığı vade değeri |
Fatura Listeleme
Bu metod Beymen'de ki finansal fatuların bildirilmesini sağlamaktadır.
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 Parametreleri
| Parametre | Zorunlu | Tip | Açıklama |
|---|---|---|---|
| size | hayır | Integer | Listelenecek sipariş adeti. Varsayılan değer 10 |
| page | hayır | Integer | Listelenecek sipariş bulunduğu sayfa. Varsayılan değer 0 |
| invoiceTypes | hayır | Integer[] | Aratılmak istenilen fatura tipleri |
| startDate | hayır | DateTime | Aratılmak istenilen fatura başlangıç tarihi |
| endDate | hayır | DateTime | Aratılmak istenilen fatura bitiş tarihi |
InvoiceType Değerleri
| Parametre | Değer | Açıklama |
|---|---|---|
| Commission | 0 | Komisyon Faturası |
| Shipment | 1 | Kargo Faturası |
| InsufficientSupply | 2 | Tedarik Edememe Faturası |
| Delay | 3 | Gecikme Faturası |
| MissingProduct | 4 | Eksik / Kusurlu Ürün Faturası |
| Advertising | 5 | Reklam Faturası |
Dönüş Değerleri
| Parametre | Tip | Açıklama |
|---|---|---|
| items | List[Invoice] | Fatura listesi |
| page | Integer | Hangi sayfaya ait sonuç dönüldüğü |
| itemsPerPage | Integer | Her requestte kac adet fatura olduğunun bilgisi |
| pageCount | Integer | Toplam sayfa adeti |
| total | Integer | Toplam ürün adeti |
Invoice
| Parametre | Tip | Açıklama |
|---|---|---|
| id | String | Faturaya ait id bilgisi |
| merchantId | String | Faturaya ait Tedarikçi Id bilgisi |
| invoiceNumber | String | Faturaya numarası |
| invoiceTypeDescription | String | Faturaya ait tip bilgisinin açıklaması |
| invoiceType | String | Faturaya ait tip bilgisi |
| invoiceDate | String | Faturaya tarihi |
| paymentDate | String | Faturaya ödeme tarihi |
| amount | String | Faturaya ait fiyat bilgisi |
| couponPrice | String | Faturada kullanılan kupon bilgisi |
| eInvoiceUrl | String | Faturaya ait e-fatura url bilgisi |
| eInvoiceNumber | String | Faturaya ait e-fatura numarası bilgisi |
Fatura Detayı
Bu metod Beymen'de ki finansal faturanın detayını bildirilmesini sağlamaktadır.
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": "Satış",
"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": "İade",
"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
| Parametre | Tip | Açıklama |
|---|---|---|
| orderNo | String | Faturanın kalemine ait sipariş numarası bilgisi |
| shipmentType | String | Faturanın kalemine ait tip bilgisi |
| orderDate | String | Faturanın kalemine ait siparişin tarih bilgisi |
| transactionDate | String | Faturanın kalemine ait işlem tarihi bilgisi |
| shipmentNumber | String | Faturanın kalemine ait paket numarası bilgisi |
| quantity | String | Faturanın kalemine ait sayısı bilgisi |
| amount | String | Faturanın kalemine ait fiyat bilgisi |
| shipmentCost | String | Faturanın kalemine ait kargo maliyeti bilgisi |
| desi | String | Faturanın kalemine ait desi bilgisi |
| merchantName | String | Satıcı adı bilgisi |
| mpOrderId | String | Faturanın kalemine ait unique order id bilgisi |
Gelecek Ödemeler
Bu metod Beymen'de ki gelecek ödemelerinizin bildirilmesini sağlamaktadır.
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
| Parametre | Tip | Açıklama |
|---|---|---|
| totalSaleAmount | Double | Bu haftaki toplam satış tutarı bilgisi |
| commissionCut | Double | Bu haftaki toplam komisyon kesinti tutarı bilgisi |
| shipmentCut | Double | Bu haftaki toplam kargo kesinti tutarı bilgisi |
| penaltyCut | Double | Bu haftaki toplam ceza kesinti tutarı bilgisi |
| adCut | Double | Bu haftaki toplam reklam kesinti tutarı bilgisi |
| total | Double | Bu haftaki toplam hakediş tutarı bilgisi |
| futureTransactionActivities | FutureTransactionActivities | Gelecek haftalara ait hafta bazlı toplam hakediş tutarı bilgisi |
| historyTransactionActivities | HistoryTransactionActivities | Geçiş haftalara ait hafta bazlı toplam hakediş tutarı bilgisi |
| futureTotal | Double | Gelecek haftalara ait toplam hakediş tutarı bilgisi |
| lastUpdateDate | Datetime | Son son güncellenme tarihi bilgisi |
Ekstreler
Bu metod Beymen'de ki ekstrelerinizi listelemeyi sağlamaktadır.
HTTP Request
TEST ORTAM GET https://stage-partner-api.beymen.com/financial/statements?startDate=2023-08-01&endDate=2023-10-30
PROD ORTAM 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 Parametreleri
| Parametre | Zorunlu | Tip | Açıklama |
|---|---|---|---|
| startDate | evet | Date | Başlangıç Tarihi |
| endDate | evet | Date | Bitiş Tarihi |
Başlangıç ve Bitiş tarihleri arasında min 30 - max 90 gün olmalıdır.
Dönüş Değerleri
| Parametre | Açıklama |
|---|---|
| sellerCode | Beymendeki cari kodunuzdur. |
| documentDate | İlgili kaydın belge tarihinin oluşturulduğu tarihtir |
| documentDueDate | İlgili kaydın ödemesinin yapılacağı tarihtir. |
| documentAmount | İlgili kaydın hakedişinizi oluşturacak tutarıdır. |
| currencyLoc | TL |
| orderNo | Sipariş no parametresinde sipariş no hücresi dolu olan kayıtlar Satış veya İade kaydıdır. |
| description | Açıklama Parametresinde; 1- Kargo bedellerine ait fatura numaraları yer alır. 2- Satış ve İade kayıtları için Sipariş açıklaması yer alır. Sipariş açıklaması olan kayıtların tutar alanı eksi olan kayıtlar satış, artı olan kayıtlar ise iade kayıtlarıdır. |
| itemText | Metin parametresinde satıcı ünvanınızı içeren kayıtlar Beymen tarafından hesabınıza yapılan ödeme kayıtlarıdır. |