Get orders (Paginated)

since

date

Filter orders created since the datetime provided, default is last 30 days

until

date

Filter order created until the datetime provided, default is current time

isDelivery

boolean

Defaults to false

True if delivery only orders; false if pickup only orders; null if no filter is desired

status

string

Defaults to null

CSV data with the statuses that should be included; null if no filter is desired

string

Defaults to null

Filter orders by FriendlyCode, Buyer name or Buyer document; null if no filter is desired

sellerCode

string

Defaults to null

Filter orders by seller PointSaleId or seller document; null if no filter is desired

origin

string

Defaults to null

Filter orders with same origin; null if no filter is desired

paymentStatus

string

Defaults to null

Filter orders by payment status; null if no filter is desired

page

int32

required

Page in which to get results from

perPage

int32

required

How many results per page

200

Response body

object

Page

integer

Defaults to 0

PerPage

integer

Defaults to 0

MaxCount

integer

Defaults to 0

MaxPage

integer

Defaults to 0

Items

array of objects

Items

object

string

OrderPackageId

string

ClientId

string

Origin

string

FriendlyCode

string

MarketplaceId

string

ExternalId

string

SellerOrderId

string

CancellationType

string

IsDelivery

boolean

Defaults to true

IsAbandoned

boolean

Defaults to true

Status

string

PaymentStatus

string

Buyer

object

Seller

object

ShippingData

object

Totals

object

ProcessingState

object

InconsistencyLogs

array

InconsistencyLogs

Actions

array of objects

Actions

object

EnqueueOrderPosition

integer

Defaults to 0

OrderStatus

string

StepIntegrations

array

StepIntegrations

IsSuccessfull

boolean

Defaults to true

CreateDate

string

LastUpdate

string

Invoices

array of objects

Invoices

object

Key

string

Number

string

SerialNumber

string

Amount

integer

Defaults to 0

FileUrl

string

IssuanceDate

string

Trackings

array of objects

Trackings

object

AddresseeName

string

AddresseePhoneNumber

string

AddresseeEmail

string

DocumentPickup

string

InvoiceNumber

string

TrackingCode

string

CarrierName

string

ShippingCarrierId

string

ShippingReference

string

TrackingUrl

string

ShippingType

string

DeliveryAddress

object

TrackingLogs

array

TrackingLogs

DeliveryDate

string

DeliveredAtDate

string

Payments

array of objects

Payments

object

ExternalOrderId

string

ExternalTransactionId

string

Message

string

Amount

integer

Defaults to 0

Installments

integer

Defaults to 0

Status

string

CreateDate

string

LastUpdate

string

BillingAddress

object

PaymentMethod

object

SplitRules

array of objects

SplitRules

object

Amount

integer

Defaults to 0

TaxAmount

integer

Defaults to 0

ReceiveAmount

integer

Defaults to 0

Percentage

integer

Defaults to 0

IdentifierId

string

IsLiable

boolean

Defaults to true

ShouldPayProcessingFees

boolean

Defaults to true

Promotions

array of objects

Promotions

object

Code

string

PromotionalTitle

string

Type

string

DiscountAmount

integer

Defaults to 0

CreateDate

string

Items

array of objects

Items

object

IsGift

boolean

Defaults to true

Quantity

integer

Defaults to 0

DiscountPrice

integer

Defaults to 0

UnitPrice

integer

Defaults to 0

SubtotalAmount

integer

Defaults to 0

TotalAmount

integer

Defaults to 0

Sku

object

Attachments

array

Attachments

CustomData

array

CustomData

CreateDate

string

LastUpdate

string

xxxxxxxxxx
curl --request GET \
     --url 'https://environment.neomode.com.br/sm/management/commerce/orders/?isDelivery=false&status=null&search=null&sellerCode=null&origin=null&paymentStatus=null' \
     --header 'Prefer: return=Representation, respond-async' \
     --header 'accept: application/json'

200200

400400