Get Order Packages (getShipmentPackages)
Get Order Packages
You can retrieve information about every order placed by customers, which corresponds to the products you have submitted to the Trendyol system and is in payment control, using this method. After the payment control by the system, the orders are automatically packaged, and order packages are created.
Order Inquiry and Sorting:
- You can send a maximum of 1000 requests to this service within one minute.
- Requests to the service will result in a response sorted by PackageLastModifiedDate.
- Querying by package status is possible using a query such as suppliers/(supplierid)/orders?status=Created. The available statuses are: Created, Picking, Invoiced, Shipped, Cancelled, Delivered, UnDelivered, Returned, Repack, UnPacked, UnSupplied.
- When fetching order information, packaging and processes should be performed based on the barcode values sent with createProducts for the respective products.
- You can query orders for the last three months using this service.
- The "merchantSku" field returned by the Order Retrieval service is derived from the "stockCode" field in the Product Creation service and can be verified using the filterProducts service.
Fields, Data Types, and Character Lengths:
- Field lengths and data types within the body may change with the natural increase in the number of orders. It is recommended to configure your system accordingly.
- orderNumber is represents the main order number in the Trendyol system. The corresponding id at the same level represents the created Order Package.
- customerId is a unique value assigned to the Trendyol customer account.
- deliveryAddressType can return as "Shipment" or "CollectionPoint." If it is "CollectionPoint," it is an order for delivery to a collection point.
- orderDate transmitted in Timestamp (milliseconds) format as GMT +3. The createdDate information is transmitted in GMT format. Pay attention to this information when performing the conversion.
- fastDeliveryType used for fast delivery information can take values such as "TodayDelivery," "SameDayShipping," "FastDelivery."
- The barcode used for the cargoTrackingNumber value in the Trendyol Seller Panel is in CODE128 format.
- Within the scope of Trendyol Export Partnership, we added the 3pByTrendyol field as a new field to our order package withdrawal service. The field is a boolean field. When the field value is true;
- The micro field will be false.
- Trendyol's company information will be included in the invoiceAddress data and invoices will be issued according to the information here.
Order Status Informations
- Orders with the "Awaiting" status should only be used for inventory-related operations. No other actions should be performed on orders in this status. Currently, necessary data is provided in the service response for orders in this status. Please note that in the future, this data may not be available.When you deliver orders in this status, there might be order cancellation processes, and Trendyol explicitly states that they do not accept responsibility for such cases.
- For canceled orders, you can use the "status=Cancelled,UnSupplied" parameter.
- For split orders, you can use the "status=UnPacked" parameter.
- If one or more items in an order package are canceled, the order package is broken, and a new ID and shipping barcode are generated while keeping the orderNumber the same.
Accessing Address Information:
-
You can access the ID values of Turkiye, Azerbaijani and GULF region address fields (city, district, neighborhood) returned by the order package retrieval service from Address Information.
-
In some cases, address fields in orders from the GULF Region may return empty. Especially if you have controls regarding district information, we kindly request you to remove it.
Country of Origin Information:
- For packages generated in micro export orders, it is necessary to add the country of origin information to the invoices. The country of origin information will be returned through the "productOrigin" data under the "lines" field.
Gold, Fertilizer, and High-Value Orders:
- For gold, fertilizer, or orders exceeding 5000₺, the TCKN number is transmitted in the "IdentityNumber" field.
Corporate Invoiced Orders:
-
To determine whether an order is corporate, check the "commercial" value in the order data.
-
If the "commercial" value returns as "true," it indicates that the order is a corporate order.
-
If the "commercial" value returns as "false," it indicates that the order belongs to an individual customer.
-
Corporate Invoice Information: If the order belongs to a corporate customer (commercial=true), you can retrieve the following information from the invoiceAddress field:
-
"company": Name of the company
-
"taxNumber": Tax number of the company
-
"taxOffice": Tax office to which the company is affiliated
-
E-Invoice Registration Check: To check if the corporate customer is registered for e-invoice, use the "eInvoiceAvailable" value in the invoiceAddress field.
-
If the "eInvoiceAvailable" value is "true," the customer is registered for e-invoice.
-
If the "eInvoiceAvailable" value is "false," the customer is not registered for e-invoice.
"createdBy" can get the values below:
- "order-creation" -> The package is created directly with the coming order
- "cancel" -> The package is created after partial cancellation
- "split" -> The package is created based on the package split
- "transfer" -> Orders that are directed to another seller by Trendyol because the seller who received the order does not have the product.
GET getShipmentPackages
If you do not use any parameter in the endpoint below, it returns you maximum one week order instead of all orders. If you use startDate and endDate parameters, the maximum allowable range is two weeks.
Recommended Endpoint
Service Parameters
| Parameter | Parameter Value | Explanation | Type |
|---|---|---|---|
| startDate | It fetches the next orders from a specific date. Must be sent as Timestamp | long | |
| endDate | It fetches orders up to the specified date. Must be sent as Timestamp. | long | |
| page | Only return information on the specified page | int | |
| size | Specifies the maximum number to list on a page. | int | |
| supplierId | ID information of the relevant supplier should be sent | long | |
| orderNumber | Only a specific order number is given to bring that order's information | string | |
| status | Created, Picking, Invoiced, Shipped, Cancelled, Delivered, UnDelivered, Returned, AtCollectionPoint, UnSupplied | Fetchs the information according to the status of orders. | string |
| orderByField | PackageLastModifiedDate | Based on the last update date. | string |
| orderByField | CreatedDate | Based on the order creation date. | string |
| orderByDirection | ASC | Sorts from old to new. | string |
| orderByDirection | DESC | Sorts from new to old. | string |
| shipmentPackageIds | Trendyol shipmentPackageIds | long |
Sample Service Response
{
"totalElements": 1,
"totalPages": 1,
"page": 0,
"size": 1,
"content": [
{
"shipmentAddress": {
"id": 11111111,
"firstName": "Trendyol",
"lastName": "Customer",
"company": "",
"address1": "DSM Grup Danışmanlık İletişim ve Satış Ticaret A.Ş. Maslak Mahallesi Saat Sokak Spine Tower No:5 İç Kapı No:19 Sarıyer/İstanbul",
"address2": "",
"city": "İstanbul",
"cityCode": 34,
"district": "Sarıyer",
"districtId": 54,
"countyId": 0, // for CEE region
"countyName": "", // for CEE region
"shortAddress": "", // for GULF region
"stateName": "", // for GULF region
"addressLines": {
"addressLine1": "",
"addressLine2": ""
},
"postalCode": "34200",
"countryCode": "TR",
"neighborhoodId": 21111,
"neighborhood": "Maslak Mahallesi",
"phone": null,
"fullAddress": "DSM Grup Danışmanlık İletişim ve Satış Ticaret A.Ş. Maslak Mahallesi Saat Sokak Spine Tower No:5 İç Kapı No:19 Sarıyer/İstanbul",
"fullName": "Trendyol Customer"
},
"orderNumber": "10654411111",
"grossAmount": 498.90,
"packageGrossAmount": 498.90,
"totalDiscount": 0.00,
"packageSellerDiscount": 0.00,
"totalTyDiscount": 0.00, // If commercial is true, it may return full, if false, it will return 0.
"packageTyDiscount": 0.00, // If commercial is true, it may return full, if false, it will return 0.
"packageTotalDiscount": 0.00,
"discountDisplays": [
{
"displayName": "Sepette %20 İndirim",
"discountAmount": 100
},
{
"displayName": "Trendyol Plus'a Özel Fiyat",
"discountAmount": 67.2
},
{
"displayName": "Sepette %50 İndirim",
"discountAmount": 500
},
{
"displayName": "Sepette %30 İndirim",
"discountAmount": 60
}
],
"taxNumber": null,
"invoiceAddress": {
"id": 11111112,
"firstName": "Trendyol",
"lastName": "Customer",
"company": "", // Orders from the GULF region may be empty.
"address1": "DSM Grup Danışmanlık İletişim ve Satış Ticaret A.Ş. Maslak Mahallesi Saat Sokak Spine Tower No:5 İç Kapı No:19 Sarıyer/İstanbul",
"address2": "",
"city": "İstanbul",
"cityCode": 0,
"district": "Sarıyer", // Orders from the GULF region may be empty.
"districtId": 54,
"countyId": 0, // It will available for the CEE region.
"countyName": "", // It will available for the CEE region.
"shortAddress": "", // It will available for the GULF region.
"stateName": "", // It will available for the GULF region.
"addressLines": {
"addressLine1": "",
"addressLine2": ""
},
"postalCode": "", // Orders from the GULF region may be empty.
"countryCode": "TR",
"neighborhoodId": 0,
"phone": null,
"latitude": "11.111111",
"longitude": "22.222222",
"fullAddress": "DSM Grup Danışmanlık İletişim ve Satış Ticaret A.Ş. Maslak Mahallesi Saat Sokak Spine Tower No:5 İç Kapı No:19 Sarıyer/İstanbul",
"fullName": "Trendyol Customer",
"taxOffice": "Company of OMS's Tax Office", // If it is not a corporate invoice (commercial=false), it will not be returned in the body.
"taxNumber": "Company of OMS's Tax Number" // If it is not a corporate invoice (commercial=false), it will not be returned in the body.
},
"customerFirstName": "Trendyol",
"customerEmail": "[email protected]",
"customerId": 1451111111,
"supplierId": 2738,
"customerLastName": "Customer",
"id": 33301111111,
"shipmentPackageId": 3330111111,
"cargoTrackingNumber": 7280027504111111,
"cargoTrackingLink": "https://tracking.trendyol.com/?id=111111111-1111-1111-1111-11111111",
"cargoSenderNumber": "210090111111",
"cargoProviderName": "Trendyol Express",
"lines": [
{
"quantity": 1,
"salesCampaignId": 11,
"productSize": "Tek Ebat",
"merchantSku": "111111",
"sku": "8683771111111",
"stockCode": "111111",
"productName": "Kuş ve Çiçek Desenli Tepsi - Yeşil / Altın Sarısı - 49 cm, 01SYM134, Tek Ebat",
"productCode": 1239111111,
"contentId": 1239111111,
"productOrigin": "TR",
"merchantId": 2738,
"sellerId": 2738,
"amount": 498.90,
"lineGrossAmount": 498.90,
"discount": 0.00,
"lineTotalDiscount": 0.00,
"lineSellerDiscount": 0.00,
"tyDiscount": 0.00,
"lineTyDiscount": 0.00,
"discountDetails": [
{
"lineItemPrice": 498.90,
"lineItemDiscount": 0.00,
"lineItemSellerDiscount": 0.00,
"lineItemTyDiscount": 0.00
}
],
"currencyCode": "TRY",
"productColor": "Yeşil",
"id": 4765111111,
"lineId": 4765111111,
"vatBaseAmount": 20.00,
"vatRate": 20.00,
"barcode": "8683772071724",
"orderLineItemStatusName": "Delivered",
"price": 498.90,
"lineUnitPrice": 498.90,
"fastDeliveryOptions": [],
"productCategoryId": 2710,
"commission": 13
"cancelledBy": "",
"cancelReason": "",
"cancelReasonCode":
}
],
"orderDate": 1762253333685,
"identityNumber": "11111111111",
"currencyCode": "TRY",
"packageHistories": [
{
"createdDate": 1762242537624,
"status": "Awaiting"
},
{
"createdDate": 1762242543616,
"status": "Created"
},
{
"createdDate": 1762246983623,
"status": "Invoiced"
},
{
"createdDate": 1762246983623,
"status": "Picking"
},
{
"createdDate": 1762352727000,
"status": "Shipped"
},
{
"createdDate": 1762860180000,
"status": "Delivered"
}
],
"shipmentPackageStatus": "Delivered",
"status": "Delivered",
"whoPays": 1, // If it is a seller agreement, 1 comes, if it is a trendyol agreement, the buyer does not come.
"deliveryType": "normal",
"timeSlotId": 0,
"estimatedDeliveryStartDate": 1762858136000,
"estimatedDeliveryEndDate": 1763030936000,
"totalPrice": 498.90,
"packageTotalPrice": 498.90,
"deliveryAddressType": "Shipment",
"agreedDeliveryDate": 1762376340000,
"fastDelivery": false,
"originShipmentDate": 1762242537619,
"lastModifiedDate": 1762865408581,
"commercial": false,
"fastDeliveryType": "",
"deliveredByService": false,
"warehouseId": 372389,
"invoiceLink": "https://efatura01.evidea.com/11111111111",
"micro": true,
"giftBoxRequested": false,
"3pByTrendyol": false,
"etgbNo": "25341453EX025864", // When micro is true, information will be returned for the etgbNo field.
"etgbDate": 1762646400000, // When micro is true, information will be returned for the etgbDate field.
"containsDangerousProduct": false, // In micro export orders, if there are any dangerous products in the package received by the seller, such as batteries, perfume, etc., it will return true.
"cargoDeci": 10,
"isCod": false,
"createdBy": "order-creation", // Indicates how the package was created, can be "order-creation", "split", "cancel" or "transfer"
"originPackageIds": null, // This field is populated after cancellation or splitting operations and gives the packageid of the first package after these operations.
"hsCode": "711111000000" // This field will return as a string for micro orders.
}
]
}Package Status
| Service | Definition |
|---|---|
| orderDate | When the customer creates the order on trendyol.com. |
| Awaiting | It returns when the payment is waiting the confirm. (You should not take any action until these orders with this status change to "Created" status. You can use this status only for stock updates.) |
| Created | When the payment confirm accepted it returns when the order is ready for shipment. |
| Picking | It is a status that can be communicated by you. You can forward it when you start collecting the order or when you start preparing the package. |
| Invoiced | This is the status that you can forward to us when you make out an invoice. |
| Shipped | Orders that move into transport status are specified in this status. |
| AtCollectionPoint | The product is at the relevant PUDO delivery point. The customer is expected to go to the PUDO point and pick it up. |
| Cancelled | These are cancelled orders. Also includes unsupplied orders. |
| UnPacked | Orders that splitted. |
| Delivered | Orders that delivered. No status changes can be made after this status. |
| UnDelivered | It returns when the order cannot be delivered to the customer. |
| Returned | It returns that the order that does not delivered the customer is returned to the supplier. No status changes can be made after this status. |
You can distinguish the cargo company name from the first 3 digits of the number in the "cargoTrackingNumber" field in the response of the order service. You can reach the related values from the table below.
| Cargo Company | First 3 Digits Number |
|---|---|
| Trendyol Express | 733 |
| Yurtiçi Kargo | 725 |
| Aras Kargo | 726 |
| Sürat Kargo | 727 |
| MNG Kargo | 728 |
| UPS Kargo | 729 |
| Alternatif Teslimat | 732 |
| PTT Kargo | 734 |
| Horoz Lojistik | 984 -> It will change with 884 after 16.12.2021 |
Country code information for micro export orders
| Country | Country Code |
|---|---|
| Saudi Arabia | SA |
| United Arab Emirates | AE |
| Qatar | QA |
| Kuwait | KW |
| Oman | OM |
| Bahrain | BH |
| Azerbaijan | AZ |
| Slovakia | SK |
| Romania | RO |
| Czechia | CZ |
Updated 10 days ago