List order packages

GET /Orders/GetOrderPackages — OMS API · Packages

Returns shipment packages with filtering and pagination. Used to fetch packages to be processed by warehouse/ERP integration.

Recommended flow: Fetch new packages by filtering with clientStatus=Created (or your own value), then mark them as processed using Write Package client status; marked packages will not appear in the next fetch with the same filter.

• Dates are Unix timestamps in milliseconds.
• If no date is given, the last N days (tenant setting, default 30) are listed; the range cannot exceed this limit.
• size is at most 200; page starts from 0.
• If no packages match the filter, returns HTTP 200, isSuccess: false, errorMessage: "No results found matching your search criteria.".

Parametreler

• page (query, integer): Page number (starting from 0).
• size (query, integer): Page size (maximum 200).
• startDate (query, integer<int64>): Start time, Unix milliseconds.
• endDate (query, integer<int64>): End time, Unix milliseconds. If only end is given, start is taken as 7 days before.
• orderNumber (query, string): Order number.
• status (query, string): Package status (see OrderPackageStatus).
• clientStatus (query, string): Client status you wrote.
• shipmentPackageIds (query, string): Package IDs (comma separated).
• barcode (query, string): Product barcode.
• saleChannelCode (query, string): Sales channel code.
• customerCode (query, string): Customer code.
• customerEmail (query, string): Customer email.
• isGuest (query, boolean): Orders without membership (true) or with membership (false) only.
• erpNumberIsNull (query, boolean): true for packages without ERP number yet.
• cargoCode (query, string): Shipping company code.
• orderByField (query, string): Sorting field (package field name, e.g. orderDate, lastModifiedDate).
• orderByDirection (query, string): Sorting direction; any value other than ASC sorts descending.

Yanıtlar

• 200: Query processed. Check the isSuccess field.
• 400: Body validation failed (missing required field, type mismatch, or malformed JSON). Response is in ASP.NET Core ValidationProblemDetails format; the errors field indicates which field is invalid.
• 401: Authorization header missing, token invalid or expired. Body is empty; obtain a new token via /Auth/login.
• 500: Unexpected server error. This response returns fields in PascalCase (unlike other responses) and includes null fields.

200 yanıt alanları

• data (object[]): Packages.
  • data.id (integer<int64>): Package OMS ID. Used as shipmentPackageId on package splitting endpoints.
  • data.lines (object[]): Items in the package.
    • data.lines.id (integer<int64>): Package item OMS ID. Used as orderLineId in quantity-based splitting.
    • data.lines.sku (string): SKU.
    • data.lines.barcode (string): Barcode.
    • data.lines.dueDate (string<date-time>): Due date.
    • data.lines.currency (string): Currency.
    • data.lines.quantity (integer<int32>): Quantity in package.
    • data.lines.itemLines (object[]): Quantity-based lines of the item.
    • data.lines.listPrice (number<double>): Unit list price.
    • data.lines.vendorSku (string): Seller SKU code.
    • data.lines.productName (string): Product name.
    • data.lines.productSize (string): Size.
    • data.lines.productColor (string): Color.
    • data.lines.productPrice (number<double>): Unit sale price.
    • data.lines.lineSaleTotal (number<double>): Total sale amount of the item in the package.
    • data.lines.discountDetails (object[]): Discounts applied to the item.
    • data.lines.productImageUrl (string): Product image.
  • data.status (string): Current package status (see OrderPackageStatus).
  • data.dueDate (string<date-time>): Due date.
  • data.parcels (object[]): Packages.
    • data.parcels.cargoKey (string): Shipping key.
    • data.parcels.trackingURL (string): Tracking link.
    • data.parcels.cargoBarcode (string): Shipping barcode.
    • data.parcels.orderPackage (integer<int64>): OMS ID of the package.
    • data.parcels.trackingCode (string): Tracking number.
    • data.parcels.parcelBarcode (string): Carton barcode.
    • data.parcels.parcelOrderNo (integer<int32>): Carton sequence number.
    • data.parcels.carrierCompany (integer<int64>): Shipping company ID.
  • data.cargoKey (string): Shipping key.
  • data.currency (string): Currency.
  • data.isFrozen (boolean): Is package frozen.
  • data.cargoCode (string): Shipping company code.
  • data.cargoName (string): Shipping company name.
  • data.isSyncErp (boolean): Transferred to ERP or not.
  • data.orderDate (string<date-time>): Order time.
  • data.customerId (integer<int64>): Customer OMS ID.
  • data.vendorCode (string): Seller code.
  • data.channelCode (string): Sales channel code.
  • data.channelName (string): Sales channel name.
  • data.invoiceLink (string): Invoice link.
  • data.orderNumber (string): Order number.
  • data.cargoBarcode (string): Shipping barcode.
  • data.clientStatus (string): Status you wrote with SetPackageClientStatus/SetOrderClientStatus.
  • data.customerCode (string): Customer code.
  • data.customerEmail (string): Customer email.
  • data.erpOrderNumber (string): ERP order number.
  • data.invoiceAddress (object): Billing address.
    • data.invoiceAddress.id (integer<int64>): Address OMS ID.
    • data.invoiceAddress.city (string): City.
    • data.invoiceAddress.phone (string): Phone.
    • data.invoiceAddress.company (string): Company name.
    • data.invoiceAddress.address1 (string): Address line 1.
    • data.invoiceAddress.address2 (string): Address line 2.
    • data.invoiceAddress.district (string): District.
    • data.invoiceAddress.fullName (string): Full name.
    • data.invoiceAddress.lastName (string): Last name.
    • data.invoiceAddress.firstName (string): First name.
    • data.invoiceAddress.taxNumber (string): Tax number.
    • data.invoiceAddress.taxOffice (string): Tax office.
    • data.invoiceAddress.postalCode (string): Postal code.
    • data.invoiceAddress.countryCode (string): Country code.
    • data.invoiceAddress.fullAddress (string): Full address text.
    • data.invoiceAddress.neighborhood (string): Neighborhood.
  • data.totalListPrice (number<double>): Total list price.
  • data.shipmentAddress (object): Delivery address.
    • data.shipmentAddress.id (integer<int64>): Address OMS ID.
    • data.shipmentAddress.city (string): City.
    • data.shipmentAddress.phone (string): Phone.
    • data.shipmentAddress.company (string): Company name.
    • data.shipmentAddress.address1 (string): Address line 1.
    • data.shipmentAddress.address2 (string): Address line 2.
    • data.shipmentAddress.district (string): District.
    • data.shipmentAddress.fullName (string): Full name.
    • data.shipmentAddress.lastName (string): Last name.
    • data.shipmentAddress.firstName (string): First name.
    • data.shipmentAddress.postalCode (string): Postal code.
    • data.shipmentAddress.countryCode (string): Country code.
    • data.shipmentAddress.fullAddress (string): Full address text.
    • data.shipmentAddress.neighborhood (string): Neighborhood.
  • data.sourcePackageId (string): Package ID you sent.
  • data.customerLastName (string): Customer last name.
  • data.lastModifiedDate (string<date-time>): Package last modified time.
  • data.packageHistories (object[]): Status history.
    • data.packageHistories.status (string): Status name.
    • data.packageHistories.createdDate (string): Time when the status occurred.
  • data.cargoTrackingLink (string): Shipping tracking link.
  • data.customerFirstName (string): Customer first name.
  • data.packageAttributes (object[]): Additional fields related to the package.
    • data.packageAttributes.name (string): Additional field name.
    • data.packageAttributes.value (any): Additional field value.
  • data.totalProductPrice (number<double>): Total sale price.
  • data.vendorCompanyName (string): Seller company name.
  • data.cargoTrackingNumber (string): Shipping tracking number.
  • data.erpOrderCreatedDate (string<date-time>): Creation time in ERP.
  • data.referenceSourcePackageId (string): Source package ID if created by package splitting/partial cancellation.
• pageSize (integer<int32>): Page size.
• isSuccess (boolean, zorunlu): true if query succeeded. If no results, returns false with a message.
• statusCode (string): "200" on successful query.
• totalPages (integer<int32>): Total pages.
• currentPage (integer<int32>): Returned page (starting from 0).
• resultCount (integer<int32>): Number of records on this page.
• errorMesssage (string): Error message. Returned only if there is an error.
• totalResultCount (integer<int32>): Total records matching the filter.