---
title: "Update Order"
method: PUT
path: "/openapi/{version}/customwebstore/orders/{id}/"
tags: ["Custom Webstore (B2C)"]
---

# Update Order

`PUT /openapi/{version}/customwebstore/orders/{id}/`

## Request

- Base URL: `https://base_url`
- URL: `https://base_url/openapi/{version}/customwebstore/orders/{id}/`
- Auth: none declared. Required headers: `connection-id`

Update Order

## Path parameters

- `id` integer, required
- `version` string, required

## Headers

- `connection-id` string, required

## Request body

- CustomWebstoreOrder
  - `id` integer, required
  - `unique_order_identifier` string, required
  - `order_reference` string, nullable
  - `currency` union
    - 'ALL' | 'AFN' | 'ARS' | 'AWG' | 'AUD' | 'AZN' | 'BSD' | 'BBD' | 'BYN' | 'BZD' | 'BMD' | 'BOB' | 'BAM' | 'BWP' | 'BGN' | 'BRL' | 'BND' | 'KHR' | 'CAD' | 'KYD' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'HRK' | 'CUP' | 'CZK' | 'DKK' | 'DOP' | 'XCD' | 'EGP' | 'SVC' | 'EUR' | 'FKP' | 'FJD' | 'GHS' | 'GIP' | 'GTQ' | 'GGP' | 'GYD' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'IRR' | 'IMP' | 'ILS' | 'JMD' | 'JPY' | 'JEP' | 'KZT' | 'KPW' | 'KRW' | 'KGS' | 'LAK' | 'LBP' | 'LRD' | 'MKD' | 'MYR' | 'MUR' | 'MXN' | 'MNT' | 'MZN' | 'NAD' | 'NPR' | 'ANG' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'OMR' | 'PKR' | 'PAB' | 'PYG' | 'PEN' | 'PHP' | 'PLN' | 'QAR' | 'RON' | 'RUB' | 'SHP' | 'SAR' | 'RSD' | 'SCR' | 'SGD' | 'SBD' | 'SOS' | 'ZAR' | 'LKR' | 'SEK' | 'CHF' | 'SRD' | 'SYP' | 'TWD' | 'THB' | 'TTD' | 'TRY' | 'TVD' | 'UAH' | 'GBP' | 'USD' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'YER' | 'ZWD' | 'DZD' | 'AOA' | 'AMD' | 'AZM' | 'BHD' | 'BDT' | 'BYR' | 'XOF' | 'BTN' | 'BOV' | 'BIF' | 'XAF' | 'CVE' | 'CLF' | 'COU' | 'KMF' | 'CDF' | 'CYP' | 'DJF' | 'ERN' | 'EEK' | 'ETB' | 'XPF' | 'GMD' | 'GEL' | 'GHC' | 'GNF' | 'GWP' | 'HTG' | 'IQD' | 'JOD' | 'KES' | 'KWD' | 'LVL' | 'LSL' | 'LYD' | 'LTL' | 'MOP' | 'MGA' | 'MGF' | 'MWK' | 'MVR' | 'MTL' | 'MRO' | 'MXV' | 'MDL' | 'MAD' | 'MZM' | 'MMK' | 'PGK' | 'ROL' | 'RUR' | 'RWF' | 'WST' | 'STD' | 'CSD' | 'SLL' | 'SKK' | 'SIT' | 'SDD' | 'SZL' | 'TJS' | 'TZS' | 'TOP' | 'TND' | 'TRL' | 'TMM' | 'UGX' | 'AED' | 'USS' | 'USN' | 'VUV' | 'VEB' | 'ZMK': * `ALL` - Albania Lek - Lek * `AFN` - Afghanistan Afghani - ؋ * `ARS` - Argentina Peso - $ * `AWG` - Aruba Guilder - ƒ * `AUD` - Australia Dollar - A$ * `AZN` - Azerbaijan Manat - ₼ * `BSD` - Bahamas Dollar - $ * `BBD` - Barbados Dollar - $ * `BYN` - Belarus Ruble - Br * `BZD` - Belize Dollar - BZ$ * `BMD` - Bermuda Dollar - $ * `BOB` - Bolivia Bolíviano - $b * `BAM` - Bosnia and Herzegovina Convertible Mark - KM * `BWP` - Botswana Pula - P * `BGN` - Bulgaria Lev - лв * `BRL` - Brazil Real - R$ * `BND` - Brunei Darussalam Dollar - $ * `KHR` - Cambodia Riel - ៛ * `CAD` - Canada Dollar - $ * `KYD` - Cayman Islands Dollar - $ * `CLP` - Chile Peso - $ * `CNY` - China Yuan Renminbi - ¥ * `COP` - Colombia Peso - $ * `CRC` - Costa Rica Colon - ₡ * `HRK` - Croatia Kuna - kn * `CUP` - Cuba Peso - ₱ * `CZK` - Czech Republic Koruna - Kč * `DKK` - Denmark Krone - kr * `DOP` - Dominican Republic Peso - RD$ * `XCD` - East Caribbean Dollar - $ * `EGP` - Egypt Pound - £ * `SVC` - El Salvador Colon - $ * `EUR` - Euro Member Countries - € * `FKP` - Falkland Islands (Malvinas) Pound - £ * `FJD` - Fiji Dollar - $ * `GHS` - Ghana Cedi - ¢ * `GIP` - Gibraltar Pound - £ * `GTQ` - Guatemala Quetzal - Q * `GGP` - Guernsey Pound - £ * `GYD` - Guyana Dollar - $ * `HNL` - Honduras Lempira - L * `HKD` - Hong Kong Dollar - $ * `HUF` - Hungary Forint - Ft * `ISK` - Iceland Krona - kr * `INR` - India Rupee - INR * `IDR` - Indonesia Rupiah - Rp * `IRR` - Iran Rial - ﷼ * `IMP` - Isle of Man Pound - £ * `ILS` - Israel Shekel - ₪ * `JMD` - Jamaica Dollar - J$ * `JPY` - Japan Yen - ¥ * `JEP` - Jersey Pound - £ * `KZT` - Kazakhstan Tenge - лв * `KPW` - Korea (North) Won - ₩ * `KRW` - Korea (South) Won - ₩ * `KGS` - Kyrgyzstan Som - лв * `LAK` - Laos Kip - ₭ * `LBP` - Lebanon Pound - £ * `LRD` - Liberia Dollar - $ * `MKD` - Macedonia Denar - ден * `MYR` - Malaysia Ringgit - RM * `MUR` - Mauritius Rupee - ₨ * `MXN` - Mexico Peso - $ * `MNT` - Mongolia Tughrik - ₮ * `MZN` - Mozambique Metical - MT * `NAD` - Namibia Dollar - $ * `NPR` - Nepal Rupee - ₨ * `ANG` - Netherlands Antilles Guilder - ƒ * `NZD` - New Zealand Dollar - NZ$ * `NIO` - Nicaragua Cordoba - C$ * `NGN` - Nigeria Naira - ₦ * `NOK` - Norway Krone - kr * `OMR` - Oman Rial - ﷼ * `PKR` - Pakistan Rupee - ₨ * `PAB` - Panama Balboa - B/. * `PYG` - Paraguay Guarani - Gs * `PEN` - Peru Sol - S/. * `PHP` - Philippines Peso - ₱ * `PLN` - Poland Zloty - zł * `QAR` - Qatar Riyal - ﷼ * `RON` - Romania Leu - lei * `RUB` - Russia Ruble - ₽ * `SHP` - Saint Helena Pound - £ * `SAR` - Saudi Arabia Riyal - ﷼ * `RSD` - Serbia Dinar - Дин. * `SCR` - Seychelles Rupee - ₨ * `SGD` - Singapore Dollar - $ * `SBD` - Solomon Islands Dollar - $ * `SOS` - Somalia Shilling - S * `ZAR` - South Africa Rand - R * `LKR` - Sri Lanka Rupee - ₨ * `SEK` - Sweden Krona - kr * `CHF` - Switzerland Franc - CHF * `SRD` - Suriname Dollar - $ * `SYP` - Syria Pound - £ * `TWD` - Taiwan New Dollar - NT$ * `THB` - Thailand Baht - ฿ * `TTD` - Trinidad and Tobago Dollar - TT$ * `TRY` - Turkey Lira - TRY * `TVD` - Tuvalu Dollar - $ * `UAH` - Ukraine Hryvnia - ₴ * `GBP` - United Kingdom Pound - £ * `USD` - US Dollar - $ * `UYU` - Uruguay Peso - $U * `UZS` - Uzbekistan Som - лв * `VEF` - Venezuela Bolívar - Bs * `VND` - Viet Nam Dong - ₫ * `YER` - Yemen Rial - ﷼ * `ZWD` - Zimbabwe Dollar - Z$ * `DZD` - Algerian Dinar - DZD * `AOA` - Kwanza - AOA * `AMD` - Armenian Dram - AMD * `AZM` - Azerbaijanian Manat - AZM * `BHD` - Bahraini Dinar - BHD * `BDT` - Taka - BDT * `BYR` - Belarussian Ruble - BYR * `XOF` - CFA Franc BCEAO - XOF * `BTN` - Ngultrum - BTN * `BOV` - Mvdol - BOV * `BIF` - Burundi Franc - BIF * `XAF` - CFA Franc BEAC - XAF * `CVE` - Cape Verde Escudo - CVE * `CLF` - Unidades de fomento - CLF * `COU` - Unidad de Valor Real - COU * `KMF` - Comoro Franc - KMF * `CDF` - Franc Congolais - CDF * `CYP` - Cyprus Pound - CYP * `DJF` - Djibouti Franc - DJF * `ERN` - Nakfa - ERN * `EEK` - Kroon - EEK * `ETB` - Ethiopian Birr - ETB * `XPF` - CFP Franc - XPF * `GMD` - Dalasi - GMD * `GEL` - Lari - GEL * `GHC` - Cedi - GHC * `GNF` - Guinea Franc - GNF * `GWP` - Guinea-Bissau Peso - GWP * `HTG` - Gourde - HTG * `IQD` - Iraqi Dinar - IQD * `JOD` - Jordanian Dinar - JOD * `KES` - Kenyan Shilling - KES * `KWD` - Kuwaiti Dinar - KWD * `LVL` - Latvian Lats - LVL * `LSL` - Loti - LSL * `LYD` - Lybian Dinar - LYD * `LTL` - Lithuanian Litas - LTL * `MOP` - Pataca - MOP * `MGA` - Ariary - MGA * `MGF` - Malagasy Franc - MGF * `MWK` - Kwacha - MWK * `MVR` - Rufiyaa - MVR * `MTL` - Maltese Lira - MTL * `MRO` - Ouguiya - MRO * `MXV` - Mexican Unidad de Inversion (UDI) - MXV * `MDL` - Moldovan Leu - MDL * `MAD` - Moroccan Dirham - MAD * `MZM` - Metical - MZM * `MMK` - Kyat - MMK * `PGK` - Kina - PGK * `ROL` - Leu - ROL * `RUR` - Russian Ruble - RUR * `RWF` - Rwanda Franc - RWF * `WST` - Tala - WST * `STD` - Dobra - STD * `CSD` - Serbian Dinar - CSD * `SLL` - Leone - SLL * `SKK` - Slovak Koruna - SKK * `SIT` - Tolar - SIT * `SDD` - Sudanese Dinar - SDD * `SZL` - Lilangeni - SZL * `TJS` - Somoni - TJS * `TZS` - Tanzanian Shilling - TZS * `TOP` - Pa�anga - TOP * `TND` - Tunisian Dinar - TND * `TRL` - Turkish Lira - TRL * `TMM` - Manat - TMM * `UGX` - Uganda Shilling - UGX * `AED` - UAE Dirham - AED * `USS` - US Dollar (Same day) - USS * `USN` - US Dollar (Next day) - USN * `VUV` - Vatu - VUV * `VEB` - Bolivar - VEB * `ZMK` - Kwacha - ZMK
    - ''
  - `payment_method` 'CASH_ON_DELIVERY' | 'DEBIT_CARD' | 'CREDIT_CARD' | 'DIGITAL_WALLET' | 'OTHER', required: * `CASH_ON_DELIVERY` - Cash On Delivery * `DEBIT_CARD` - Debit Card * `CREDIT_CARD` - Credit Card * `DIGITAL_WALLET` - Digital Wallet * `OTHER` - Other
  - `cod_amount` string, decimal, nullable
  - `billing_address` CustomAddress, required
    - `first_name` string, nullable
    - `last_name` string, nullable
    - `email` string, nullable
    - `address_line1` string, nullable
    - `address_line2` string, nullable
    - `address_line3` string, nullable
    - `suburb` string, nullable
    - `city` string, nullable
    - `state` string, nullable
    - `country_code` 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | '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' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | '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' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'AN' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'CS' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | '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', required: * `AF` - AF * `AL` - AL * `DZ` - DZ * `AS` - AS * `AD` - AD * `AO` - AO * `AI` - AI * `AG` - AG * `AR` - AR * `AM` - AM * `AW` - AW * `AU` - AU * `AT` - AT * `AZ` - AZ * `BS` - BS * `BH` - BH * `BD` - BD * `BB` - BB * `BY` - BY * `BE` - BE * `BZ` - BZ * `BJ` - BJ * `BM` - BM * `BT` - BT * `BO` - BO * `BA` - BA * `BW` - BW * `BV` - BV * `BR` - BR * `IO` - IO * `BN` - BN * `BG` - BG * `BF` - BF * `BI` - BI * `KH` - KH * `CM` - CM * `CA` - CA * `CV` - CV * `KY` - KY * `CF` - CF * `TD` - TD * `CL` - CL * `CN` - CN * `CX` - CX * `CC` - CC * `CO` - CO * `KM` - KM * `CG` - CG * `CD` - CD * `CK` - CK * `CR` - CR * `CI` - CI * `HR` - HR * `CU` - CU * `CY` - CY * `CZ` - CZ * `DK` - DK * `DJ` - DJ * `DM` - DM * `DO` - DO * `EC` - EC * `EG` - EG * `SV` - SV * `GQ` - GQ * `ER` - ER * `EE` - EE * `ET` - ET * `FK` - FK * `FO` - FO * `FJ` - FJ * `FI` - FI * `FR` - FR * `GF` - GF * `PF` - PF * `TF` - TF * `GA` - GA * `GM` - GM * `GE` - GE * `DE` - DE * `GH` - GH * `GI` - GI * `GR` - GR * `GL` - GL * `GD` - GD * `GP` - GP * `GU` - GU * `GT` - GT * `GN` - GN * `GW` - GW * `GY` - GY * `HT` - HT * `HM` - HM * `VA` - VA * `HN` - HN * `HK` - HK * `HU` - HU * `IS` - IS * `IN` - IN * `ID` - ID * `IR` - IR * `IQ` - IQ * `IE` - IE * `IL` - IL * `IT` - IT * `JM` - JM * `JP` - JP * `JO` - JO * `KZ` - KZ * `KE` - KE * `KI` - KI * `KP` - KP * `KR` - KR * `KW` - KW * `KG` - KG * `LA` - LA * `LV` - LV * `LB` - LB * `LS` - LS * `LR` - LR * `LY` - LY * `LI` - LI * `LT` - LT * `LU` - LU * `MO` - MO * `MK` - MK * `MG` - MG * `MW` - MW * `MY` - MY * `MV` - MV * `ML` - ML * `MT` - MT * `MH` - MH * `MQ` - MQ * `MR` - MR * `MU` - MU * `YT` - YT * `MX` - MX * `FM` - FM * `MD` - MD * `MC` - MC * `MN` - MN * `MS` - MS * `MA` - MA * `MZ` - MZ * `MM` - MM * `NA` - NA * `NR` - NR * `NP` - NP * `NL` - NL * `AN` - AN * `NC` - NC * `NZ` - NZ * `NI` - NI * `NE` - NE * `NG` - NG * `NU` - NU * `NF` - NF * `MP` - MP * `NO` - NO * `OM` - OM * `PK` - PK * `PW` - PW * `PA` - PA * `PG` - PG * `PY` - PY * `PE` - PE * `PH` - PH * `PN` - PN * `PL` - PL * `PT` - PT * `PR` - PR * `QA` - QA * `RE` - RE * `RO` - RO * `RU` - RU * `RW` - RW * `SH` - SH * `KN` - KN * `LC` - LC * `PM` - PM * `VC` - VC * `WS` - WS * `SM` - SM * `ST` - ST * `SA` - SA * `SN` - SN * `CS` - CS * `SC` - SC * `SL` - SL * `SG` - SG * `SK` - SK * `SI` - SI * `SB` - SB * `SO` - SO * `ZA` - ZA * `ES` - ES * `LK` - LK * `SD` - SD * `SR` - SR * `SJ` - SJ * `SZ` - SZ * `SE` - SE * `CH` - CH * `SY` - SY * `TW` - TW * `TJ` - TJ * `TZ` - TZ * `TH` - TH * `TL` - TL * `TG` - TG * `TK` - TK * `TO` - TO * `TT` - TT * `TN` - TN * `TR` - TR * `TM` - TM * `TC` - TC * `TV` - TV * `UG` - UG * `UA` - UA * `AE` - AE * `GB` - GB * `US` - US * `UM` - UM * `UY` - UY * `UZ` - UZ * `VU` - VU * `VE` - VE * `VN` - VN * `VG` - VG * `VI` - VI * `WF` - WF * `EH` - EH * `YE` - YE * `ZM` - ZM * `ZW` - ZW
    - `zipcode` string, nullable
    - `phone` string, nullable
    - `customs_code` string, nullable: Customs code for the address. This is used to identify the address for customs purposes.
  - `shipping_address` CustomAddress, required
    - `first_name` string, nullable
    - `last_name` string, nullable
    - `email` string, nullable
    - `address_line1` string, nullable
    - `address_line2` string, nullable
    - `address_line3` string, nullable
    - `suburb` string, nullable
    - `city` string, nullable
    - `state` string, nullable
    - `country_code` 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | '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' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | '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' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'AN' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'CS' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | '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', required: * `AF` - AF * `AL` - AL * `DZ` - DZ * `AS` - AS * `AD` - AD * `AO` - AO * `AI` - AI * `AG` - AG * `AR` - AR * `AM` - AM * `AW` - AW * `AU` - AU * `AT` - AT * `AZ` - AZ * `BS` - BS * `BH` - BH * `BD` - BD * `BB` - BB * `BY` - BY * `BE` - BE * `BZ` - BZ * `BJ` - BJ * `BM` - BM * `BT` - BT * `BO` - BO * `BA` - BA * `BW` - BW * `BV` - BV * `BR` - BR * `IO` - IO * `BN` - BN * `BG` - BG * `BF` - BF * `BI` - BI * `KH` - KH * `CM` - CM * `CA` - CA * `CV` - CV * `KY` - KY * `CF` - CF * `TD` - TD * `CL` - CL * `CN` - CN * `CX` - CX * `CC` - CC * `CO` - CO * `KM` - KM * `CG` - CG * `CD` - CD * `CK` - CK * `CR` - CR * `CI` - CI * `HR` - HR * `CU` - CU * `CY` - CY * `CZ` - CZ * `DK` - DK * `DJ` - DJ * `DM` - DM * `DO` - DO * `EC` - EC * `EG` - EG * `SV` - SV * `GQ` - GQ * `ER` - ER * `EE` - EE * `ET` - ET * `FK` - FK * `FO` - FO * `FJ` - FJ * `FI` - FI * `FR` - FR * `GF` - GF * `PF` - PF * `TF` - TF * `GA` - GA * `GM` - GM * `GE` - GE * `DE` - DE * `GH` - GH * `GI` - GI * `GR` - GR * `GL` - GL * `GD` - GD * `GP` - GP * `GU` - GU * `GT` - GT * `GN` - GN * `GW` - GW * `GY` - GY * `HT` - HT * `HM` - HM * `VA` - VA * `HN` - HN * `HK` - HK * `HU` - HU * `IS` - IS * `IN` - IN * `ID` - ID * `IR` - IR * `IQ` - IQ * `IE` - IE * `IL` - IL * `IT` - IT * `JM` - JM * `JP` - JP * `JO` - JO * `KZ` - KZ * `KE` - KE * `KI` - KI * `KP` - KP * `KR` - KR * `KW` - KW * `KG` - KG * `LA` - LA * `LV` - LV * `LB` - LB * `LS` - LS * `LR` - LR * `LY` - LY * `LI` - LI * `LT` - LT * `LU` - LU * `MO` - MO * `MK` - MK * `MG` - MG * `MW` - MW * `MY` - MY * `MV` - MV * `ML` - ML * `MT` - MT * `MH` - MH * `MQ` - MQ * `MR` - MR * `MU` - MU * `YT` - YT * `MX` - MX * `FM` - FM * `MD` - MD * `MC` - MC * `MN` - MN * `MS` - MS * `MA` - MA * `MZ` - MZ * `MM` - MM * `NA` - NA * `NR` - NR * `NP` - NP * `NL` - NL * `AN` - AN * `NC` - NC * `NZ` - NZ * `NI` - NI * `NE` - NE * `NG` - NG * `NU` - NU * `NF` - NF * `MP` - MP * `NO` - NO * `OM` - OM * `PK` - PK * `PW` - PW * `PA` - PA * `PG` - PG * `PY` - PY * `PE` - PE * `PH` - PH * `PN` - PN * `PL` - PL * `PT` - PT * `PR` - PR * `QA` - QA * `RE` - RE * `RO` - RO * `RU` - RU * `RW` - RW * `SH` - SH * `KN` - KN * `LC` - LC * `PM` - PM * `VC` - VC * `WS` - WS * `SM` - SM * `ST` - ST * `SA` - SA * `SN` - SN * `CS` - CS * `SC` - SC * `SL` - SL * `SG` - SG * `SK` - SK * `SI` - SI * `SB` - SB * `SO` - SO * `ZA` - ZA * `ES` - ES * `LK` - LK * `SD` - SD * `SR` - SR * `SJ` - SJ * `SZ` - SZ * `SE` - SE * `CH` - CH * `SY` - SY * `TW` - TW * `TJ` - TJ * `TZ` - TZ * `TH` - TH * `TL` - TL * `TG` - TG * `TK` - TK * `TO` - TO * `TT` - TT * `TN` - TN * `TR` - TR * `TM` - TM * `TC` - TC * `TV` - TV * `UG` - UG * `UA` - UA * `AE` - AE * `GB` - GB * `US` - US * `UM` - UM * `UY` - UY * `UZ` - UZ * `VU` - VU * `VE` - VE * `VN` - VN * `VG` - VG * `VI` - VI * `WF` - WF * `EH` - EH * `YE` - YE * `ZM` - ZM * `ZW` - ZW
    - `zipcode` string, nullable
    - `phone` string, nullable
    - `customs_code` string, nullable: Customs code for the address. This is used to identify the address for customs purposes.
  - `total_price` string, decimal
  - `shipment_type` union
    - 'Standard' | 'Express' | 'SameDay' | 'NextDay' | 'Scheduled' | 'ReturnDropoff' | 'ReturnStandard' | 'ReturnExpress': * `Standard` - Standard * `Express` - Express * `SameDay` - SameDay * `NextDay` - NextDay * `Scheduled` - Scheduled * `ReturnDropoff` - ReturnDropoff * `ReturnStandard` - ReturnStandard * `ReturnExpress` - ReturnExpress
    - ''
    - unknown
  - `order_items` CustomWebstoreOrderItem[], required
    - `id` integer, required
    - `catalogue_product_id` string
    - `quantity` integer
    - `price` string, decimal
    - `warehouse_id` integer, nullable
    - `inventory_sku` string, nullable
    - `fulfilment_group_id` string, nullable
    - `should_fulfil` boolean
    - `shipment_required` boolean
    - `order_item_id` string, required
    - `cancel_reason` string, required
    - `cancel_by` string, required
    - `cancelled_at` string, date-time, nullable, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `cancelled` boolean, required
    - `shipment_status` union, required
      - 'UNASSIGNED' | 'PICKUP_PENDING' | 'PACKAGE_PICKED' | 'OUT_FOR_DELIVERY_1' | 'CANCELLED' | 'DELIVERED' | 'RETURN_TRIGGERED' | 'RETURNED' | 'LOST': * `UNASSIGNED` - UNASSIGNED * `PICKUP_PENDING` - PICKUP_PENDING * `PACKAGE_PICKED` - PACKAGE_PICKED * `OUT_FOR_DELIVERY_1` - OUT_FOR_DELIVERY_1 * `CANCELLED` - CANCELLED * `DELIVERED` - DELIVERED * `RETURN_TRIGGERED` - RETURN_TRIGGERED * `RETURNED` - RETURNED * `LOST` - LOST
      - unknown
    - `tracking_number` string, required
    - `tracking_url` string, nullable, required
    - `shipment_provider_name` string, required
    - `rts_sla_time` string, date-time, nullable
    - `sot_sla_time` string, date-time, nullable
    - `warehouse_status` union, required
      - 'CANCELLED' | 'COMPLETED' | 'ERROR' | 'IN_TRANSIT' | 'LOST' | 'NEW' | 'ON_HOLD' | 'OUT_FOR_DELIVERY' | 'OUT_OF_STOCK' | 'PACKED' | 'PARTIAL' | 'PARTIAL_PICKED' | 'PICKED' | 'PICKING' | 'PREORDER' | 'PUTAWAY' | 'READY_FOR_DISPATCH' | 'READY_FOR_PICKING' | 'RELEASED' | 'RETURN_COMPLETED' | 'RETURN_IN_PROGRESS' | 'SCHEDULED' | 'UNKNOWN' | 'UNPAID': * `CANCELLED` - 16 * `COMPLETED` - 17 * `ERROR` - 21 * `IN_TRANSIT` - 13 * `LOST` - 22 * `NEW` - 5 * `ON_HOLD` - 0 * `OUT_FOR_DELIVERY` - 14 * `OUT_OF_STOCK` - 23 * `PACKED` - 11 * `PARTIAL` - 6 * `PARTIAL_PICKED` - 7 * `PICKED` - 10 * `PICKING` - 9 * `PREORDER` - 1 * `PUTAWAY` - 15 * `READY_FOR_DISPATCH` - 12 * `READY_FOR_PICKING` - 8 * `RELEASED` - 4 * `RETURN_COMPLETED` - 19 * `RETURN_IN_PROGRESS` - 18 * `SCHEDULED` - 2 * `UNKNOWN` - 20 * `UNPAID` - 3
      - unknown
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `payment_verified` boolean: Indicates whether the payment has been successfully verified or not. Default is True. Order will be in UNPAID status if False.
  - `is_gift` boolean
  - `gift_message` string, nullable
  - `is_paused` boolean, nullable
  - `fulfilment_groups` CustomWebstoreFulfilmentGroup[]
    - `fulfilment_group_id` string, required
    - `tracking_number` string, required
    - `waybill_url` string, nullable
    - `shipment_provider_name` string, nullable
    - `sort_code` string, nullable
    - `tracking_url` string, nullable
    - `generate_template_waybill` boolean, nullable
    - `warehouse_status` union
      - 'CANCELLED' | 'COMPLETED' | 'ERROR' | 'IN_TRANSIT' | 'LOST' | 'NEW' | 'ON_HOLD' | 'OUT_FOR_DELIVERY' | 'OUT_OF_STOCK' | 'PACKED' | 'PARTIAL' | 'PARTIAL_PICKED' | 'PICKED' | 'PICKING' | 'PREORDER' | 'PUTAWAY' | 'READY_FOR_DISPATCH' | 'READY_FOR_PICKING' | 'RELEASED' | 'RETURN_COMPLETED' | 'RETURN_IN_PROGRESS' | 'SCHEDULED' | 'UNKNOWN' | 'UNPAID': * `CANCELLED` - 16 * `COMPLETED` - 17 * `ERROR` - 21 * `IN_TRANSIT` - 13 * `LOST` - 22 * `NEW` - 5 * `ON_HOLD` - 0 * `OUT_FOR_DELIVERY` - 14 * `OUT_OF_STOCK` - 23 * `PACKED` - 11 * `PARTIAL` - 6 * `PARTIAL_PICKED` - 7 * `PICKED` - 10 * `PICKING` - 9 * `PREORDER` - 1 * `PUTAWAY` - 15 * `READY_FOR_DISPATCH` - 12 * `READY_FOR_PICKING` - 8 * `RELEASED` - 4 * `RETURN_COMPLETED` - 19 * `RETURN_IN_PROGRESS` - 18 * `SCHEDULED` - 2 * `UNKNOWN` - 20 * `UNPAID` - 3
      - unknown
    - `sla_timestamps` FulfilmentOrderOpenAPISlaTimes, required
      - `released_at` string, date-time, nullable
      - `partial_at` string, date-time, nullable
      - `picked_at` string, date-time, nullable
      - `waybill_fetched_at` string, date-time, nullable
      - `packed_at` string, date-time, nullable
      - `ready_for_dispatch_at` string, date-time, nullable
      - `dispatched_at` string, date-time, nullable
      - `out_for_delivery_at` string, date-time, nullable
      - `completed_at` string, date-time, nullable
      - `cancelled_at` string, date-time, nullable
      - `returned_at` string, date-time, nullable
      - `new_at` string, date-time, nullable
      - `ready_for_picking_at` string, date-time, nullable
  - `is_ddp` boolean, nullable: Indicates whether Delivery Duty paid or not.
  - `has_ddp_info` boolean, nullable: Indicates whether Delivery Duty info is available or not.
  - `channel_name` string, nullable: Sales channel or marketplace from which the order originated. Must be one of: amazon, bbo, capillary, ebay, ginee, kumu, lazada, noon, salla, shopee, shopify, temu, tiktok, tokopedia, wix, woocommerce, zalora, zid, walmart, etsy, target, flipkart, namshi, instagram, whatsapp, shein, website, other

## Response `201`

- EnvelopedCustomWebstoreOrder
  - `success` boolean
  - `data` CustomWebstoreOrder, required
    - `id` integer, required
    - `unique_order_identifier` string, required
    - `order_reference` string, nullable
    - `currency` union
      - 'ALL' | 'AFN' | 'ARS' | 'AWG' | 'AUD' | 'AZN' | 'BSD' | 'BBD' | 'BYN' | 'BZD' | 'BMD' | 'BOB' | 'BAM' | 'BWP' | 'BGN' | 'BRL' | 'BND' | 'KHR' | 'CAD' | 'KYD' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'HRK' | 'CUP' | 'CZK' | 'DKK' | 'DOP' | 'XCD' | 'EGP' | 'SVC' | 'EUR' | 'FKP' | 'FJD' | 'GHS' | 'GIP' | 'GTQ' | 'GGP' | 'GYD' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'IRR' | 'IMP' | 'ILS' | 'JMD' | 'JPY' | 'JEP' | 'KZT' | 'KPW' | 'KRW' | 'KGS' | 'LAK' | 'LBP' | 'LRD' | 'MKD' | 'MYR' | 'MUR' | 'MXN' | 'MNT' | 'MZN' | 'NAD' | 'NPR' | 'ANG' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'OMR' | 'PKR' | 'PAB' | 'PYG' | 'PEN' | 'PHP' | 'PLN' | 'QAR' | 'RON' | 'RUB' | 'SHP' | 'SAR' | 'RSD' | 'SCR' | 'SGD' | 'SBD' | 'SOS' | 'ZAR' | 'LKR' | 'SEK' | 'CHF' | 'SRD' | 'SYP' | 'TWD' | 'THB' | 'TTD' | 'TRY' | 'TVD' | 'UAH' | 'GBP' | 'USD' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'YER' | 'ZWD' | 'DZD' | 'AOA' | 'AMD' | 'AZM' | 'BHD' | 'BDT' | 'BYR' | 'XOF' | 'BTN' | 'BOV' | 'BIF' | 'XAF' | 'CVE' | 'CLF' | 'COU' | 'KMF' | 'CDF' | 'CYP' | 'DJF' | 'ERN' | 'EEK' | 'ETB' | 'XPF' | 'GMD' | 'GEL' | 'GHC' | 'GNF' | 'GWP' | 'HTG' | 'IQD' | 'JOD' | 'KES' | 'KWD' | 'LVL' | 'LSL' | 'LYD' | 'LTL' | 'MOP' | 'MGA' | 'MGF' | 'MWK' | 'MVR' | 'MTL' | 'MRO' | 'MXV' | 'MDL' | 'MAD' | 'MZM' | 'MMK' | 'PGK' | 'ROL' | 'RUR' | 'RWF' | 'WST' | 'STD' | 'CSD' | 'SLL' | 'SKK' | 'SIT' | 'SDD' | 'SZL' | 'TJS' | 'TZS' | 'TOP' | 'TND' | 'TRL' | 'TMM' | 'UGX' | 'AED' | 'USS' | 'USN' | 'VUV' | 'VEB' | 'ZMK': * `ALL` - Albania Lek - Lek * `AFN` - Afghanistan Afghani - ؋ * `ARS` - Argentina Peso - $ * `AWG` - Aruba Guilder - ƒ * `AUD` - Australia Dollar - A$ * `AZN` - Azerbaijan Manat - ₼ * `BSD` - Bahamas Dollar - $ * `BBD` - Barbados Dollar - $ * `BYN` - Belarus Ruble - Br * `BZD` - Belize Dollar - BZ$ * `BMD` - Bermuda Dollar - $ * `BOB` - Bolivia Bolíviano - $b * `BAM` - Bosnia and Herzegovina Convertible Mark - KM * `BWP` - Botswana Pula - P * `BGN` - Bulgaria Lev - лв * `BRL` - Brazil Real - R$ * `BND` - Brunei Darussalam Dollar - $ * `KHR` - Cambodia Riel - ៛ * `CAD` - Canada Dollar - $ * `KYD` - Cayman Islands Dollar - $ * `CLP` - Chile Peso - $ * `CNY` - China Yuan Renminbi - ¥ * `COP` - Colombia Peso - $ * `CRC` - Costa Rica Colon - ₡ * `HRK` - Croatia Kuna - kn * `CUP` - Cuba Peso - ₱ * `CZK` - Czech Republic Koruna - Kč * `DKK` - Denmark Krone - kr * `DOP` - Dominican Republic Peso - RD$ * `XCD` - East Caribbean Dollar - $ * `EGP` - Egypt Pound - £ * `SVC` - El Salvador Colon - $ * `EUR` - Euro Member Countries - € * `FKP` - Falkland Islands (Malvinas) Pound - £ * `FJD` - Fiji Dollar - $ * `GHS` - Ghana Cedi - ¢ * `GIP` - Gibraltar Pound - £ * `GTQ` - Guatemala Quetzal - Q * `GGP` - Guernsey Pound - £ * `GYD` - Guyana Dollar - $ * `HNL` - Honduras Lempira - L * `HKD` - Hong Kong Dollar - $ * `HUF` - Hungary Forint - Ft * `ISK` - Iceland Krona - kr * `INR` - India Rupee - INR * `IDR` - Indonesia Rupiah - Rp * `IRR` - Iran Rial - ﷼ * `IMP` - Isle of Man Pound - £ * `ILS` - Israel Shekel - ₪ * `JMD` - Jamaica Dollar - J$ * `JPY` - Japan Yen - ¥ * `JEP` - Jersey Pound - £ * `KZT` - Kazakhstan Tenge - лв * `KPW` - Korea (North) Won - ₩ * `KRW` - Korea (South) Won - ₩ * `KGS` - Kyrgyzstan Som - лв * `LAK` - Laos Kip - ₭ * `LBP` - Lebanon Pound - £ * `LRD` - Liberia Dollar - $ * `MKD` - Macedonia Denar - ден * `MYR` - Malaysia Ringgit - RM * `MUR` - Mauritius Rupee - ₨ * `MXN` - Mexico Peso - $ * `MNT` - Mongolia Tughrik - ₮ * `MZN` - Mozambique Metical - MT * `NAD` - Namibia Dollar - $ * `NPR` - Nepal Rupee - ₨ * `ANG` - Netherlands Antilles Guilder - ƒ * `NZD` - New Zealand Dollar - NZ$ * `NIO` - Nicaragua Cordoba - C$ * `NGN` - Nigeria Naira - ₦ * `NOK` - Norway Krone - kr * `OMR` - Oman Rial - ﷼ * `PKR` - Pakistan Rupee - ₨ * `PAB` - Panama Balboa - B/. * `PYG` - Paraguay Guarani - Gs * `PEN` - Peru Sol - S/. * `PHP` - Philippines Peso - ₱ * `PLN` - Poland Zloty - zł * `QAR` - Qatar Riyal - ﷼ * `RON` - Romania Leu - lei * `RUB` - Russia Ruble - ₽ * `SHP` - Saint Helena Pound - £ * `SAR` - Saudi Arabia Riyal - ﷼ * `RSD` - Serbia Dinar - Дин. * `SCR` - Seychelles Rupee - ₨ * `SGD` - Singapore Dollar - $ * `SBD` - Solomon Islands Dollar - $ * `SOS` - Somalia Shilling - S * `ZAR` - South Africa Rand - R * `LKR` - Sri Lanka Rupee - ₨ * `SEK` - Sweden Krona - kr * `CHF` - Switzerland Franc - CHF * `SRD` - Suriname Dollar - $ * `SYP` - Syria Pound - £ * `TWD` - Taiwan New Dollar - NT$ * `THB` - Thailand Baht - ฿ * `TTD` - Trinidad and Tobago Dollar - TT$ * `TRY` - Turkey Lira - TRY * `TVD` - Tuvalu Dollar - $ * `UAH` - Ukraine Hryvnia - ₴ * `GBP` - United Kingdom Pound - £ * `USD` - US Dollar - $ * `UYU` - Uruguay Peso - $U * `UZS` - Uzbekistan Som - лв * `VEF` - Venezuela Bolívar - Bs * `VND` - Viet Nam Dong - ₫ * `YER` - Yemen Rial - ﷼ * `ZWD` - Zimbabwe Dollar - Z$ * `DZD` - Algerian Dinar - DZD * `AOA` - Kwanza - AOA * `AMD` - Armenian Dram - AMD * `AZM` - Azerbaijanian Manat - AZM * `BHD` - Bahraini Dinar - BHD * `BDT` - Taka - BDT * `BYR` - Belarussian Ruble - BYR * `XOF` - CFA Franc BCEAO - XOF * `BTN` - Ngultrum - BTN * `BOV` - Mvdol - BOV * `BIF` - Burundi Franc - BIF * `XAF` - CFA Franc BEAC - XAF * `CVE` - Cape Verde Escudo - CVE * `CLF` - Unidades de fomento - CLF * `COU` - Unidad de Valor Real - COU * `KMF` - Comoro Franc - KMF * `CDF` - Franc Congolais - CDF * `CYP` - Cyprus Pound - CYP * `DJF` - Djibouti Franc - DJF * `ERN` - Nakfa - ERN * `EEK` - Kroon - EEK * `ETB` - Ethiopian Birr - ETB * `XPF` - CFP Franc - XPF * `GMD` - Dalasi - GMD * `GEL` - Lari - GEL * `GHC` - Cedi - GHC * `GNF` - Guinea Franc - GNF * `GWP` - Guinea-Bissau Peso - GWP * `HTG` - Gourde - HTG * `IQD` - Iraqi Dinar - IQD * `JOD` - Jordanian Dinar - JOD * `KES` - Kenyan Shilling - KES * `KWD` - Kuwaiti Dinar - KWD * `LVL` - Latvian Lats - LVL * `LSL` - Loti - LSL * `LYD` - Lybian Dinar - LYD * `LTL` - Lithuanian Litas - LTL * `MOP` - Pataca - MOP * `MGA` - Ariary - MGA * `MGF` - Malagasy Franc - MGF * `MWK` - Kwacha - MWK * `MVR` - Rufiyaa - MVR * `MTL` - Maltese Lira - MTL * `MRO` - Ouguiya - MRO * `MXV` - Mexican Unidad de Inversion (UDI) - MXV * `MDL` - Moldovan Leu - MDL * `MAD` - Moroccan Dirham - MAD * `MZM` - Metical - MZM * `MMK` - Kyat - MMK * `PGK` - Kina - PGK * `ROL` - Leu - ROL * `RUR` - Russian Ruble - RUR * `RWF` - Rwanda Franc - RWF * `WST` - Tala - WST * `STD` - Dobra - STD * `CSD` - Serbian Dinar - CSD * `SLL` - Leone - SLL * `SKK` - Slovak Koruna - SKK * `SIT` - Tolar - SIT * `SDD` - Sudanese Dinar - SDD * `SZL` - Lilangeni - SZL * `TJS` - Somoni - TJS * `TZS` - Tanzanian Shilling - TZS * `TOP` - Pa�anga - TOP * `TND` - Tunisian Dinar - TND * `TRL` - Turkish Lira - TRL * `TMM` - Manat - TMM * `UGX` - Uganda Shilling - UGX * `AED` - UAE Dirham - AED * `USS` - US Dollar (Same day) - USS * `USN` - US Dollar (Next day) - USN * `VUV` - Vatu - VUV * `VEB` - Bolivar - VEB * `ZMK` - Kwacha - ZMK
      - ''
    - `payment_method` 'CASH_ON_DELIVERY' | 'DEBIT_CARD' | 'CREDIT_CARD' | 'DIGITAL_WALLET' | 'OTHER', required: * `CASH_ON_DELIVERY` - Cash On Delivery * `DEBIT_CARD` - Debit Card * `CREDIT_CARD` - Credit Card * `DIGITAL_WALLET` - Digital Wallet * `OTHER` - Other
    - `cod_amount` string, decimal, nullable
    - `billing_address` CustomAddress, required
      - `first_name` string, nullable
      - `last_name` string, nullable
      - `email` string, nullable
      - `address_line1` string, nullable
      - `address_line2` string, nullable
      - `address_line3` string, nullable
      - `suburb` string, nullable
      - `city` string, nullable
      - `state` string, nullable
      - `country_code` 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | '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' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | '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' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'AN' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'CS' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | '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', required: * `AF` - AF * `AL` - AL * `DZ` - DZ * `AS` - AS * `AD` - AD * `AO` - AO * `AI` - AI * `AG` - AG * `AR` - AR * `AM` - AM * `AW` - AW * `AU` - AU * `AT` - AT * `AZ` - AZ * `BS` - BS * `BH` - BH * `BD` - BD * `BB` - BB * `BY` - BY * `BE` - BE * `BZ` - BZ * `BJ` - BJ * `BM` - BM * `BT` - BT * `BO` - BO * `BA` - BA * `BW` - BW * `BV` - BV * `BR` - BR * `IO` - IO * `BN` - BN * `BG` - BG * `BF` - BF * `BI` - BI * `KH` - KH * `CM` - CM * `CA` - CA * `CV` - CV * `KY` - KY * `CF` - CF * `TD` - TD * `CL` - CL * `CN` - CN * `CX` - CX * `CC` - CC * `CO` - CO * `KM` - KM * `CG` - CG * `CD` - CD * `CK` - CK * `CR` - CR * `CI` - CI * `HR` - HR * `CU` - CU * `CY` - CY * `CZ` - CZ * `DK` - DK * `DJ` - DJ * `DM` - DM * `DO` - DO * `EC` - EC * `EG` - EG * `SV` - SV * `GQ` - GQ * `ER` - ER * `EE` - EE * `ET` - ET * `FK` - FK * `FO` - FO * `FJ` - FJ * `FI` - FI * `FR` - FR * `GF` - GF * `PF` - PF * `TF` - TF * `GA` - GA * `GM` - GM * `GE` - GE * `DE` - DE * `GH` - GH * `GI` - GI * `GR` - GR * `GL` - GL * `GD` - GD * `GP` - GP * `GU` - GU * `GT` - GT * `GN` - GN * `GW` - GW * `GY` - GY * `HT` - HT * `HM` - HM * `VA` - VA * `HN` - HN * `HK` - HK * `HU` - HU * `IS` - IS * `IN` - IN * `ID` - ID * `IR` - IR * `IQ` - IQ * `IE` - IE * `IL` - IL * `IT` - IT * `JM` - JM * `JP` - JP * `JO` - JO * `KZ` - KZ * `KE` - KE * `KI` - KI * `KP` - KP * `KR` - KR * `KW` - KW * `KG` - KG * `LA` - LA * `LV` - LV * `LB` - LB * `LS` - LS * `LR` - LR * `LY` - LY * `LI` - LI * `LT` - LT * `LU` - LU * `MO` - MO * `MK` - MK * `MG` - MG * `MW` - MW * `MY` - MY * `MV` - MV * `ML` - ML * `MT` - MT * `MH` - MH * `MQ` - MQ * `MR` - MR * `MU` - MU * `YT` - YT * `MX` - MX * `FM` - FM * `MD` - MD * `MC` - MC * `MN` - MN * `MS` - MS * `MA` - MA * `MZ` - MZ * `MM` - MM * `NA` - NA * `NR` - NR * `NP` - NP * `NL` - NL * `AN` - AN * `NC` - NC * `NZ` - NZ * `NI` - NI * `NE` - NE * `NG` - NG * `NU` - NU * `NF` - NF * `MP` - MP * `NO` - NO * `OM` - OM * `PK` - PK * `PW` - PW * `PA` - PA * `PG` - PG * `PY` - PY * `PE` - PE * `PH` - PH * `PN` - PN * `PL` - PL * `PT` - PT * `PR` - PR * `QA` - QA * `RE` - RE * `RO` - RO * `RU` - RU * `RW` - RW * `SH` - SH * `KN` - KN * `LC` - LC * `PM` - PM * `VC` - VC * `WS` - WS * `SM` - SM * `ST` - ST * `SA` - SA * `SN` - SN * `CS` - CS * `SC` - SC * `SL` - SL * `SG` - SG * `SK` - SK * `SI` - SI * `SB` - SB * `SO` - SO * `ZA` - ZA * `ES` - ES * `LK` - LK * `SD` - SD * `SR` - SR * `SJ` - SJ * `SZ` - SZ * `SE` - SE * `CH` - CH * `SY` - SY * `TW` - TW * `TJ` - TJ * `TZ` - TZ * `TH` - TH * `TL` - TL * `TG` - TG * `TK` - TK * `TO` - TO * `TT` - TT * `TN` - TN * `TR` - TR * `TM` - TM * `TC` - TC * `TV` - TV * `UG` - UG * `UA` - UA * `AE` - AE * `GB` - GB * `US` - US * `UM` - UM * `UY` - UY * `UZ` - UZ * `VU` - VU * `VE` - VE * `VN` - VN * `VG` - VG * `VI` - VI * `WF` - WF * `EH` - EH * `YE` - YE * `ZM` - ZM * `ZW` - ZW
      - `zipcode` string, nullable
      - `phone` string, nullable
      - `customs_code` string, nullable: Customs code for the address. This is used to identify the address for customs purposes.
    - `shipping_address` CustomAddress, required
      - `first_name` string, nullable
      - `last_name` string, nullable
      - `email` string, nullable
      - `address_line1` string, nullable
      - `address_line2` string, nullable
      - `address_line3` string, nullable
      - `suburb` string, nullable
      - `city` string, nullable
      - `state` string, nullable
      - `country_code` 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | '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' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | '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' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'AN' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'CS' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | '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', required: * `AF` - AF * `AL` - AL * `DZ` - DZ * `AS` - AS * `AD` - AD * `AO` - AO * `AI` - AI * `AG` - AG * `AR` - AR * `AM` - AM * `AW` - AW * `AU` - AU * `AT` - AT * `AZ` - AZ * `BS` - BS * `BH` - BH * `BD` - BD * `BB` - BB * `BY` - BY * `BE` - BE * `BZ` - BZ * `BJ` - BJ * `BM` - BM * `BT` - BT * `BO` - BO * `BA` - BA * `BW` - BW * `BV` - BV * `BR` - BR * `IO` - IO * `BN` - BN * `BG` - BG * `BF` - BF * `BI` - BI * `KH` - KH * `CM` - CM * `CA` - CA * `CV` - CV * `KY` - KY * `CF` - CF * `TD` - TD * `CL` - CL * `CN` - CN * `CX` - CX * `CC` - CC * `CO` - CO * `KM` - KM * `CG` - CG * `CD` - CD * `CK` - CK * `CR` - CR * `CI` - CI * `HR` - HR * `CU` - CU * `CY` - CY * `CZ` - CZ * `DK` - DK * `DJ` - DJ * `DM` - DM * `DO` - DO * `EC` - EC * `EG` - EG * `SV` - SV * `GQ` - GQ * `ER` - ER * `EE` - EE * `ET` - ET * `FK` - FK * `FO` - FO * `FJ` - FJ * `FI` - FI * `FR` - FR * `GF` - GF * `PF` - PF * `TF` - TF * `GA` - GA * `GM` - GM * `GE` - GE * `DE` - DE * `GH` - GH * `GI` - GI * `GR` - GR * `GL` - GL * `GD` - GD * `GP` - GP * `GU` - GU * `GT` - GT * `GN` - GN * `GW` - GW * `GY` - GY * `HT` - HT * `HM` - HM * `VA` - VA * `HN` - HN * `HK` - HK * `HU` - HU * `IS` - IS * `IN` - IN * `ID` - ID * `IR` - IR * `IQ` - IQ * `IE` - IE * `IL` - IL * `IT` - IT * `JM` - JM * `JP` - JP * `JO` - JO * `KZ` - KZ * `KE` - KE * `KI` - KI * `KP` - KP * `KR` - KR * `KW` - KW * `KG` - KG * `LA` - LA * `LV` - LV * `LB` - LB * `LS` - LS * `LR` - LR * `LY` - LY * `LI` - LI * `LT` - LT * `LU` - LU * `MO` - MO * `MK` - MK * `MG` - MG * `MW` - MW * `MY` - MY * `MV` - MV * `ML` - ML * `MT` - MT * `MH` - MH * `MQ` - MQ * `MR` - MR * `MU` - MU * `YT` - YT * `MX` - MX * `FM` - FM * `MD` - MD * `MC` - MC * `MN` - MN * `MS` - MS * `MA` - MA * `MZ` - MZ * `MM` - MM * `NA` - NA * `NR` - NR * `NP` - NP * `NL` - NL * `AN` - AN * `NC` - NC * `NZ` - NZ * `NI` - NI * `NE` - NE * `NG` - NG * `NU` - NU * `NF` - NF * `MP` - MP * `NO` - NO * `OM` - OM * `PK` - PK * `PW` - PW * `PA` - PA * `PG` - PG * `PY` - PY * `PE` - PE * `PH` - PH * `PN` - PN * `PL` - PL * `PT` - PT * `PR` - PR * `QA` - QA * `RE` - RE * `RO` - RO * `RU` - RU * `RW` - RW * `SH` - SH * `KN` - KN * `LC` - LC * `PM` - PM * `VC` - VC * `WS` - WS * `SM` - SM * `ST` - ST * `SA` - SA * `SN` - SN * `CS` - CS * `SC` - SC * `SL` - SL * `SG` - SG * `SK` - SK * `SI` - SI * `SB` - SB * `SO` - SO * `ZA` - ZA * `ES` - ES * `LK` - LK * `SD` - SD * `SR` - SR * `SJ` - SJ * `SZ` - SZ * `SE` - SE * `CH` - CH * `SY` - SY * `TW` - TW * `TJ` - TJ * `TZ` - TZ * `TH` - TH * `TL` - TL * `TG` - TG * `TK` - TK * `TO` - TO * `TT` - TT * `TN` - TN * `TR` - TR * `TM` - TM * `TC` - TC * `TV` - TV * `UG` - UG * `UA` - UA * `AE` - AE * `GB` - GB * `US` - US * `UM` - UM * `UY` - UY * `UZ` - UZ * `VU` - VU * `VE` - VE * `VN` - VN * `VG` - VG * `VI` - VI * `WF` - WF * `EH` - EH * `YE` - YE * `ZM` - ZM * `ZW` - ZW
      - `zipcode` string, nullable
      - `phone` string, nullable
      - `customs_code` string, nullable: Customs code for the address. This is used to identify the address for customs purposes.
    - `total_price` string, decimal
    - `shipment_type` union
      - 'Standard' | 'Express' | 'SameDay' | 'NextDay' | 'Scheduled' | 'ReturnDropoff' | 'ReturnStandard' | 'ReturnExpress': * `Standard` - Standard * `Express` - Express * `SameDay` - SameDay * `NextDay` - NextDay * `Scheduled` - Scheduled * `ReturnDropoff` - ReturnDropoff * `ReturnStandard` - ReturnStandard * `ReturnExpress` - ReturnExpress
      - ''
      - unknown
    - `order_items` CustomWebstoreOrderItem[], required
      - `id` integer, required
      - `catalogue_product_id` string
      - `quantity` integer
      - `price` string, decimal
      - `warehouse_id` integer, nullable
      - `inventory_sku` string, nullable
      - `fulfilment_group_id` string, nullable
      - `should_fulfil` boolean
      - `shipment_required` boolean
      - `order_item_id` string, required
      - `cancel_reason` string, required
      - `cancel_by` string, required
      - `cancelled_at` string, date-time, nullable, required
      - `created_at` string, date-time, required
      - `updated_at` string, date-time, required
      - `cancelled` boolean, required
      - `shipment_status` union, required
        - 'UNASSIGNED' | 'PICKUP_PENDING' | 'PACKAGE_PICKED' | 'OUT_FOR_DELIVERY_1' | 'CANCELLED' | 'DELIVERED' | 'RETURN_TRIGGERED' | 'RETURNED' | 'LOST': * `UNASSIGNED` - UNASSIGNED * `PICKUP_PENDING` - PICKUP_PENDING * `PACKAGE_PICKED` - PACKAGE_PICKED * `OUT_FOR_DELIVERY_1` - OUT_FOR_DELIVERY_1 * `CANCELLED` - CANCELLED * `DELIVERED` - DELIVERED * `RETURN_TRIGGERED` - RETURN_TRIGGERED * `RETURNED` - RETURNED * `LOST` - LOST
        - unknown
      - `tracking_number` string, required
      - `tracking_url` string, nullable, required
      - `shipment_provider_name` string, required
      - `rts_sla_time` string, date-time, nullable
      - `sot_sla_time` string, date-time, nullable
      - `warehouse_status` union, required
        - 'CANCELLED' | 'COMPLETED' | 'ERROR' | 'IN_TRANSIT' | 'LOST' | 'NEW' | 'ON_HOLD' | 'OUT_FOR_DELIVERY' | 'OUT_OF_STOCK' | 'PACKED' | 'PARTIAL' | 'PARTIAL_PICKED' | 'PICKED' | 'PICKING' | 'PREORDER' | 'PUTAWAY' | 'READY_FOR_DISPATCH' | 'READY_FOR_PICKING' | 'RELEASED' | 'RETURN_COMPLETED' | 'RETURN_IN_PROGRESS' | 'SCHEDULED' | 'UNKNOWN' | 'UNPAID': * `CANCELLED` - 16 * `COMPLETED` - 17 * `ERROR` - 21 * `IN_TRANSIT` - 13 * `LOST` - 22 * `NEW` - 5 * `ON_HOLD` - 0 * `OUT_FOR_DELIVERY` - 14 * `OUT_OF_STOCK` - 23 * `PACKED` - 11 * `PARTIAL` - 6 * `PARTIAL_PICKED` - 7 * `PICKED` - 10 * `PICKING` - 9 * `PREORDER` - 1 * `PUTAWAY` - 15 * `READY_FOR_DISPATCH` - 12 * `READY_FOR_PICKING` - 8 * `RELEASED` - 4 * `RETURN_COMPLETED` - 19 * `RETURN_IN_PROGRESS` - 18 * `SCHEDULED` - 2 * `UNKNOWN` - 20 * `UNPAID` - 3
        - unknown
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `payment_verified` boolean: Indicates whether the payment has been successfully verified or not. Default is True. Order will be in UNPAID status if False.
    - `is_gift` boolean
    - `gift_message` string, nullable
    - `is_paused` boolean, nullable
    - `fulfilment_groups` CustomWebstoreFulfilmentGroup[]
      - `fulfilment_group_id` string, required
      - `tracking_number` string, required
      - `waybill_url` string, nullable
      - `shipment_provider_name` string, nullable
      - `sort_code` string, nullable
      - `tracking_url` string, nullable
      - `generate_template_waybill` boolean, nullable
      - `warehouse_status` union
        - 'CANCELLED' | 'COMPLETED' | 'ERROR' | 'IN_TRANSIT' | 'LOST' | 'NEW' | 'ON_HOLD' | 'OUT_FOR_DELIVERY' | 'OUT_OF_STOCK' | 'PACKED' | 'PARTIAL' | 'PARTIAL_PICKED' | 'PICKED' | 'PICKING' | 'PREORDER' | 'PUTAWAY' | 'READY_FOR_DISPATCH' | 'READY_FOR_PICKING' | 'RELEASED' | 'RETURN_COMPLETED' | 'RETURN_IN_PROGRESS' | 'SCHEDULED' | 'UNKNOWN' | 'UNPAID': * `CANCELLED` - 16 * `COMPLETED` - 17 * `ERROR` - 21 * `IN_TRANSIT` - 13 * `LOST` - 22 * `NEW` - 5 * `ON_HOLD` - 0 * `OUT_FOR_DELIVERY` - 14 * `OUT_OF_STOCK` - 23 * `PACKED` - 11 * `PARTIAL` - 6 * `PARTIAL_PICKED` - 7 * `PICKED` - 10 * `PICKING` - 9 * `PREORDER` - 1 * `PUTAWAY` - 15 * `READY_FOR_DISPATCH` - 12 * `READY_FOR_PICKING` - 8 * `RELEASED` - 4 * `RETURN_COMPLETED` - 19 * `RETURN_IN_PROGRESS` - 18 * `SCHEDULED` - 2 * `UNKNOWN` - 20 * `UNPAID` - 3
        - unknown
      - `sla_timestamps` FulfilmentOrderOpenAPISlaTimes, required
        - `released_at` string, date-time, nullable
        - `partial_at` string, date-time, nullable
        - `picked_at` string, date-time, nullable
        - `waybill_fetched_at` string, date-time, nullable
        - `packed_at` string, date-time, nullable
        - `ready_for_dispatch_at` string, date-time, nullable
        - `dispatched_at` string, date-time, nullable
        - `out_for_delivery_at` string, date-time, nullable
        - `completed_at` string, date-time, nullable
        - `cancelled_at` string, date-time, nullable
        - `returned_at` string, date-time, nullable
        - `new_at` string, date-time, nullable
        - `ready_for_picking_at` string, date-time, nullable
    - `is_ddp` boolean, nullable: Indicates whether Delivery Duty paid or not.
    - `has_ddp_info` boolean, nullable: Indicates whether Delivery Duty info is available or not.
    - `channel_name` string, nullable: Sales channel or marketplace from which the order originated. Must be one of: amazon, bbo, capillary, ebay, ginee, kumu, lazada, noon, salla, shopee, shopify, temu, tiktok, tokopedia, wix, woocommerce, zalora, zid, walmart, etsy, target, flipkart, namshi, instagram, whatsapp, shein, website, other
  - `message` string, required

## Other responses

- `400`: Bad Request - Invalid input.
- `401`: Unauthorized - Invalid or expired credentials.
- `403`: Forbidden - You do not have permission to access this resource.
- `404`: Not Found - The requested resource does not exist.
- `500`: Internal Server Error - Unexpected error occurred.

---

[API](https://skmtc.dev/golocad/apis/locad-api.md) - [All operations](https://skmtc.dev/golocad/apis/locad-api/llms.txt) - [OpenAPI document](https://skmtc.dev/golocad/apis/locad-api/revisions/428200f33a81?raw)