Siparişin gönderilerini ve etiket/takip bilgilerini alma

  • Propars'tan gönderilen sipariş bilgisi için kargo takip ve etiket bilgilerini senkron olarak dönmeyen, bu bilgileri almak için Propars'ın kargo platfomuna periyodik olarak sorgu yaptığı senaryolarda, sonradan oluşacak olan bu etiket ve takip bilgilerini alabilmek için periyodik olarak sipariş kargo gönderileri servisine sorgu yapılır.

Endpoint: /api/v1/shipping/sale_shipping_context/<sale id>/

Method: GET

Response:

{
    "sale_shipments": [
        {
            "id": 14,
            "mp_cargo_info_support": true,
            "can_send_mp_cargo_info": false,
            "can_send_shipment_data": true,
            "order_number": "order-123",
            "customer_name": null,
            "sale_items_detail": [
                {
                    "product_name": "Sipariş satırı ürün adı",
                    "product_code": "889-22-7697-665-11-9593",
                    "barcode": "727-09-9954-796-85-1898",
                    "quantity": 3.0,
                    "price": 6700.194939
                }
            ],
            "offer_name": "PTS Flex",
            "offer_code": "L",
            "origin_country": "TR",
            "parcel": "1",
            "price": "8.2377",
            "ddp": "1",
            "eori_number": "12345",
            "ioss_number": "IM2760000742",
            "vat_number": null,
            "payment_type": "1",
            "doc_type": "3",
            "auto_send_mp_cargo_info": false,
            "create_time": "2024-07-25T17:38:00.607977Z",
            "update_time": "2024-07-25T17:38:00.607989Z",
            "uuid": "c8e9ff98-ce24-4609-a9c7-b7504e96863f",
            "shipment_provider_code": null,
            "destination_country": "DE",
            "tracking_code": null,
            "tracking_url": null,
            "carrier_name": null,
            "ticket_url": null,
            "waybill_url": null,
            "ticket_printed": false,
            "waybill_printed": false,
            "shipping_status": "PENDING",
            "sending_time": null,
            "error_message": null,
            "ticket_status": "PENDING",
            "ticket_error_message": null,
            "mp_cargo_info_id": null,
            "mp_cargo_info_status": "PENDING",
            "mp_error_message": null,
            "custom_invoice_number": "ABC2024012345678",
            "custom_invoice_date": "2024-07-01",
            "custom_invoice_pdf_url": "https://ornek.com/fatura.pdf"
            "currency": 3,
            "sale": 353,
            "mp_cargo_info_model": null,
            "account": 1,
            "warehouse": null,
            "sale_items": [
                677
            ],
            "provider_key": "pts"
        }
    ],
    "items": [
        {
            "id": 677,
            "product_name": Sipariş satırı ürün adı",
            "product_code": "889-22-7697-665-11-9593",
            "warehouse": null,
            "shipping_context": {
                "has_live_shipments": true,
                "shipments": [
                    {
                        "id": 14,
                        "mp_cargo_info_support": true,
                        "can_send_mp_cargo_info": false,
                        "can_send_shipment_data": true,
                        "order_number": "order-123",
                        "customer_name": null,
                        "sale_items_detail": [
                            {
                                "product_name": "Sipariş satırı ürün adı",
                                "product_code": "889-22-7697-665-11-9593",
                                "barcode": "727-09-9954-796-85-1898",
                                "quantity": 3.0,
                                "price": 6700.194939
                            }
                        ],
                        "offer_name": "PTS Flex",
                        "offer_code": "L",
                        "origin_country": "TR",
                        "parcel": "1",
                        "price": "8.2377",
                        "ddp": "1",
                        "eori_number": "12345",
                        "ioss_number": "IM2760000742",
                        "vat_number": null,
                        "payment_type": "1",
                        "doc_type": "3",
                        "auto_send_mp_cargo_info": false,
                        "create_time": "2024-07-25T17:38:00.607977Z",
                        "update_time": "2024-07-25T17:38:00.607989Z",
                        "uuid": "c8e9ff98-ce24-4609-a9c7-b7504e96863f",
                        "shipment_provider_code": null,
                        "destination_country": "DE",
                        "tracking_code": null,
                        "tracking_url": null,
                        "carrier_name": null,
                        "ticket_url": null,
                        "waybill_url": null,
                        "ticket_printed": false,
                        "waybill_printed": false,
                        "shipping_status": "PENDING",
                        "sending_time": null,
                        "error_message": null,
                        "ticket_status": "PENDING",
                        "ticket_error_message": null,
                        "mp_cargo_info_id": null,
                        "mp_cargo_info_status": "PENDING",
                        "mp_error_message": null,
                        "custom_invoice_number": "ABC2024012345678",
                        "custom_invoice_date": "2024-07-01",
                        "custom_invoice_pdf_url": "https://ornek.com/fatura.pdf"
                        "currency": 3,
                        "sale": 353,
                        "mp_cargo_info_model": null,
                        "account": 1,
                        "warehouse": null,
                        "sale_items": [
                            677
                        ],
                        "provider_key": "pts"
                    }
                ],
                "available_sending_nodes": []
            }
        }
    ]
}

Aynı siparişin farklı satırlarının farklı kargolarla gönderilebilme senaryosunu da kapsayabilmek adına dönülen cevapta siparişin tüm gönderileri "sale_shipments" alanında listelenirken sipariş satırlarının her biri ve o satırın konu olduğu gönderiler "items" altında dönülmektedir.

Burada dönülen shipment objelerinin bazı alanlarının açıklaması şöyledir:

  • shipment_provider_code: Gönderi için kargo platformundan alınan identifier
  • shipping_status: Gönderinin Propars'tan kargo sağlayıcıya iletilme durumu (PENDING, SENT, FAILED, CANCELLED değerlerini alabilmekte)
  • error_message: Gönderim sırasında hata oluştuğunda (shipping_status=FAILED) hata detayı bu alanda olacak.
  • ticket_status: Gönderi için kargo platformunda etiket oluşturulma durumu (PENDING, CREATED, FAILED değerlerini alabilmekte)
  • ticket_error_message: Etiket oluşturma sırasında hata oluşursa (ticket_status=FAILED) hata detayı bu alanda olacak.
  • tracking_code: Kargo takip kodu
  • tracking_url: Kargo takip urli
  • carrier_name: Kargo taşıcı adı
  • ticket_url: Etiket pdf url
  • waybill_url: Konşimento pdf url

Sipariş için kargo gönderisi durumu sorgusu yapıldığında dönülen shipment objesinde shipping_status=SENT, ticket_status=CREATED ise ticket_url'in de dolu olacağı beklenebilir. tracking_code ve tracking_url bilgileri bazı senaryolarda kargo platformunun çalışma mantığına göre Propars sistemine daha geç yansıyabilmektedir.