2. Get Shipment Packages
This method allows you to retrieve information about each customer order for the products you've listed on the Trendyol system. After the system conducts payment verification, the orders are automatically packaged and processed to create order packages.
Key Information:
- Use "storeFrontCode" as the Header Parameter.
- A maximum of 1000 requests per minute is allowed.
- You can conduct retrospective order queries for up to three months using this service.
- Responses from the getShipmentPackages service are sorted based on the PackageLastModifiedDate.
- The character count and data types in the body may evolve with the natural increase in order volume. It is advisable to adjust your system accordingly.
- "merchantSku" in the order data corresponds to "stockCode" in product data, which can be verified in the filterProducts service.
- Orders with "Awaiting" status should only be used for stock transactions. No other action should be taken for orders with this status. Currently, the necessary data is transmitted to you in the service response for orders with this status. However, this data will not be returned to you in the future. Please note that delivering orders with this status to the courier may result in order cancellation transactions, and Trendyol does not accept responsibility for this.
- "Picking" status is used for showing customer that the package is preparing.
- "Invoiced" status is an optional status which can be set before "Shipping"
- When the cargo company receives the package, package status will be turn to "Shipped" automatically, and from this status, customer cannot cancel the package.
- Seller cannot set "Delivered" status to a package. "Delivered" status is set automatically by listening to package tracking info.
Important Notes:
- The orderNumber received in the order data corresponds to the main order number in the Trendyol system, and the id at the same level represents the Order Package created for that order number.
- If one or more items are canceled in any order package, the system automatically maintains the orderNumber, creating a new id value and cargo barcode.
- Packaging and processing should align with the barcode value sent with product create products during order information.
- The orderDate is in timestamp (milliseconds) format GMT +3, while createdDate is in GMT format.
- You can query packet statuses using suppliers/xxxx/orders?status=Created with statuses such as Created, Picking, Invoiced, Shipped, Cancelled, Delivered, UnDelivered, Returned, Repack, UnPacked, and UnSupplied.
- Adding status (Picking, Invoiced) to your order packages makes it easier to view new orders by querying according to their status.
- To retrieve canceled orders, add the status=Cancelled,UnSupplied parameter.
- To retrieve orders with split packages, add the status=UnPacked parameter.
- "customerId" is a unique value assigned to a Trendyol customer account. It is not exclusive to a single customer, allowing multiple customers to order from the same Trendyol account using the same "customerId."
"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 no parameters are used in the endpoint below, it returns orders from the last week. If startDate and endDate parameters are used, 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 |
| orderByDirection | ASC | Sorts from old to new. | string |
| orderByDirection | DESC | Sorts from new to old. | string |
| shipmentPackageIds | Trendyol shipmentPackageId | 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.
}
]
}Mandatory Fields for Address Data
You can check whether the "shipmentAddress" and "invoiceAddress" informations are necessarily filled or not in the table below.
| Field Name | Mandatory |
|---|---|
| id | Yes |
| firstName | No |
| lastName | No |
| company | No |
| address1 | Yes |
| address2 | No |
| city | Yes |
| cityCode | Yes |
| district | No |
| districtId | No |
| postalCode | No |
| countryCode | Yes |
| neighborhoodId | No |
| phone | Yes |
| fullAddress | Yes |
| fullName | No |
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. This status is valid for Romania |
| Cancelled | Orders that cancelled. 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. |
Updated 11 days ago