Get all orders

get https://api.nextchapter-ecommerce.com/api/v1/channels/{channel}/orders

Returns all orders for this channel.

Responses

Response body

object

totalResultCount

int32

required

Total number of items in the database

items

array of objects

required

List of items

items*

object

code

string

required

Unique code

channel

object

Container holding channel information

language

string

required

The preferred language of the user that placed the order (for emails etc.)

nl en fr de es it no da tr ko

currency

string

The selected currency

culture

string

The culture matching the site and language

createdOn

date-time

Date and time of creation

state

string

The current state, can be AwaitingPayment, AwaitingShipment, Finished, Canceled, Deleted, PartiallyReturned, Returned, PartiallyRefunded or Refunded

AwaitingPayment AwaitingShipment Finished Canceled Deleted PartiallyReturned Returned PartiallyRefunded Refunded

paymentCosts

object

Container object for a service

shippingCosts

object

Container object for a service

vatCountry

string

The country that the VAT was registered in

INT EU AF AX AL DZ AS AD AO AI AQ AG AR AM AW AU AT AZ BS BH BD BB BY BE BZ BJ BM BT BO BQ BA BW BV BR IO BN BG BF BI CV KH CM CA KY CF TD CL CN CX CC CO KM CG CD CK CR CI HR CU CW CY CZ DK DJ DM DO EC EG SV GQ ER EE ET FK FO FJ FI FR GF PF TF GA GM GE DE GH GI GR GL GD GP GU GT GG GN GW GY HT HM VA HN HK HU IS IN ID IR IQ IE IM IL IT JM JP JE JO KZ KE KI KP KR KW KG LA LV LB LS LR LY LI LT LU MO MK MG MW MY MV ML MT MH MQ MR MU YT MX FM MD MC MN ME MS MA MZ MM NA NR NP NL NC NZ NI NE NG NU NF MP NO OM PK PW PS PA PG PY PE PH PN PL PT PR QA RE RO RU RW BL SH KN LC MF PM VC WS SM ST SA SN RS SC SL SG SX SK SI SB SO ZA GS SS ES LK SD SR SJ SZ SE CH SY TW TJ TZ TH TL TG TK TO TT TN TR TM TC TV UG UA AE GB US UM UY UZ VU VE VN VG VI WF EH YE ZM ZW XK

deposit

double

Amount paid in deposit

subTotal

double

Amount before any service costs

vat

double

The total VAT

total

double

The total amount paid

discountCode

object

Container for discount information

affiliate

object

Container for affiliate information

external

object

Container for external order information

rows

array of objects

required

List of order rows

rows*

object

int32

The unique id of this row

externalId

string

The unique id of the external system

productName

string

required

The name of the product

code

string

Unique code of the variant

purchaseType

string

The purchase type, can be Sale or Rental

Sale Rental

internalCode

string

The internal code of the variant

eanCode

string

required

The EAN of the variant

skuCode

string

The SKU of the variant

externalArticleCode

string

The external article code of the variant

category

string

The main category of the product

subCategory

string

The main sub category of the product

brand

object

Container for brand information

description

string

Description of the product

customerPricingPercentage

double

The customer specific percentage discount for the variant

priceBeforeReduction

double

The price of the variant before reduction

oldPrice

double

The old price of the variant

price

double

required

≤ 1000000

The unit price

discount

double

Any applied discount

vatPercentage

double

required

0 to 100

The VAT percentage

vatType

string

required

The VAT type

None High Low Standard Reduced SuperReduced Parking

commission

object

Container for the commission

imageUrl

string

An image url of the product

articles

array of objects

required

List of articles

articles*

object

int32

The unique id

externalId

string

The unique id of the external system

location

object

Location model

vat

double

required

Amount of VAT paid

discount

double

0 to 1000000

The discount amount

total

double

The total amount

canceled

boolean

True if this article has been canceled

canceledOn

date-time

Date of time of cancelation

extraRows

array of objects

List of extra rows

extraRows

object

type

string

required

The row type

Other GiftWrap Rental Donation ProductOption AdditionalCharge

title

string

required

The title of the row

price

double

required

≤ 1000000

The amount paid

variants

array of strings

List of variant descriptors

variants

personalizations

array of objects

List of Personalizations

personalizations

object

total

double

The amount paid

lines

array of objects

The list of customizations

lines

object

text

string

Customization text

pickLocation

string

The pick location

weight

double

Weight of the variant

height

double

Height of the variant

length

double

Length of the variant

width

double

Width of the variant

purchaseType

string

The purchase type of this order, can be Sale, Rental or SaleAndRental

Sale Rental SaleAndRental

kioskNumber

string

The unique kiosk number this order was created on

employeeNumber

string

The employee number provided during checkout

externalServicePointCode

string

The code of an external service point

externalServicePointName

string

The name of an external service point

memo

string

Memo placed on the order

remarks

string

Remarks added during checkout

device

string

The device this was created on, like desktop or phone

Unknown Smartphone Tablet Desktop Kiosk

user

object

required

Container for user information

paymentTerminal

object

Container for payment terminals

appliedPromotions

array of objects

List of applied promotions

appliedPromotions

object

int32

The unique id

discountCodeId

int32

If a discount code was used, this is the unique id

ruleType

string

The type of promotion

General ShoppingCart Product

discounts

array of objects

List of discounts

discounts

object

int32

The unique id

appliedDiscount

double

The applied discount

description

string

The description

code

string

The code

appliedTo

string

The type of object this was applied to

Order Row

articles

array of objects

List of articles that this was applied to

articles

object

articleId

int32

The unique article id

discount

double

The amount

kiosk

object

Container for store information

store

object

Container for store information

servicePoint

object

Container for store information

rentalStartDate

date-time

Date when rental starts

rentalEndDate

date-time

Date when rental ends

pickupDate

date-time

Date of pickup

highestVatType

string

The highest VAT type used in this order

None Low High

highestVatPercentage

double

The highest VAT percentage used in this order

customer

object

required

Container for customer information

cards

array of objects

List of cards

cards

object

type

string

The type of card

FreeBees Intersolve TritonX

code

string

The code of the card

description

string

The description

balance

int32

The balance of the card

amount

double

The amount on the card

initialPaymentKey

string

The initial payment key

savedPoints

int32

The saved points with this card

savedAmount

double

The saved amount with this card

issuePercentage

double

The issue percentage

transactionId

int64

The transaction id

transactionCanceled

boolean

True if the transaction has been canceled

showAmount

boolean

True if the amount should be shown

removedPoints

int32

The amount of removed points

requestedNew

boolean

True if the customer requested a new card with this order

redeemed

object

Container for the loyalty points

saved

object

Container for the loyalty points

paymentMethods

array of objects

List of methods used during payment

paymentMethods

object

name

string

The name

issuer

string

The selected issuer

logo

object

Container holding logo information

403

Forbidden

404

NotFound

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.nextchapter-ecommerce.com/api/v1/channels/channel/orders \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/json

application/problem+json

200OK