/orders/{qid}/

get https://api.qogita.com/orders/{qid}/

Retrieve the details a single order from its qid.

Responses

Response body

object

billingAddress

object | null

required

Order's billing address.

firstName

string

length ≤ 150

Object's first name.

lastName

string

length ≤ 150

Object's last name.

companyName

string | null

required

Object's company name.

addressLineOne

string

required

length ≤ 150

First address line.

addressLineTwo

string | null

required

Second address line (not required).

zipCode

string

required

length ≤ 16

Address zip code.

city

string

length ≤ 128

Address city.

countryArea

string | null

required

Address country area (state or province) - full or abbreviated.

country

string

required

Address country.

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 SZ 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 KW KG LA LV LB LS LR LY LI LT LU MO 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 KP MK 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 KR SS ES LK SD SR SJ SE CH SY TW TJ TZ TH TL TG TK TO TT TN TR TM TC TV UG UA AE GB UM US UY UZ VU VE VN VG VI WF EH YE ZM ZW

callingCode

string

required

Country code of user's phone number.

+1 +1 242 +1 246 +1 264 +1 268 +1 284 +1 340 +1 345 +1 441 +1 473 +1 649 +1 664 +1 670 +1 671 +1 684 +1 758 +1 767 +1 784 +1 787 +1 809 +1 829 +1 868 +1 869 +1 876 +1 939 +20 +211 +212 +213 +216 +218 +220 +221 +222 +223 +224 +225 +226 +227 +228 +229 +230 +231 +232 +233 +234 +235 +236 +237 +238 +239 +240 +241 +242 +243 +244 +245 +246 +248 +249 +250 +251 +252 +253 +254 +255 +256 +257 +258 +260 +261 +262 +263 +264 +265 +266 +267 +268 +269 +27 +290 +291 +297 +298 +299 +30 +31 +32 +33 +34 +350 +351 +352 +353 +354 +355 +356 +357 +358 +358 18 +359 +36 +370 +371 +372 +373 +374 +375 +376 +377 +378 +379 +380 +381 +382 +385 +386 +387 +389 +39 +40 +41 +420 +421 +423 +43 +44 +44 1481 +44 1534 +44 1624 +45 +46 +47 +48 +49 +500 +501 +502 +503 +504 +505 +506 +507 +508 +509 +51 +52 +53 +54 +55 +56 +57 +58 +590 +591 +592 +593 +594 +595 +596 +597 +598 +599 +60 +61 +62 +63 +64 +65 +66 +670 +672 +673 +674 +675 +676 +677 +678 +679 +680 +681 +682 +683 +685 +686 +687 +688 +689 +690 +691 +692 +7 +81 +82 +84 +850 +852 +853 +855 +856 +86 +870 +880 +886 +90 +91 +92 +93 +94 +95 +960 +961 +962 +963 +964 +965 +966 +967 +968 +970 +971 +972 +973 +974 +975 +976 +977 +98 +992 +993 +994 +995 +996 +998

lineNumber

string

required

length ≤ 15

Phone number within country.

phone

string | null

required

User's phone number in E.164 format.

taxNumber

string | null

User's Tax ID Number.

customsNumber

string | null

required

User's Customs ID Number.

qid

uuid

required

Internal reference code.

usageTypes

array of strings

length ≤ 10

ENUM fields describing how an address should be used.

usageTypes

vatValidation

string

required

VAT Validation status for the tax number and company name of this Address.

VALID NOT_YET_VALIDATED UNABLE_TO_VALIDATE NO_VAT_NUMBER INVALID INVALID_COMPANY_NAME

shippingAddress

object | null

required

Order's shipping address.

firstName

string

length ≤ 150

Object's first name.

lastName

string

length ≤ 150

Object's last name.

companyName

string | null

required

Object's company name.

addressLineOne

string

required

length ≤ 150

First address line.

addressLineTwo

string | null

required

Second address line (not required).

zipCode

string

required

length ≤ 16

Address zip code.

city

string

length ≤ 128

Address city.

countryArea

string | null

required

Address country area (state or province) - full or abbreviated.

country

string

required

Address country.

callingCode

string

required

Country code of user's phone number.

lineNumber

string

required

length ≤ 15

Phone number within country.

phone

string | null

required

User's phone number in E.164 format.

taxNumber

string | null

User's Tax ID Number.

customsNumber

string | null

required

User's Customs ID Number.

qid

uuid

required

Internal reference code.

usageTypes

array of strings

length ≤ 10

ENUM fields describing how an address should be used.

usageTypes

vatValidation

string

required

VAT Validation status for the tax number and company name of this Address.

VALID NOT_YET_VALIDATED UNABLE_TO_VALIDATE NO_VAT_NUMBER INVALID INVALID_COMPANY_NAME

status

string

required

Order's current status.

CHECKOUT EXPIRED PENDING FINANCED PAID DEFAULTED DECLINED CANCELLED

buyerOrderStatus

string

required

Order's current status for order level tracking.

CHECKOUT FINANCED AWAITING_PAYMENT AWAITING_MONDU_CHECKOUT AWAITING_MONDU_DECISION PAID_PREPAID IN_PROGRESS SHIPPED PAID_FINANCED EXPIRED CANCELLED PAYMENT_OVERDUE DEFAULTED MONDU_DECLINED

buyerOrderStatusProgression

array of objects

required

A list of statuses an order has had, or will have in its flow.

buyerOrderStatusProgression*

object

buyerOrderStatus

string

required

dateComplete

integer | null

required

progressionState

string

required

COMPLETE NEXT INCOMPLETE

quantity

integer

required

Order's total item quantity (>= 0).

subtotal

string

required

Order subtotal.

taxableSubtotal

string

required

Order taxable subtotal.

shipping

string

required

Order shipping fee.

discountRate

string

required

Discount rate applied to order.

discount

string

required

Order discount.

vat

string

required

Order VAT.

extricable

string

required

Extricable wallet used.

inextricable

string

required

Inextricable wallet used.

dueLater

string

required

Amount to be paid later.

total

string

required

Order total.

invoicingOptionFee

string

required

Order invoicing option fee.

dueNow

string

required

Amount due at checkout.

paidAt

integer | null

required

Unix timestamp at which the order was paid.

orderlinesCount

integer

required

Number of order lines in this order.

metadata

object

required

Metadata for order.

bankAccount

object

required

paymentLink

uri | null

required

Stripe payment link for this order.

monduPaymentReference

string | null

required

Mondu payment reference

hostedCheckoutUrl

string | null

required

Mondu hosted checkout url

fid

string

required

Hashid of the primary key.

qid

uuid

required

Internal reference code.

totalCurrency

string

required

Currency of the total.

EUR USD GBP

dueNowCurrency

string

required

Currency of the due now.

EUR USD GBP

subtotalCurrency

string

required

Currency of the subtotal.

EUR USD GBP

taxableSubtotalCurrency

string

required

Currency of the taxable subtotal.

EUR USD GBP

extricableCurrency

string

required

Currency of the extricable.

EUR USD GBP

inextricableCurrency

string

required

Currency of the inextricable.

EUR USD GBP

discountCurrency

string

required

Currency of the discount.

EUR USD GBP

vatCurrency

string

required

Currency of the vat.

EUR USD GBP

shippingCurrency

string

required

Currency of the shipping.

EUR USD GBP

dueLaterCurrency

string

required

Currency of the amount to be paid later.

EUR USD GBP

invoicingOptionFeeCurrency

string

required

Currency of the net terms fee.

EUR USD GBP

createdAt

integer

required

Unix timestamp of order creation.

updatedAt

integer

required

Unix timestamp of order's last update.

shipments

array of objects

required

Defaults to

Order shipments.

shipments*

object

code

string

required

length ≤ 128

Shipment's Track & Trace code.

url

uri

required

length ≤ 256

Shipment's Track & Trace url.

fid

string

length ≤ 36

Hashid of the primary key.

qid

uuid

required

Internal reference code.

metadata

object | null

Metadata for object.

Has additional fields

carrier

object

required

The carrier of this shipment.

notified

boolean

required

events

array of objects

required

events*

object

qid

uuid

required

QID of the event.

createdAt

integer

required

Unix timestamp of the event creation.

type

string

required

The type of the event.

READY IN_TRANSIT T&T_CODE_PROVIDED DELIVERED IS_LIVE_FALSE IS_LIVE_TRUE NOTIFIED PENDING OUT_FOR_DELIVERY ERROR

invoices

array of objects

required

Defaults to

Order invoices.

invoices*

object

user

object

required

isIssued

boolean

required

Set once invoice has been issued.

isRefund

boolean

required

Set if this a refund (i.e., credit note).

isMaster

boolean

required

Is invoice the main invoice linked to the order?

quantity

integer

required

Invoiced quantity of items.

subtotal

string

required

Invoiced subtotal.

taxableSubtotal

string

required

Invoiced taxable subtotal.

vat

string

required

Invoiced VAT.

shipping

string

required

Invoiced shipping fee.

insurance

string

required

Invoiced insurance fee.

extricable

string

required

Invoiced extricable wallet.

inextricable

string

required

Invoiced inextricable wallet.

invoicingOptionFee

string

required

Invoiced invoicing option fee.

discount

string

required

Invoiced discount.

total

string

required

Invoiced total.

invoicedAt

date-time | null

required

Invoicing date (automatically set).

fid

string | null

required

Consecutive ID (automatically created).

qid

uuid

required

Internal reference code.

pdf

uri | null

required

PDF version of the invoice.

excel

uri | null

required

Excel version of the invoice.

order

object

required

amountPayable

string

required

Amount the buyer should pay.

insurance

string

required

Order insurance fee.

insuranceCurrency

string

required

Currency of the insurance.

EUR USD GBP

insuranceRate

string

required

Insurance rate on order.

paymentDueAt

integer | null

required

Unix timestamp of order's payment due date.

currency

string

required

Order's currency.

EUR USD GBP

submittedAt

integer | null

required

Time at which this order was submitted.

exchangeRate

string

required

Exchange rate used when converting from base to Order's currency.

invoicedAmountPayable

string | null

required

Total invoiced amount to pay.

invoicedTaxableSubtotalAmount

string

required

Invoiced Taxable Subtotal amount to pay.

invoicedSubtotalAmount

string

required

Invoiced Subtotal amount to pay.

invoicedVatAmount

string

required

Invoiced VAT amount to pay.

invoicedInvoicingOptionFeeAmount

string

required

Invoiced Subtotal amount to pay.

invoicedTotal

string

required

Total invoiced amount.

amountPayable

string | null

required

Amount the buyer should pay.

refund

string

required

Amount refunded to the buyer's extricable wallet.

saleCount

integer

required

Number of Sales for this order.

isInvoiced

boolean

required

Is Order invoiced?

amountPaid

string

required

Amount paid inferred by the state of the order.

invoicedAt

integer | null

required

Unix timestamp at which the order was invoiced.

invoicedExtricable

string

required

Total invoiced extricable.

proformas

object

required

Proformas for order.

pdf

uri | null

required

excel

uri | null

required

isDomesticVatFlowUsed

boolean

required

Is this order created using the domestic vat flow?

interestRatio

string | null

required

One time interest applied to order (1 => x >= 0).

pricingModel

string

required

Pricing model used for this order.

Optimizer Based Offer Based

claimAvailability

object

required

status

string

required

NO_ISSUED_INVOICE READY

availableFrom

date-time

required

claimDetails

object

required

orderlines

array of objects

required

Order lines (i.e., gtins & quantities).

orderlines*

object

price

string

required

Variant's (fixed) b2b price.

priceCurrency

string

required

Currency of the price.

EUR USD GBP

quantity

integer

required

Quantity of the line.

quantityInvoiced

integer

required

subtotal

string

required

Subtotal of the line.

subtotalCurrency

string

required

Currency of the subtotal.

EUR USD GBP

variant

object

required

Variant object.

qid

uuid

required

Internal reference code.

isDeal

boolean

required

Whether the order line is part of a deal.

prices

array of objects

required

Quantities of this product at which prices.

prices*

object

price

string

required

Price of this quantity.

priceCurrency

string

required

Currency of the price

EUR USD GBP

quantity

integer

required

Quantity at this price.

paymentMethod

string | null

required

Payment method used for this order.

PAY_IN_ADVANCE QOGITA_FINANCED MONDU_FINANCED PAY_BY_CARD BANK_TRANSFER MONDU

404

No response body

Language

Credentials

Bearer


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.qogita.com/orders/qid/ \
3
     --header 'accept: application/json'

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

application/json

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

200