POST/v1/orders/claims

Yeni İade / Değişim Talebi Oluştur

Yeni İade / Değişim talebi oluşturmak için gerekli parametreler aşağıdaki tabloda belirtilmiştir.

  • Name
    orderId* zorunlu
    Type
    int
    Description

    Sipariş ID bilgisidir. Labs API ile oluşturduğunuz siparişin uniqeu id bilgisidir.

  • Name
    platformClaimId
    Type
    string
    Description

    Platformunuza ait iade id bilgisidir.

  • Name
    items
    Type
    array
    Description

    İade talebi oluşturacağınız ürün bilgilerini içeren datadır.

  • Name
    items.*.orderLineId
    Type
    int
    Description

    Sipariş oluşturma servisi ile size dönen ürünün labs API sipariş ürün id bilgisidir.

  • Name
    items.*.platformClaimLineId
    Type
    string
    Description

    Platformunuza ait iade ürün id bilgisidir.

  • Name
    items.*.barcode* zorunlu
    Type
    string
    Description

    Ürün barkod bilgisidir.

  • Name
    items.*.quantity* zorunlu
    Type
    float
    Description

    Ürün için talep edilen iade adet bilgisidir.

  • Name
    items.*.claimType* zorunlu
    Type
    string
    Description

    İade / Değişim talebi tip bilgisidir.

    İade / Değişim Tipi:

    • return - İade talebi
    • exchange - Değişim talebi
  • Name
    items.*.claimReason
    Type
    string
    Description

    İade / Değişim Talebi açıklama bilgisidir.

  • Name
    items.*.warehouseNote
    Type
    string
    Description

    Ürün depoya / mağazaya ulaştığında depo elemanının eklediği not bilgisidir.

Request

POST
/v1/orders/claims
curl --location --request POST 'https://api.labsoffice.com/v1/orders/claims' \
--header 'Authorization: Bearer {API_TOKEN}'
--header 'Content-Type: application/json' \
--data-raw '{
                "orderId": 3301177,
                "platformClaimId": "234532523",
                "items": [
                    {
                        "platformClaimLineId": "234234999990",
                        "orderLineId": 16098414,
                        "barcode": "3264680014888",
                        "quantity": 3,
                        "claimType": "return",
                        "claimReason": "test iade",
                        "warehouseNote": "Ürün temiz"
                    }
                ]
            }'

Response

{
        "status" : "success",
        "message": "İade / Değişim oluşturma işlemi başarılı.",
        "payload":  "items": 
                 [
                     {
                        "orderId": 3301177,
                        "platformClaimId": "234532523",
                        "platformClaimLineId": "234234999990",
                        "orderLineId": 16098414,
                        "barcode": "3264680014888",
                        "quantity": 3,
                        "rejectDetails": null,
                        "claimType": "return",
                        "claimReason": "test iade",
                        "warehouseNote": "Ürün temiz"
                    }
                 
                 ]
}
PUT/v1/orders/claims

İade / Değişim Talebi Güncelle

Yeni İade / Değişim talebi güncellemek için gerekli parametreler aşağıdaki tabloda belirtilmiştir.

  • Name
    orderId* zorunlu
    Type
    int
    Description

    Sipariş ID bilgisidir. Labs API ile oluşturduğunuz siparişin uniqeu id bilgisidir.

  • Name
    platformClaimId
    Type
    string
    Description

    Platformunuza ait iade id bilgisidir.

  • Name
    items
    Type
    array
    Description

    İade talebi oluşturacağınız ürün bilgilerini içeren datadır.

  • Name
    items.*.orderLineId
    Type
    int
    Description

    Sipariş oluşturma servisi ile size dönen ürünün labs API sipariş ürün id bilgisidir.

  • Name
    items.*.platformClaimLineId
    Type
    string
    Description

    Platformunuza ait iade ürün id bilgisidir.

  • Name
    items.*.barcode* zorunlu
    Type
    string
    Description

    Ürün barkod bilgisidir.

  • Name
    items.*.quantity* zorunlu
    Type
    float
    Description

    Ürün için talep edilen iade adet bilgisidir.

  • Name
    items.*.claimType* zorunlu
    Type
    string
    Description

    İade / Değişim talebi tip bilgisidir.

    İade / Değişim Tipi:

    • return - İade talebi
    • exchange - Değişim talebi
  • Name
    items.*.claimReason
    Type
    string
    Description

    İade / Değişim Talebi açıklama bilgisidir.

  • Name
    items.*.warehouseNote
    Type
    string
    Description

    Ürün depoya / mağazaya ulaştığında depo elemanının eklediği not bilgisidir.

Request

POST
/v1/products
curl --location --request POST 'https://api.labsoffice.com/v1/orders/claims' \
--header 'Authorization: Bearer {API_TOKEN}'
--header 'Content-Type: application/json' \
--data-raw '{
                "orderId": 3301177,
                "platformClaimId": "234532523",
                "items": [
                    {
                        "platformClaimLineId": "234234999990",
                        "orderLineId": 16098414,
                        "barcode": "3264680014888",
                        "quantity": 3,
                        "claimType": "return",
                        "claimReason": "test iade",
                        "warehouseNote": "Ürün temiz"
                    }
                ]
            }'

Response

{
        "status" : "success",
        "message": "İade / Değişim güncelleme işlemi başarılı.",
        "payload":  "items": 
                 [
                     {
                        "orderId": 3301177,
                        "platformClaimId": "234532523",
                        "platformClaimLineId": "234234999990",
                        "orderLineId": 16098414,
                        "barcode": "3264680014888",
                        "quantity": 3,
                        "rejectDetails": null,
                        "claimType": "return",
                        "claimReason": "test iade",
                        "warehouseNote": "Ürün temiz"
                    }
                 
                 ]
}
GET/v1/orders/claims

İade / Değişim talebi Listesi

Bu servis aracılığı ile Labs platformu üzerinde oluşturulan iade / değişim taleblerini listeleyebilirsiniz.

Servis pagination ile çalışmaktadır. page ve limit parametrelerinin gönderilmesi zorunludur. Filtreleme yapabilmek için gerekli parametreler aşağıdaki tabloda belirtilmiştir.

Optional attributes

  • Name
    page
    Type
    integer
    Description

    Mevcut sayfa bilgisi

  • Name
    limit
    Type
    integer
    Description

    Sayfa başına düşen içerik sayısı

  • Name
    orderId
    Type
    string
    Description

    Sipariş ID bilgisidir. Labs API ile oluşturduğunuz siparişin uniqeu id bilgisidir.

  • Name
    platformClaimId
    Type
    string
    Description

    Platformunuza ait iade id bilgisidir.

  • Name
    claimType
    Type
    string
    Description

    Sipariş statü bilgisi return, exchange

  • Name
    createdStartAfter
    Type
    string
    Description

    Başlangıç tarih bilgisi Örnek format : 2023-11-29

  • Name
    updatedStartAfter
    Type
    string
    Description

    Güncelleme tarih bilgisi Örnek format : 2023-11-29

Request

GET
/v1/orders/claims
curl --location --request GET 'https://api.labsoffice.com/v1/orders/claims?page=1&limit=10' \
--header 'Authorization: Bearer {API_TOKEN}'

Response

{
"items": [
    {
        "id": 61126,
        "orderId": 3301177,
        "orderLineId": 16098414,
        "platformClaimId": "234532523",
        "platformClaimLineId": "234234999990",
        "quantity": "3.00",
        "claimStatus": "PENDING_PAYMENT",
        "rejectDetails": null,
        "claimType": "return",
        "claimReason": "test iade",
        "warehouseNote": "Ürün temiz",
        "createdAt": "09/07/2024 10:52:02"
    }
],
"totalItems": 1,
"totalPage": 1,
"currentPage": 1,
"limit": 10
}
POST/v1/orders/claims/status

İade / Değişim Durumu Güncelleme

Bu servis aracılığı ile Labs platformunda daha önce oluşturulan bir iade / değişim talebi statüsünü ilerletebilirsiniz.

  • Name
    orderId* zorunlu
    Type
    int
    Description

    Sipariş ID bilgisidir. Labs API ile oluşturduğunuz siparişin uniqeu id bilgisidir.

  • Name
    orderLineId
    Type
    int
    Description

    Sipariş oluşturma servisi ile size dönen ürünün labs API sipariş ürün id bilgisidir.

  • Name
    platformClaimId
    Type
    string
    Description

    Platformunuza ait iade id bilgisidir.

  • Name
    platformClaimLineId
    Type
    string
    Description

    Platformunuza ait iade ürün id bilgisidir.

  • Name
    statusCode* zorunlu
    Type
    string
    Description

    İade / Değişim statü kodu bilgisidir.

İade / Değişim Durum Kodları (statusCode)

[
    
    PENDING => 'İşleme Al',
    APPROVE => 'Onayla',
    PAYMENT_APPROVE => 'Ödemeyi Onayla',
    COMPLETED => 'Tamamlandı',
    REJECTED => 'Reddet'
]

Request

POST
/v1/orders/claims/status
curl --location --request POST 'https://api.labsoffice.com/v1/orders/claims/status' \
--header 'Authorization: Bearer {API_TOKEN}'
--header 'Content-Type: application/json' \
--data-raw '{
        "orderId" : 3301177,
        "orderLineId" :"",
        "platformClaimId" :"",
        "platformClaimLineId" :"",
        "statusCode": "APPROVE"
}'

Response

{
    "status": "success",
    "message": "İade / Değişim statü güncelleme işlemi başarılı.",
     "payload":  "items": 
                         [
                             {
                                "orderId": 3301177,
                                "platformClaimId": "234532523",
                                "platformClaimLineId": "234234999990",
                                "orderLineId": 16098414,
                                "barcode": "3264680014888",
                                "quantity": 3,
                                "rejectDetails": null,
                                "claimType": "return",
                                "claimReason": "test iade",
                                "warehouseNote": "Ürün temiz"
                            }
                         
                         ]
}
DELETE/v1/orders/claims/{id}

İade / Değişim Talebi Sil

Bu servis aracılığı ile Labs platformundaki mevcut iade / değişim talebi bilgilerinizi silebilirsiniz.

Request

DELETE
/v1/orders/claims/{id}
curl --location --request DELETE 'https://api.labsoffice.com/v1/orders/claims/2021' \
--header 'Authorization: Bearer {API_TOKEN}'
--header 'Content-Type: application/json' \

Response

{
    "status": "success",
    "message": "İade / Değişim talebi başarılı bir şekilde silindi."
}