Przejdź do głównej zawartości

Pobierz listę ID zamówień

GET
/api/v3/Orders/ids
curl --request GET \
--url https://twoja-instancja-smerp-api.enterprise.sellrocket.pl/api/v3/Orders/ids \
--header 'Authorization: Bearer <token>'

Zwraca tylko identyfikatory zamówień spełniających filtry – lżejsza alternatywa listy zamówień do synchronizacji przyrostowej.

Id
integer format: int64

Id of the order in SellRocket

OrderId
string

Id or ids of the order in SellRocket or in Source platform.
One can provide a single order id or multiple order ids separated by comma.

Examples:
- 204295
- 204295,101333
- 204295,1d719a60-ecee-11ee-926c-6ff59449f5d9

OrderStatusIdPriorityFilter
integer format: int64

Id of the order status in SellRocket, to be used before all other filters (ignores operator)

PlatformDateAddedFromPriorityFilter
string format: date-time
OrderStatus
string
SourcePlatformOrderId
string
ShipmentConnectionDefinitionId
string

Id of a connection definition used for shipments, if set to “ANY” it will return orders with all orders with connection definition set if set to “NONE” it will return orders with no shipments

CreatedFrom
string format: date-time
CreatedTo
string format: date-time
StatusUpdatedFrom
string format: date-time
StatusUpdatedTo
string format: date-time
SourceConnectionId
integer format: int64
SourceConnectionIds
string
AsteriskMarked
boolean
AsteriskKindId
integer format: int64
RecipientFirstName
string
RecipientLastName
string
RecipientCompanyName
string
RecipientFirstLastCompanyName
string
BuyerUsername
string
BuyerEmail
string
BuyerComments
string
Dozwolone wartości: Set Empty
SellerComments
string
RecipientPhone
string
RecipientCity
string
RecipientPostCode
string
RecipientCountry
string
RecipientCountries
string
RecipientApartmentNo
string
RecipientHouseNo
string
RecipientStreet
string
RecipientState
string
DeliveryMethod
string
IsCod
boolean
PaymentStatus
string
Dozwolone wartości: Unpaid Paid Incorrect
PaymentName
string
PaymentPlatformId
string
Offset
integer format: int32
Limit
integer format: int32
ProductId
string
ProductName
string
ProductCode
string
ProductEan
string
PayerCompanyName
string
PayerRawCompanyTaxId
string
ShipmentsTrackingNumber
string
ShipmentsTrackingNumberExact
string
ShipmentsTrackingNumberIsContainedIn
string

Filters orders where the order’s shipment tracking number is fully contained within the provided value.
This works as a reverse-contains check: for example, if the tracking number is “12345”,
then a filter value of “XXX12345YYY” would match it.

ShipmentsExternalCarrierTrackingNumber
string
ShipmentsExternalCarrierTrackingNumberIsContainedIn
string

Filters orders where the order’s shipment external carrier tracking number is fully contained within the provided value. This works as a reverse-contains check: for example, if the tracking number is “12345”,
then a filter value of “XXX12345YYY” would match it.

ElasticFieldValue
string
PlatformDateAddedFrom
string format: date-time
PlatformDateAddedTo
string format: date-time
PlatformDateConfirmedFrom
string format: date-time
PlatformDateConfirmedTo
string format: date-time
PickupPointCode
string
PickupPointName
string
PickupPointApartmentNo
string
PickupPointHouseNo
string
PickupPointStreet
string
PickupPointCity
string
PickupPointPostCode
string
PickupPointState
string
PickupPointCountryCode
string
AttachmentType
string
Dozwolone wartości: Invoice Proforma Receipt WithoutInvoice WithoutProforma WithoutReceipt
InvoiceRequired
boolean
SearchOperator
string
Dozwolone wartości: AND OR
OrderBy
string
Dozwolone wartości: OrderId ExternalOrderId DateCreated DateConfirmed DateInStatus TotalPrice ShipmentPrice ShipmentType Status AllegroTransaction Payments NameAndSurname AllegroLogin ShipmentTrackingNumber AddtionalField1 AddtionalField2 PlatformOrderId ProductCode
OrderByType
string
Dozwolone wartości: Ascending Descending
IncludeLineItemsElasticFields
boolean
AdditionalFieldsFilters
object
key
additional properties
string
AdditionalField1
string
AdditionalField2
string
Currency
string
TotalToPayGte
number format: double
TotalToPayLte
number format: double
SynchronizationErrors.HasStatusError
boolean
SynchronizationErrors.HasInvoiceError
boolean
SynchronizationErrors.HasShipmentError
boolean

Success

Typ treściapplication/json
object
list
Array<object>
nullable
object
id
integer format: int64
pageNumber
integer format: int32
total
integer format: int32
Examplegenerated
{
"list": [
{
"id": 1
}
],
"pageNumber": 1,
"total": 1
}

Bad Request

Typ treściapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Server Error