/checkouts/{qid}/

patch https://api.qogita.com/checkouts/{qid}/

Partially update checkout using its qid.
Use "active" instead of qid to update the active checkout.

Responses

Response body

object

qid

uuid

required

Internal reference code.

fid

string

required

Hashid of the primary key.

cartQid

uuid

required

Checkout's cart qid.

currency

string

required

Currency of the checkout.

EUR USD GBP

billingAddress

object | null

required

Checkout'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

Checkout'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

shipping

string

required

Checkout's shipping fee.

subtotal

string

required

Checkout's subtotal.

insurance

string

required

Checkout's insurance fee.

insuranceRate

string

required

Insurance rate on checkout.

inextricable

string

required

Inextricable wallet used.

vat

string

required

Checkout's VAT.

invoicingOptionFee

string

required

Checkout's invoicing option fee.

extricable

string

required

Extricable wallet used.

dueNow

string

required

Amount due at checkout.

isOptimized

boolean

required

Has the cart been optimized?

optimizerStrategy

string

required

The strategy used to optimize this checkout.

STANDARD FIXED_PRICE HEADLESS

isDeal

boolean

required

Is this checkout for a deal?

isDealExpired

boolean

required

Has the deal for this checkout expired?

isDomesticVatFlowUsed

boolean

required

Is this checkout using the domestic vat flow?

warnings

array of strings

required

Warnings for the checkout.

warnings*

paymentMethods

array of objects

required

Payment methods and their availability for checkout.

paymentMethods*

object

code

string

required

Code representing the payment method.

PAY_BY_CARD BANK_TRANSFER MONDU

isAvailable

boolean

required

Is this payment method available?

defermentOptions

array of objects

required

defermentOptions*

object

fee

string

required

Fee for this payment method option.

feeCurrency

string

required

Currency of the fee.

EUR USD GBP

paymentTerm

string

required

Payment term for this payment method option.

0_DAYS 30_DAYS 60_DAYS 90_DAYS

interestRatio

string

required

Interest ratio for this payment method option.

isAvailable

boolean

required

Is this payment method option available?

selectedPaymentMethod

object | null

required

Selected payment method for this checkout.

fee

string

required

Fee for this payment method option.

feeCurrency

string

required

Currency of the fee.

EUR USD GBP

code

string

required

Code representing the payment method.

PAY_BY_CARD BANK_TRANSFER MONDU

isAvailable

boolean

required

Is this payment method available?

paymentTerm

string | null

required

Payment term for this payment method option.

0_DAYS 30_DAYS 60_DAYS 90_DAYS

interestRatio

string

required

Interest ratio for this payment method option.

total

string

required

Total amount of the checkout with cash wallet applied.

pricingModel

string

required

Pricing model used for this checkout.

Optimizer Based Offer Based

hasChanges

boolean

required

Indicates if any orderlines have price or quantity changes due to offer updates.

previousTotal

string | null

required

Total before changes.

currentTotal

string | null

required

Total after changes.

Language

Credentials

Bearer


xxxxxxxxxx
12
1
curl --request PATCH \
2
     --url https://api.qogita.com/checkouts/qid/ \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "selectedPaymentMethod": {
8
    "code": "PAY_BY_CARD",
9
    "paymentTerm": "0_DAYS"
10
  }
11
}
12
'

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

application/json

200

400