HighLevel: Store schemas
33 HighLevel schemas with complete fields and constraints.
← Store operations · All schemas
Create Shipping Carrier — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allowsMultipleServiceSelection | boolean | Optional | The seller can choose multiple services while creating shipping rates if this is true. |
altId | string | Required within parent | Location Id or Agency Id |
altType | string | Required within parent | One of: location |
callbackUrl | string | Required within parent | The URL endpoint that CRM needs to retrieve shipping rates. This must be a public URL. |
name | string | Required within parent | Name of the shipping carrier |
services | array | Optional | An array of available shipping carrier services |
services[] | Model | Each item | Expand Create Shipping Carrier — request body — body services item |
Referenced models: Create Shipping Carrier — request body — body services item
Create Shipping Carrier — request body — body services item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Required within parent | Name of the shipping carrier service |
value | string | Required within parent | Value of the shipping carrier service |
Create Shipping Rate — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
altId | string | Required within parent | Location Id or Agency Id |
altType | string | Required within parent | One of: location |
amount | number | Required within parent | The amount of the shipping rate if it is normal rate (0 means free ). Fixed Handling fee if it is a carrier rate (it will add to the carrier rate). |
conditionType | string | Required within parent | Type of condition to provide the conditional pricing One of: none, price, weight |
currency | string | Required within parent | The currency of the amount of the rate / handling fee |
description | string | Optional | Delivery description |
isCarrierRate | boolean | Optional | is this a carrier rate |
maxCondition | number | Required within parent | Maximum condition for applying this price. set 0 or null if there is no maximum |
minCondition | number | Required within parent | Minimum condition for applying this price. set 0 or null if there is no minimum |
name | string | Required within parent | Name of the shipping zone |
percentageOfRateFee | number | Optional | Percentage of rate fee if it is a carrier rate. |
shippingCarrierId | string | Required within parent | Shipping carrier id |
shippingCarrierServices | array | Optional | An array of items |
shippingCarrierServices[] | Model | Each item | Expand Create Shipping Carrier — request body — body services item |
Referenced models: Create Shipping Carrier — request body — body services item
Create Shipping Zone — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
altId | string | Required within parent | Location Id or Agency Id |
altType | string | Required within parent | One of: location |
countries | array | Required within parent | List of countries that are available |
countries[] | Model | Each item | Expand Create Shipping Zone — request body — body countries item |
name | string | Required within parent | Name of the shipping zone |
Referenced models: Create Shipping Zone — request body — body countries item
Create Shipping Zone — request body — body countries item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
code | string | Required within parent | Country code One of: US, CA, 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, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, 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, 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, XK, 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, AN, 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, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, KR, 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, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW |
states | array | Optional | List of states that are available. If states is empty, then all states are available |
states[] | Model | Each item | Expand Create Shipping Zone — request body — body countries item states item |
Referenced models: Create Shipping Zone — request body — body countries item states item
Create Shipping Zone — request body — body countries item states item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
code | string | Required within parent | State code One of: AL, AK, AS, AZ, AR, AA, AE, AP, CA, CO, CT, DE, DC, FM, FL, GA, GU, HI, ID, IL, IN, IA, KS, KY, LA, ME, MH, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, MP, OH, OK, OR, PW, PA, PR, RI, SC, SD, TN, TX, UT, VT, VI, VA, WA, WV, WI, WY, AB, BC, MB, NB, NL, NT, NS, NU, ON, PE, QC, SK, YT, BA, CT, CC, CH, CB, CN, ER, FO, JY, LP, LR, MZ, MN, NQ, RN, SA, SJ, SL, SC, SF, SE, TF, TU, ACT, NSW, NT, QLD, SA, TAS, VIC, WA, AC, AL, AM, AP, BA, CE, DF, ES, GO, MA, MG, MS, MT, PA, PB, PE, PI, PR, RJ, RN, RO, RR, RS, SC, SE, SP, TO, AI, AN, AP, AT, BI, CO, AR, LI, LL, LR, MA, ML, RM, TA, VS, NB, AMA, ANT, ARA, ATL, BOL, BOY, CAL, CAQ, CAS, CAU, CES, CHO, CUN, COR, GUA, GUV, HUI, LAG, MAG, MET, NAR, NSA, PUT, QUI, RIS, SAP, SAN, SUC, TOL, VAC, VAU, VID, CR-A, CR-C, CR-G, CR-H, CR-L, CR-P, CR-SJ, GT-16, GT-15, GT-04, GT-20, GT-02, GT-05, GT-01, GT-13, GT-18, GT-21, GT-22, GT-17, GT-09, GT-14, GT-11, GT-03, GT-12, GT-06, GT-07, GT-10, GT-08, GT-19, HK, KL, NT, AN, AP, AR, AS, BR, CH, CG, DN, DD, DL, GA, GJ, HR, HP, JK, JH, KA, KL, LA, LD, MP, MH, MN, ML, MZ, NL, OR, PY, PB, RJ, SK, TN, TS, TR, UP, UK, WB, CW, CN, CE, CO, DL, D, G, KY, KE, KK, LS, LM, LK, LD, LH, MO, MH, MN, OY, RN, SO, TA, WD, WH, WX, WW, AG, AL, AN, AO, AR, AP, AT, AV, BA, BT, BL, BN, BG, BI, BO, BZ, BS, BR, CA, CL, CB, CI, CE, CT, CZ, CH, CO, CS, CR, KR, CN, EN, FM, FE, FI, FG, FC, FR, GE, GO, GR, IM, IS, AQ, SP, LT, LE, LC, LI, LO, LU, MC, MN, MS, MT, VS, ME, MI, MO, MB, NA, NO, NU, OG, OT, OR, PD, PA, PR, PV, PG, PU, PE, PC, PI, PT, PN, PZ, PO, RG, RA, RC, RE, RI, RN, RM, RO, SA, SS, SV, SI, SR, SO, TA, TE, TR, TO, TP, TN, TV, TS, UD, VA, VE, VB, VC, VR, VV, VI, VT, JP-23, JP-05, JP-02, JP-12, JP-38, JP-18, JP-40, JP-07, JP-21, JP-10, JP-34, JP-01, JP-28, JP-08, JP-17, JP-03, JP-37, JP-46, JP-14, JP-39, JP-43, JP-26, JP-24, JP-04, JP-45, JP-20, JP-42, JP-29, JP-15, JP-44, JP-33, JP-47, JP-27, JP-41, JP-11, JP-25, JP-32, JP-22, JP-09, JP-36, JP-13, JP-31, JP-16, JP-30, JP-06, JP-35, JP-19, JHR, KDH, KTN, KUL, LBN, MLK, NSN, PHG, PNG, PRK, PLS, PJY, SBH, SWK, SGR, TRG, AGU, BCN, BCS, CAM, CHP, CHH, CMX, COA, COL, DUR, GUA, GRO, HID, JAL, MIC, MOR, MEX, NAY, NLE, OAX, PUE, QUE, ROO, SLP, SIN, SON, TAB, TAM, TLA, VER, YUC, ZAC, AUK, BOP, CAN, CIT, GIS, HKB, MWT, MBH, NSN, NTL, OTA, STL, TKI, TAS, WKO, WGN, WTC, JK, BA, GB, IS, KP, PB, SD, AMA, ANC, APU, ARE, AYA, CAJ, CAL, CUS, HUV, HUC, ICA, JUN, LAL, LAM, LIM, LOR, MDD, MOQ, PAS, PIU, PUN, SAM, TAC, TUM, UCA, PH-ABR, PH-AGN, PH-AGS, PH-AKL, PH-ALB, PH-ANT, PH-APA, PH-AUR, PH-BAS, PH-BAN, PH-BTN, PH-BTG, PH-BEN, PH-BIL, PH-BOH, PH-BUK, PH-BUL, PH-CAG, PH-CAN, PH-CAS, PH-CAM, PH-CAP, PH-CAT, PH-CAV, PH-CEB, PH-NCO, PH-DAO, PH-DAV, PH-DAS, PH-EAS, PH-GUI, PH-IFU, PH-ILN, PH-ILS, PH-ILI, PH-ISA, PH-KAL, PH-LUN, PH-LAG, PH-LAN, PH-LAS, PH-LEY, PH-MAG, PH-MAD, PH-MAS, PH-00, PH-MSC, PH-MSR, PH-MOU, PH-NEC, PH-NER, PH-NSA, PH-NUE, PH-NUV, PH-MDC, PH-MDR, PH-PLW, PH-PAM, PH-PAN, PH-QUE, PH-QUI, PH-RIZ, PH-ROM, PH-WSA, PH-SAR, PH-SIG, PH-SOR, PH-SCO, PH-SLE, PH-SUK, PH-SLU, PH-SUN, PH-SUR, PH-TAR, PH-TAW, PH-ZMB, PH-ZAN, PH-ZAS, PH-ZSI, PT-20, PT-01, PT-02, PT-03, PT-04, PT-05, PT-06, PT-07, PT-08, PT-09, PT-10, PT-11, PT-30, PT-12, PT-13, PT-14, PT-15, PT-16, PT-17, PT-18, AB, AR, AG, BC, BH, BN, BT, BR, BV, B, BZ, CL, CS, CJ, CT, CV, DB, DJ, GL, GR, GJ, HR, HD, IL, IS, IF, MM, MH, MS, NT, OT, PH, SJ, SM, SB, SV, TR, TM, TL, VL, VS, VN, KR-26, KR-43, KR-44, KR-27, KR-30, KR-42, KR-29, KR-47, KR-41, KR-48, KR-28, KR-49, KR-45, KR-46, KR-50, KR-11, KR-31, C, VI, AB, A, AL, O, AV, BA, PM, B, BU, CC, CA, S, CS, CE, CR, CO, CU, GI, GR, GU, SS, H, HU, J, LO, GC, LE, L, LU, M, MA, ML, MU, NA, OR, P, PO, SA, TF, SG, SE, SO, T, TE, TO, V, VA, BI, ZA, Z, AZ, AJ, DU, FU, RK, SH, UQ, BFP, ENG, NIR, SCT, WLS, AR, CA, CL, CO, DU, FS, FD, LA, MA, MO, PA, RN, RV, RO, SA, SJ, SO, TA, TT |
Create Update Store Settings — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
altId | string | Required within parent | Location Id or Agency Id |
altType | string | Required within parent | One of: location |
shippingOrigin | JSON | Required within parent | Shipping origin address |
shippingOrigin (allOf 1) | Model | All variants apply | Expand Create Update Store Settings — request body — body shipping Origin city, country, email, name, phone, state, street1, street2, zip |
storeOrderFulfillmentNotification | JSON | Optional | Store order fulfillment notification email |
storeOrderFulfillmentNotification (allOf 1) | Model | All variants apply | Expand Create Update Store Settings — request body — body store Order Fulfillment Notification default Email Template Id, email Template Id, enabled, subject |
storeOrderNotification | JSON | Optional | Store order notification email |
storeOrderNotification (allOf 1) | Model | All variants apply | Expand Create Update Store Settings — request body — body store Order Notification default Email Template Id, email Template Id, enabled, subject |
Referenced models: Create Update Store Settings — request body — body store Order Fulfillment Notification default Email Template Id, email Template Id, enabled, subject, Create Update Store Settings — request body — body store Order Notification default Email Template Id, email Template Id, enabled, subject, Create Update Store Settings — request body — body shipping Origin city, country, email, name, phone, state, street1, street2, zip
Create Update Store Settings — request body — body shipping Origin city, country, email, name, phone, state, street1, street2, zip
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
city | string | Required within parent | City name |
country | string | Required within parent | Country code One of: US, CA, 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, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, 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, 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, XK, 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, AN, 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, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, KR, 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, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW |
email | string | Optional | |
name | string | Required within parent | Name of the store / company |
phone | string | Optional | Business Phone Number |
state | string | Optional | State code One of: AL, AK, AS, AZ, AR, AA, AE, AP, CA, CO, CT, DE, DC, FM, FL, GA, GU, HI, ID, IL, IN, IA, KS, KY, LA, ME, MH, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, MP, OH, OK, OR, PW, PA, PR, RI, SC, SD, TN, TX, UT, VT, VI, VA, WA, WV, WI, WY, AB, BC, MB, NB, NL, NT, NS, NU, ON, PE, QC, SK, YT, BA, CT, CC, CH, CB, CN, ER, FO, JY, LP, LR, MZ, MN, NQ, RN, SA, SJ, SL, SC, SF, SE, TF, TU, ACT, NSW, NT, QLD, SA, TAS, VIC, WA, AC, AL, AM, AP, BA, CE, DF, ES, GO, MA, MG, MS, MT, PA, PB, PE, PI, PR, RJ, RN, RO, RR, RS, SC, SE, SP, TO, AI, AN, AP, AT, BI, CO, AR, LI, LL, LR, MA, ML, RM, TA, VS, NB, AMA, ANT, ARA, ATL, BOL, BOY, CAL, CAQ, CAS, CAU, CES, CHO, CUN, COR, GUA, GUV, HUI, LAG, MAG, MET, NAR, NSA, PUT, QUI, RIS, SAP, SAN, SUC, TOL, VAC, VAU, VID, CR-A, CR-C, CR-G, CR-H, CR-L, CR-P, CR-SJ, GT-16, GT-15, GT-04, GT-20, GT-02, GT-05, GT-01, GT-13, GT-18, GT-21, GT-22, GT-17, GT-09, GT-14, GT-11, GT-03, GT-12, GT-06, GT-07, GT-10, GT-08, GT-19, HK, KL, NT, AN, AP, AR, AS, BR, CH, CG, DN, DD, DL, GA, GJ, HR, HP, JK, JH, KA, KL, LA, LD, MP, MH, MN, ML, MZ, NL, OR, PY, PB, RJ, SK, TN, TS, TR, UP, UK, WB, CW, CN, CE, CO, DL, D, G, KY, KE, KK, LS, LM, LK, LD, LH, MO, MH, MN, OY, RN, SO, TA, WD, WH, WX, WW, AG, AL, AN, AO, AR, AP, AT, AV, BA, BT, BL, BN, BG, BI, BO, BZ, BS, BR, CA, CL, CB, CI, CE, CT, CZ, CH, CO, CS, CR, KR, CN, EN, FM, FE, FI, FG, FC, FR, GE, GO, GR, IM, IS, AQ, SP, LT, LE, LC, LI, LO, LU, MC, MN, MS, MT, VS, ME, MI, MO, MB, NA, NO, NU, OG, OT, OR, PD, PA, PR, PV, PG, PU, PE, PC, PI, PT, PN, PZ, PO, RG, RA, RC, RE, RI, RN, RM, RO, SA, SS, SV, SI, SR, SO, TA, TE, TR, TO, TP, TN, TV, TS, UD, VA, VE, VB, VC, VR, VV, VI, VT, JP-23, JP-05, JP-02, JP-12, JP-38, JP-18, JP-40, JP-07, JP-21, JP-10, JP-34, JP-01, JP-28, JP-08, JP-17, JP-03, JP-37, JP-46, JP-14, JP-39, JP-43, JP-26, JP-24, JP-04, JP-45, JP-20, JP-42, JP-29, JP-15, JP-44, JP-33, JP-47, JP-27, JP-41, JP-11, JP-25, JP-32, JP-22, JP-09, JP-36, JP-13, JP-31, JP-16, JP-30, JP-06, JP-35, JP-19, JHR, KDH, KTN, KUL, LBN, MLK, NSN, PHG, PNG, PRK, PLS, PJY, SBH, SWK, SGR, TRG, AGU, BCN, BCS, CAM, CHP, CHH, CMX, COA, COL, DUR, GUA, GRO, HID, JAL, MIC, MOR, MEX, NAY, NLE, OAX, PUE, QUE, ROO, SLP, SIN, SON, TAB, TAM, TLA, VER, YUC, ZAC, AUK, BOP, CAN, CIT, GIS, HKB, MWT, MBH, NSN, NTL, OTA, STL, TKI, TAS, WKO, WGN, WTC, JK, BA, GB, IS, KP, PB, SD, AMA, ANC, APU, ARE, AYA, CAJ, CAL, CUS, HUV, HUC, ICA, JUN, LAL, LAM, LIM, LOR, MDD, MOQ, PAS, PIU, PUN, SAM, TAC, TUM, UCA, PH-ABR, PH-AGN, PH-AGS, PH-AKL, PH-ALB, PH-ANT, PH-APA, PH-AUR, PH-BAS, PH-BAN, PH-BTN, PH-BTG, PH-BEN, PH-BIL, PH-BOH, PH-BUK, PH-BUL, PH-CAG, PH-CAN, PH-CAS, PH-CAM, PH-CAP, PH-CAT, PH-CAV, PH-CEB, PH-NCO, PH-DAO, PH-DAV, PH-DAS, PH-EAS, PH-GUI, PH-IFU, PH-ILN, PH-ILS, PH-ILI, PH-ISA, PH-KAL, PH-LUN, PH-LAG, PH-LAN, PH-LAS, PH-LEY, PH-MAG, PH-MAD, PH-MAS, PH-00, PH-MSC, PH-MSR, PH-MOU, PH-NEC, PH-NER, PH-NSA, PH-NUE, PH-NUV, PH-MDC, PH-MDR, PH-PLW, PH-PAM, PH-PAN, PH-QUE, PH-QUI, PH-RIZ, PH-ROM, PH-WSA, PH-SAR, PH-SIG, PH-SOR, PH-SCO, PH-SLE, PH-SUK, PH-SLU, PH-SUN, PH-SUR, PH-TAR, PH-TAW, PH-ZMB, PH-ZAN, PH-ZAS, PH-ZSI, PT-20, PT-01, PT-02, PT-03, PT-04, PT-05, PT-06, PT-07, PT-08, PT-09, PT-10, PT-11, PT-30, PT-12, PT-13, PT-14, PT-15, PT-16, PT-17, PT-18, AB, AR, AG, BC, BH, BN, BT, BR, BV, B, BZ, CL, CS, CJ, CT, CV, DB, DJ, GL, GR, GJ, HR, HD, IL, IS, IF, MM, MH, MS, NT, OT, PH, SJ, SM, SB, SV, TR, TM, TL, VL, VS, VN, KR-26, KR-43, KR-44, KR-27, KR-30, KR-42, KR-29, KR-47, KR-41, KR-48, KR-28, KR-49, KR-45, KR-46, KR-50, KR-11, KR-31, C, VI, AB, A, AL, O, AV, BA, PM, B, BU, CC, CA, S, CS, CE, CR, CO, CU, GI, GR, GU, SS, H, HU, J, LO, GC, LE, L, LU, M, MA, ML, MU, NA, OR, P, PO, SA, TF, SG, SE, SO, T, TE, TO, V, VA, BI, ZA, Z, AZ, AJ, DU, FU, RK, SH, UQ, BFP, ENG, NIR, SCT, WLS, AR, CA, CL, CO, DU, FS, FD, LA, MA, MO, PA, RN, RV, RO, SA, SJ, SO, TA, TT |
street1 | string | Required within parent | Street address line 1 |
street2 | string | Optional | Street address line 2 |
zip | string | Required within parent | Zip code |
Create Update Store Settings — request body — body store Order Fulfillment Notification default Email Template Id, email Template Id, enabled, subject
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
defaultEmailTemplateId | string | Required within parent | Default Email Template Id |
emailTemplateId | string | Required within parent | Email Template Id |
enabled | boolean | Required within parent | Store order fulfillment notification enabled |
subject | string | Required within parent | Store order fulfillment email subject |
Create Update Store Settings — request body — body store Order Notification default Email Template Id, email Template Id, enabled, subject
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
defaultEmailTemplateId | string | Required within parent | Default Email Template Id |
emailTemplateId | string | Required within parent | Email Template Id |
enabled | boolean | Required within parent | Store order notification enabled |
subject | string | Required within parent | Store order email subject |
Get Shipping Carrier — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | JSON | Required within parent | Shipping carrier data |
data (allOf 1) | Model | All variants apply | Expand List Shipping Carriers — response body — data item |
message | string | Optional | Success message |
status | boolean | Required within parent | Status of api action |
Referenced models: List Shipping Carriers — response body — data item
Get Shipping Rate — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | JSON | Required within parent | Shipping zone data |
data (allOf 1) | Model | All variants apply | Expand List Shipping Rates — response body — data item |
message | string | Optional | Success message |
status | boolean | Required within parent | Status of api action |
Referenced models: List Shipping Rates — response body — data item
Get Shipping Zone — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | JSON | Required within parent | Shipping zone data |
data (allOf 1) | Model | All variants apply | Expand List Shipping Zones — response body — data item |
message | string | Optional | Success message |
status | boolean | Required within parent | Status of api action |
Referenced models: List Shipping Zones — response body — data item
Get Store Settings — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | JSON | Required within parent | Shipping carrier data |
data (allOf 1) | Model | All variants apply | Expand Get Store Settings — response body — data / altType: location |
message | string | Optional | Success message |
status | boolean | Required within parent | Status of api action |
Referenced models: Get Store Settings — response body — data / altType: location
Get Store Settings — response body — data / altType: location
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
_id | string | Required within parent | The unique identifier for the settings. |
altId | string | Required within parent | Location Id or Agency Id |
altType | string | Required within parent | Known values: location |
createdAt | string | Required within parent | created at |
shippingOrigin | JSON | Required within parent | Shipping origin address |
shippingOrigin (allOf 1) | Model | All variants apply | Expand Get Store Settings — response body — data / altType: location shipping Origin city, country, email, name, phone, state, street1, street2, zip |
storeOrderFulfillmentNotification | JSON | Optional | Store order fulfillment notification email |
storeOrderFulfillmentNotification (allOf 1) | Model | All variants apply | Expand Create Update Store Settings — request body — body store Order Fulfillment Notification default Email Template Id, email Template Id, enabled, subject |
storeOrderNotification | JSON | Optional | Store order notification email |
storeOrderNotification (allOf 1) | Model | All variants apply | Expand Create Update Store Settings — request body — body store Order Notification default Email Template Id, email Template Id, enabled, subject |
updatedAt | string | Required within parent | updated at |
Referenced models: Create Update Store Settings — request body — body store Order Fulfillment Notification default Email Template Id, email Template Id, enabled, subject, Create Update Store Settings — request body — body store Order Notification default Email Template Id, email Template Id, enabled, subject, Get Store Settings — response body — data / altType: location shipping Origin city, country, email, name, phone, state, street1, street2, zip
Get Store Settings — response body — data / altType: location shipping Origin city, country, email, name, phone, state, street1, street2, zip
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
city | string | Required within parent | City name |
country | string | Required within parent | Country code Known values: US, CA, 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, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, 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, 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, XK, 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, AN, 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, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, KR, 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, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW |
email | string | Optional | |
name | string | Required within parent | Name of the store / company |
phone | string | Optional | Business Phone Number |
state | string | Optional | State code Known values: AL, AK, AS, AZ, AR, AA, AE, AP, CA, CO, CT, DE, DC, FM, FL, GA, GU, HI, ID, IL, IN, IA, KS, KY, LA, ME, MH, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, MP, OH, OK, OR, PW, PA, PR, RI, SC, SD, TN, TX, UT, VT, VI, VA, WA, WV, WI, WY, AB, BC, MB, NB, NL, NT, NS, NU, ON, PE, QC, SK, YT, BA, CT, CC, CH, CB, CN, ER, FO, JY, LP, LR, MZ, MN, NQ, RN, SA, SJ, SL, SC, SF, SE, TF, TU, ACT, NSW, NT, QLD, SA, TAS, VIC, WA, AC, AL, AM, AP, BA, CE, DF, ES, GO, MA, MG, MS, MT, PA, PB, PE, PI, PR, RJ, RN, RO, RR, RS, SC, SE, SP, TO, AI, AN, AP, AT, BI, CO, AR, LI, LL, LR, MA, ML, RM, TA, VS, NB, AMA, ANT, ARA, ATL, BOL, BOY, CAL, CAQ, CAS, CAU, CES, CHO, CUN, COR, GUA, GUV, HUI, LAG, MAG, MET, NAR, NSA, PUT, QUI, RIS, SAP, SAN, SUC, TOL, VAC, VAU, VID, CR-A, CR-C, CR-G, CR-H, CR-L, CR-P, CR-SJ, GT-16, GT-15, GT-04, GT-20, GT-02, GT-05, GT-01, GT-13, GT-18, GT-21, GT-22, GT-17, GT-09, GT-14, GT-11, GT-03, GT-12, GT-06, GT-07, GT-10, GT-08, GT-19, HK, KL, NT, AN, AP, AR, AS, BR, CH, CG, DN, DD, DL, GA, GJ, HR, HP, JK, JH, KA, KL, LA, LD, MP, MH, MN, ML, MZ, NL, OR, PY, PB, RJ, SK, TN, TS, TR, UP, UK, WB, CW, CN, CE, CO, DL, D, G, KY, KE, KK, LS, LM, LK, LD, LH, MO, MH, MN, OY, RN, SO, TA, WD, WH, WX, WW, AG, AL, AN, AO, AR, AP, AT, AV, BA, BT, BL, BN, BG, BI, BO, BZ, BS, BR, CA, CL, CB, CI, CE, CT, CZ, CH, CO, CS, CR, KR, CN, EN, FM, FE, FI, FG, FC, FR, GE, GO, GR, IM, IS, AQ, SP, LT, LE, LC, LI, LO, LU, MC, MN, MS, MT, VS, ME, MI, MO, MB, NA, NO, NU, OG, OT, OR, PD, PA, PR, PV, PG, PU, PE, PC, PI, PT, PN, PZ, PO, RG, RA, RC, RE, RI, RN, RM, RO, SA, SS, SV, SI, SR, SO, TA, TE, TR, TO, TP, TN, TV, TS, UD, VA, VE, VB, VC, VR, VV, VI, VT, JP-23, JP-05, JP-02, JP-12, JP-38, JP-18, JP-40, JP-07, JP-21, JP-10, JP-34, JP-01, JP-28, JP-08, JP-17, JP-03, JP-37, JP-46, JP-14, JP-39, JP-43, JP-26, JP-24, JP-04, JP-45, JP-20, JP-42, JP-29, JP-15, JP-44, JP-33, JP-47, JP-27, JP-41, JP-11, JP-25, JP-32, JP-22, JP-09, JP-36, JP-13, JP-31, JP-16, JP-30, JP-06, JP-35, JP-19, JHR, KDH, KTN, KUL, LBN, MLK, NSN, PHG, PNG, PRK, PLS, PJY, SBH, SWK, SGR, TRG, AGU, BCN, BCS, CAM, CHP, CHH, CMX, COA, COL, DUR, GUA, GRO, HID, JAL, MIC, MOR, MEX, NAY, NLE, OAX, PUE, QUE, ROO, SLP, SIN, SON, TAB, TAM, TLA, VER, YUC, ZAC, AUK, BOP, CAN, CIT, GIS, HKB, MWT, MBH, NSN, NTL, OTA, STL, TKI, TAS, WKO, WGN, WTC, JK, BA, GB, IS, KP, PB, SD, AMA, ANC, APU, ARE, AYA, CAJ, CAL, CUS, HUV, HUC, ICA, JUN, LAL, LAM, LIM, LOR, MDD, MOQ, PAS, PIU, PUN, SAM, TAC, TUM, UCA, PH-ABR, PH-AGN, PH-AGS, PH-AKL, PH-ALB, PH-ANT, PH-APA, PH-AUR, PH-BAS, PH-BAN, PH-BTN, PH-BTG, PH-BEN, PH-BIL, PH-BOH, PH-BUK, PH-BUL, PH-CAG, PH-CAN, PH-CAS, PH-CAM, PH-CAP, PH-CAT, PH-CAV, PH-CEB, PH-NCO, PH-DAO, PH-DAV, PH-DAS, PH-EAS, PH-GUI, PH-IFU, PH-ILN, PH-ILS, PH-ILI, PH-ISA, PH-KAL, PH-LUN, PH-LAG, PH-LAN, PH-LAS, PH-LEY, PH-MAG, PH-MAD, PH-MAS, PH-00, PH-MSC, PH-MSR, PH-MOU, PH-NEC, PH-NER, PH-NSA, PH-NUE, PH-NUV, PH-MDC, PH-MDR, PH-PLW, PH-PAM, PH-PAN, PH-QUE, PH-QUI, PH-RIZ, PH-ROM, PH-WSA, PH-SAR, PH-SIG, PH-SOR, PH-SCO, PH-SLE, PH-SUK, PH-SLU, PH-SUN, PH-SUR, PH-TAR, PH-TAW, PH-ZMB, PH-ZAN, PH-ZAS, PH-ZSI, PT-20, PT-01, PT-02, PT-03, PT-04, PT-05, PT-06, PT-07, PT-08, PT-09, PT-10, PT-11, PT-30, PT-12, PT-13, PT-14, PT-15, PT-16, PT-17, PT-18, AB, AR, AG, BC, BH, BN, BT, BR, BV, B, BZ, CL, CS, CJ, CT, CV, DB, DJ, GL, GR, GJ, HR, HD, IL, IS, IF, MM, MH, MS, NT, OT, PH, SJ, SM, SB, SV, TR, TM, TL, VL, VS, VN, KR-26, KR-43, KR-44, KR-27, KR-30, KR-42, KR-29, KR-47, KR-41, KR-48, KR-28, KR-49, KR-45, KR-46, KR-50, KR-11, KR-31, C, VI, AB, A, AL, O, AV, BA, PM, B, BU, CC, CA, S, CS, CE, CR, CO, CU, GI, GR, GU, SS, H, HU, J, LO, GC, LE, L, LU, M, MA, ML, MU, NA, OR, P, PO, SA, TF, SG, SE, SO, T, TE, TO, V, VA, BI, ZA, Z, AZ, AJ, DU, FU, RK, SH, UQ, BFP, ENG, NIR, SCT, WLS, AR, CA, CL, CO, DU, FS, FD, LA, MA, MO, PA, RN, RV, RO, SA, SJ, SO, TA, TT |
street1 | string | Required within parent | Street address line 1 |
street2 | string | Optional | Street address line 2 |
zip | string | Required within parent | Zip code |
Get available shipping rates — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | JSON | Optional | Address of the customer |
address (allOf 1) | Model | All variants apply | Expand Get available shipping rates — request body — body address address Line1, city, company Name, country, email, name, phone, state, zip |
altId | string | Required within parent | Location Id or Agency Id |
altType | string | Required within parent | One of: location |
amountAvailable | string | Optional | it will not calculate the order amount form backend if it is true One of: 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, 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, 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, XK, 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, AN, 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, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, GB, UA, AE, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW |
country | string | Required within parent | Country code of the customer One of: US, CA, 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, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, 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, 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, XK, 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, AN, 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, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, KR, 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, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW |
couponCode | string | Optional | Coupon code |
products | array | Required within parent | An array of price IDs and quantity |
products[] | Model | Each item | Expand Get available shipping rates — request body — body products item |
source | JSON | Required within parent | Source of the order |
source (allOf 1) | Model | All variants apply | Expand Get available shipping rates — request body — body source sub Type, type |
totalOrderAmount | number | Required within parent | The amount of the price. ( min: 0.01 ) |
totalOrderWeight | number | Required within parent | Estimated weight of the order calculated from the order creation side in kg(s) |
weightAvailable | boolean | Optional | Flag to pass when the weight is already calculated and should not calculate again |
Referenced models: Get available shipping rates — request body — body address address Line1, city, company Name, country, email, name, phone, state, zip, Get available shipping rates — request body — body products item, Get available shipping rates — request body — body source sub Type, type
Get available shipping rates — request body — body address address Line1, city, company Name, country, email, name, phone, state, zip
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
addressLine1 | string | Optional | Address line 1 of the customer |
city | string | Optional | City of the customer |
companyName | string | Optional | Name of the Company |
country | string | Required within parent | Country code of the customer One of: US, CA, 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, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, 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, 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, XK, 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, AN, 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, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, KR, 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, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW |
email | string | Optional | Email of the customer |
name | string | Optional | Name of the customer |
phone | string | Optional | Phone number of the customer |
state | string | Optional | State code of the customer One of: AL, AK, AS, AZ, AR, AA, AE, AP, CA, CO, CT, DE, DC, FM, FL, GA, GU, HI, ID, IL, IN, IA, KS, KY, LA, ME, MH, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, MP, OH, OK, OR, PW, PA, PR, RI, SC, SD, TN, TX, UT, VT, VI, VA, WA, WV, WI, WY, AB, BC, MB, NB, NL, NT, NS, NU, ON, PE, QC, SK, YT, BA, CT, CC, CH, CB, CN, ER, FO, JY, LP, LR, MZ, MN, NQ, RN, SA, SJ, SL, SC, SF, SE, TF, TU, ACT, NSW, NT, QLD, SA, TAS, VIC, WA, AC, AL, AM, AP, BA, CE, DF, ES, GO, MA, MG, MS, MT, PA, PB, PE, PI, PR, RJ, RN, RO, RR, RS, SC, SE, SP, TO, AI, AN, AP, AT, BI, CO, AR, LI, LL, LR, MA, ML, RM, TA, VS, NB, AMA, ANT, ARA, ATL, BOL, BOY, CAL, CAQ, CAS, CAU, CES, CHO, CUN, COR, GUA, GUV, HUI, LAG, MAG, MET, NAR, NSA, PUT, QUI, RIS, SAP, SAN, SUC, TOL, VAC, VAU, VID, CR-A, CR-C, CR-G, CR-H, CR-L, CR-P, CR-SJ, GT-16, GT-15, GT-04, GT-20, GT-02, GT-05, GT-01, GT-13, GT-18, GT-21, GT-22, GT-17, GT-09, GT-14, GT-11, GT-03, GT-12, GT-06, GT-07, GT-10, GT-08, GT-19, HK, KL, NT, AN, AP, AR, AS, BR, CH, CG, DN, DD, DL, GA, GJ, HR, HP, JK, JH, KA, KL, LA, LD, MP, MH, MN, ML, MZ, NL, OR, PY, PB, RJ, SK, TN, TS, TR, UP, UK, WB, CW, CN, CE, CO, DL, D, G, KY, KE, KK, LS, LM, LK, LD, LH, MO, MH, MN, OY, RN, SO, TA, WD, WH, WX, WW, AG, AL, AN, AO, AR, AP, AT, AV, BA, BT, BL, BN, BG, BI, BO, BZ, BS, BR, CA, CL, CB, CI, CE, CT, CZ, CH, CO, CS, CR, KR, CN, EN, FM, FE, FI, FG, FC, FR, GE, GO, GR, IM, IS, AQ, SP, LT, LE, LC, LI, LO, LU, MC, MN, MS, MT, VS, ME, MI, MO, MB, NA, NO, NU, OG, OT, OR, PD, PA, PR, PV, PG, PU, PE, PC, PI, PT, PN, PZ, PO, RG, RA, RC, RE, RI, RN, RM, RO, SA, SS, SV, SI, SR, SO, TA, TE, TR, TO, TP, TN, TV, TS, UD, VA, VE, VB, VC, VR, VV, VI, VT, JP-23, JP-05, JP-02, JP-12, JP-38, JP-18, JP-40, JP-07, JP-21, JP-10, JP-34, JP-01, JP-28, JP-08, JP-17, JP-03, JP-37, JP-46, JP-14, JP-39, JP-43, JP-26, JP-24, JP-04, JP-45, JP-20, JP-42, JP-29, JP-15, JP-44, JP-33, JP-47, JP-27, JP-41, JP-11, JP-25, JP-32, JP-22, JP-09, JP-36, JP-13, JP-31, JP-16, JP-30, JP-06, JP-35, JP-19, JHR, KDH, KTN, KUL, LBN, MLK, NSN, PHG, PNG, PRK, PLS, PJY, SBH, SWK, SGR, TRG, AGU, BCN, BCS, CAM, CHP, CHH, CMX, COA, COL, DUR, GUA, GRO, HID, JAL, MIC, MOR, MEX, NAY, NLE, OAX, PUE, QUE, ROO, SLP, SIN, SON, TAB, TAM, TLA, VER, YUC, ZAC, AUK, BOP, CAN, CIT, GIS, HKB, MWT, MBH, NSN, NTL, OTA, STL, TKI, TAS, WKO, WGN, WTC, JK, BA, GB, IS, KP, PB, SD, AMA, ANC, APU, ARE, AYA, CAJ, CAL, CUS, HUV, HUC, ICA, JUN, LAL, LAM, LIM, LOR, MDD, MOQ, PAS, PIU, PUN, SAM, TAC, TUM, UCA, PH-ABR, PH-AGN, PH-AGS, PH-AKL, PH-ALB, PH-ANT, PH-APA, PH-AUR, PH-BAS, PH-BAN, PH-BTN, PH-BTG, PH-BEN, PH-BIL, PH-BOH, PH-BUK, PH-BUL, PH-CAG, PH-CAN, PH-CAS, PH-CAM, PH-CAP, PH-CAT, PH-CAV, PH-CEB, PH-NCO, PH-DAO, PH-DAV, PH-DAS, PH-EAS, PH-GUI, PH-IFU, PH-ILN, PH-ILS, PH-ILI, PH-ISA, PH-KAL, PH-LUN, PH-LAG, PH-LAN, PH-LAS, PH-LEY, PH-MAG, PH-MAD, PH-MAS, PH-00, PH-MSC, PH-MSR, PH-MOU, PH-NEC, PH-NER, PH-NSA, PH-NUE, PH-NUV, PH-MDC, PH-MDR, PH-PLW, PH-PAM, PH-PAN, PH-QUE, PH-QUI, PH-RIZ, PH-ROM, PH-WSA, PH-SAR, PH-SIG, PH-SOR, PH-SCO, PH-SLE, PH-SUK, PH-SLU, PH-SUN, PH-SUR, PH-TAR, PH-TAW, PH-ZMB, PH-ZAN, PH-ZAS, PH-ZSI, PT-20, PT-01, PT-02, PT-03, PT-04, PT-05, PT-06, PT-07, PT-08, PT-09, PT-10, PT-11, PT-30, PT-12, PT-13, PT-14, PT-15, PT-16, PT-17, PT-18, AB, AR, AG, BC, BH, BN, BT, BR, BV, B, BZ, CL, CS, CJ, CT, CV, DB, DJ, GL, GR, GJ, HR, HD, IL, IS, IF, MM, MH, MS, NT, OT, PH, SJ, SM, SB, SV, TR, TM, TL, VL, VS, VN, KR-26, KR-43, KR-44, KR-27, KR-30, KR-42, KR-29, KR-47, KR-41, KR-48, KR-28, KR-49, KR-45, KR-46, KR-50, KR-11, KR-31, C, VI, AB, A, AL, O, AV, BA, PM, B, BU, CC, CA, S, CS, CE, CR, CO, CU, GI, GR, GU, SS, H, HU, J, LO, GC, LE, L, LU, M, MA, ML, MU, NA, OR, P, PO, SA, TF, SG, SE, SO, T, TE, TO, V, VA, BI, ZA, Z, AZ, AJ, DU, FU, RK, SH, UQ, BFP, ENG, NIR, SCT, WLS, AR, CA, CL, CO, DU, FS, FD, LA, MA, MO, PA, RN, RV, RO, SA, SJ, SO, TA, TT |
zip | string | Optional | Zip code of the customer |
Get available shipping rates — request body — body products item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | id of product |
qty | number | Required within parent | No of quantities |
Get available shipping rates — request body — body source sub Type, type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
subType | string | Optional | Source subtype of order One of: one_step_order_form, two_step_order_form, upsell, tap_to_pay, card_payment, store, contact_view, email_campaign, payments_dashboard, shopify, subscription_view, store_upsell, woocommerce, service, meeting, imported_csv, qr_code |
type | string | Required within parent | Source of order One of: funnel, website, invoice, calendar, text2Pay, document_contracts, membership, mobile_app, communities, point_of_sale, manual, form, survey, payment_link, external |
Get available shipping rates — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Shipping rate data |
data[] | Model | Each item | Expand Get available shipping rates — response body — data item |
message | string | Optional | Success message |
status | boolean | Required within parent | Status of api action |
Referenced models: Get available shipping rates — response body — data item
Get available shipping rates — response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
_id | string | Required within parent | The unique identifier for the product. |
amount | JSON | Required within parent | |
amount (anyOf 1) | number | Alternative | The amount of the shipping rate if it is normal rate (0 means free ). Fixed Handling fee if it is a carrier rate (it will add to the carrier rate). |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | string | Required within parent | The currency of the amount of the rate / handling fee |
description | string | Optional | Delivery description |
isCarrierRate | boolean | Optional | is this a carrier rate |
name | string | Required within parent | Name of the shipping zone |
percentageOfRateFee | JSON | Optional | |
percentageOfRateFee (anyOf 1) | number | Alternative | Percentage of rate fee if it is a carrier rate. |
percentageOfRateFee (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
shippingCarrierId | string | Required within parent | Shipping carrier id |
shippingCarrierServices | array | Optional | An array of items |
shippingCarrierServices[] | Model | Each item | Expand Create Shipping Carrier — request body — body services item |
shippingZoneId | string | Required within parent | The unique identifier for the shipping zone. |
Referenced models: Create Shipping Carrier — request body — body services item
List Shipping Carriers — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | An array of items |
data[] | Model | Each item | Expand List Shipping Carriers — response body — data item |
message | string | Optional | Success message |
status | boolean | Required within parent | Status of api action |
Referenced models: List Shipping Carriers — response body — data item
List Shipping Carriers — response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
_id | string | Required within parent | The unique identifier for the product. |
allowsMultipleServiceSelection | boolean | Optional | The seller can choose multiple services while creating shipping rates if this is true. |
altId | string | Required within parent | Location Id or Agency Id |
altType | string | Required within parent | Known values: location |
callbackUrl | string | Required within parent | The URL endpoint that CRM needs to retrieve shipping rates. This must be a public URL. |
createdAt | string | Required within parent | created at |
marketplaceAppId | string | Required within parent | The unique identifier for the marketplace app. |
name | string | Required within parent | Name of the shipping carrier |
services | array | Optional | An array of available shipping carrier services |
services[] | Model | Each item | Expand Create Shipping Carrier — request body — body services item |
updatedAt | string | Required within parent | updated at |
Referenced models: Create Shipping Carrier — request body — body services item
List Shipping Rates — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | An array of items |
data[] | Model | Each item | Expand List Shipping Rates — response body — data item |
total | JSON | Required within parent | |
total (anyOf 1) | number | Alternative | Total number of items |
total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: List Shipping Rates — response body — data item
List Shipping Rates — response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
_id | string | Required within parent | The unique identifier for the product. |
altId | string | Required within parent | Location Id or Agency Id |
altType | string | Required within parent | Known values: location |
amount | JSON | Required within parent | |
amount (anyOf 1) | number | Alternative | The amount of the shipping rate if it is normal rate (0 means free ). Fixed Handling fee if it is a carrier rate (it will add to the carrier rate). |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
conditionType | string | Required within parent | Type of condition to provide the conditional pricing Known values: none, price, weight |
createdAt | string | Required within parent | created at |
currency | string | Required within parent | The currency of the amount of the rate / handling fee |
description | string | Optional | Delivery description |
isCarrierRate | boolean | Optional | is this a carrier rate |
maxCondition | JSON | Required within parent | |
maxCondition (anyOf 1) | number | Alternative | Maximum condition for applying this price. set 0 or null if there is no maximum |
maxCondition (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
minCondition | JSON | Required within parent | |
minCondition (anyOf 1) | number | Alternative | Minimum condition for applying this price. set 0 or null if there is no minimum |
minCondition (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
name | string | Required within parent | Name of the shipping zone |
percentageOfRateFee | JSON | Optional | |
percentageOfRateFee (anyOf 1) | number | Alternative | Percentage of rate fee if it is a carrier rate. |
percentageOfRateFee (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
shippingCarrierId | string | Required within parent | Shipping carrier id |
shippingCarrierServices | array | Optional | An array of items |
shippingCarrierServices[] | Model | Each item | Expand Create Shipping Carrier — request body — body services item |
shippingZoneId | string | Required within parent | The unique identifier for the shipping zone. |
updatedAt | string | Required within parent | updated at |
Referenced models: Create Shipping Carrier — request body — body services item
List Shipping Zones — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | An array of items |
data[] | Model | Each item | Expand List Shipping Zones — response body — data item |
total | JSON | Required within parent | |
total (anyOf 1) | number | Alternative | Total number of items |
total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: List Shipping Zones — response body — data item
List Shipping Zones — response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
_id | string | Required within parent | The unique identifier for the product. |
altId | string | Required within parent | Location Id or Agency Id |
altType | string | Required within parent | Known values: location |
countries | array | Required within parent | List of countries that are available |
countries[] | Model | Each item | Expand List Shipping Zones — response body — data item countries item |
createdAt | string | Required within parent | created at |
name | string | Required within parent | Name of the shipping zone |
shippingRates | array | Optional | Array of shipping rates under this shipping zone |
shippingRates[] | Model | Each item | Expand List Shipping Rates — response body — data item |
updatedAt | string | Required within parent | updated at |
Referenced models: List Shipping Rates — response body — data item, List Shipping Zones — response body — data item countries item
List Shipping Zones — response body — data item countries item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
code | string | Required within parent | Country code Known values: US, CA, 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, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, 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, 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, XK, 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, AN, 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, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, KR, 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, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW |
states | array | Optional | List of states that are available. If states is empty, then all states are available |
states[] | Model | Each item | Expand List Shipping Zones — response body — data item countries item states item |
Referenced models: List Shipping Zones — response body — data item countries item states item
List Shipping Zones — response body — data item countries item states item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
code | string | Required within parent | State code Known values: AL, AK, AS, AZ, AR, AA, AE, AP, CA, CO, CT, DE, DC, FM, FL, GA, GU, HI, ID, IL, IN, IA, KS, KY, LA, ME, MH, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, MP, OH, OK, OR, PW, PA, PR, RI, SC, SD, TN, TX, UT, VT, VI, VA, WA, WV, WI, WY, AB, BC, MB, NB, NL, NT, NS, NU, ON, PE, QC, SK, YT, BA, CT, CC, CH, CB, CN, ER, FO, JY, LP, LR, MZ, MN, NQ, RN, SA, SJ, SL, SC, SF, SE, TF, TU, ACT, NSW, NT, QLD, SA, TAS, VIC, WA, AC, AL, AM, AP, BA, CE, DF, ES, GO, MA, MG, MS, MT, PA, PB, PE, PI, PR, RJ, RN, RO, RR, RS, SC, SE, SP, TO, AI, AN, AP, AT, BI, CO, AR, LI, LL, LR, MA, ML, RM, TA, VS, NB, AMA, ANT, ARA, ATL, BOL, BOY, CAL, CAQ, CAS, CAU, CES, CHO, CUN, COR, GUA, GUV, HUI, LAG, MAG, MET, NAR, NSA, PUT, QUI, RIS, SAP, SAN, SUC, TOL, VAC, VAU, VID, CR-A, CR-C, CR-G, CR-H, CR-L, CR-P, CR-SJ, GT-16, GT-15, GT-04, GT-20, GT-02, GT-05, GT-01, GT-13, GT-18, GT-21, GT-22, GT-17, GT-09, GT-14, GT-11, GT-03, GT-12, GT-06, GT-07, GT-10, GT-08, GT-19, HK, KL, NT, AN, AP, AR, AS, BR, CH, CG, DN, DD, DL, GA, GJ, HR, HP, JK, JH, KA, KL, LA, LD, MP, MH, MN, ML, MZ, NL, OR, PY, PB, RJ, SK, TN, TS, TR, UP, UK, WB, CW, CN, CE, CO, DL, D, G, KY, KE, KK, LS, LM, LK, LD, LH, MO, MH, MN, OY, RN, SO, TA, WD, WH, WX, WW, AG, AL, AN, AO, AR, AP, AT, AV, BA, BT, BL, BN, BG, BI, BO, BZ, BS, BR, CA, CL, CB, CI, CE, CT, CZ, CH, CO, CS, CR, KR, CN, EN, FM, FE, FI, FG, FC, FR, GE, GO, GR, IM, IS, AQ, SP, LT, LE, LC, LI, LO, LU, MC, MN, MS, MT, VS, ME, MI, MO, MB, NA, NO, NU, OG, OT, OR, PD, PA, PR, PV, PG, PU, PE, PC, PI, PT, PN, PZ, PO, RG, RA, RC, RE, RI, RN, RM, RO, SA, SS, SV, SI, SR, SO, TA, TE, TR, TO, TP, TN, TV, TS, UD, VA, VE, VB, VC, VR, VV, VI, VT, JP-23, JP-05, JP-02, JP-12, JP-38, JP-18, JP-40, JP-07, JP-21, JP-10, JP-34, JP-01, JP-28, JP-08, JP-17, JP-03, JP-37, JP-46, JP-14, JP-39, JP-43, JP-26, JP-24, JP-04, JP-45, JP-20, JP-42, JP-29, JP-15, JP-44, JP-33, JP-47, JP-27, JP-41, JP-11, JP-25, JP-32, JP-22, JP-09, JP-36, JP-13, JP-31, JP-16, JP-30, JP-06, JP-35, JP-19, JHR, KDH, KTN, KUL, LBN, MLK, NSN, PHG, PNG, PRK, PLS, PJY, SBH, SWK, SGR, TRG, AGU, BCN, BCS, CAM, CHP, CHH, CMX, COA, COL, DUR, GUA, GRO, HID, JAL, MIC, MOR, MEX, NAY, NLE, OAX, PUE, QUE, ROO, SLP, SIN, SON, TAB, TAM, TLA, VER, YUC, ZAC, AUK, BOP, CAN, CIT, GIS, HKB, MWT, MBH, NSN, NTL, OTA, STL, TKI, TAS, WKO, WGN, WTC, JK, BA, GB, IS, KP, PB, SD, AMA, ANC, APU, ARE, AYA, CAJ, CAL, CUS, HUV, HUC, ICA, JUN, LAL, LAM, LIM, LOR, MDD, MOQ, PAS, PIU, PUN, SAM, TAC, TUM, UCA, PH-ABR, PH-AGN, PH-AGS, PH-AKL, PH-ALB, PH-ANT, PH-APA, PH-AUR, PH-BAS, PH-BAN, PH-BTN, PH-BTG, PH-BEN, PH-BIL, PH-BOH, PH-BUK, PH-BUL, PH-CAG, PH-CAN, PH-CAS, PH-CAM, PH-CAP, PH-CAT, PH-CAV, PH-CEB, PH-NCO, PH-DAO, PH-DAV, PH-DAS, PH-EAS, PH-GUI, PH-IFU, PH-ILN, PH-ILS, PH-ILI, PH-ISA, PH-KAL, PH-LUN, PH-LAG, PH-LAN, PH-LAS, PH-LEY, PH-MAG, PH-MAD, PH-MAS, PH-00, PH-MSC, PH-MSR, PH-MOU, PH-NEC, PH-NER, PH-NSA, PH-NUE, PH-NUV, PH-MDC, PH-MDR, PH-PLW, PH-PAM, PH-PAN, PH-QUE, PH-QUI, PH-RIZ, PH-ROM, PH-WSA, PH-SAR, PH-SIG, PH-SOR, PH-SCO, PH-SLE, PH-SUK, PH-SLU, PH-SUN, PH-SUR, PH-TAR, PH-TAW, PH-ZMB, PH-ZAN, PH-ZAS, PH-ZSI, PT-20, PT-01, PT-02, PT-03, PT-04, PT-05, PT-06, PT-07, PT-08, PT-09, PT-10, PT-11, PT-30, PT-12, PT-13, PT-14, PT-15, PT-16, PT-17, PT-18, AB, AR, AG, BC, BH, BN, BT, BR, BV, B, BZ, CL, CS, CJ, CT, CV, DB, DJ, GL, GR, GJ, HR, HD, IL, IS, IF, MM, MH, MS, NT, OT, PH, SJ, SM, SB, SV, TR, TM, TL, VL, VS, VN, KR-26, KR-43, KR-44, KR-27, KR-30, KR-42, KR-29, KR-47, KR-41, KR-48, KR-28, KR-49, KR-45, KR-46, KR-50, KR-11, KR-31, C, VI, AB, A, AL, O, AV, BA, PM, B, BU, CC, CA, S, CS, CE, CR, CO, CU, GI, GR, GU, SS, H, HU, J, LO, GC, LE, L, LU, M, MA, ML, MU, NA, OR, P, PO, SA, TF, SG, SE, SO, T, TE, TO, V, VA, BI, ZA, Z, AZ, AJ, DU, FU, RK, SH, UQ, BFP, ENG, NIR, SCT, WLS, AR, CA, CL, CO, DU, FS, FD, LA, MA, MO, PA, RN, RV, RO, SA, SJ, SO, TA, TT |
Update Shipping Carrier — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allowsMultipleServiceSelection | boolean | Optional | The seller can choose multiple services while creating shipping rates if this is true. |
altId | string | Optional | Location Id or Agency Id |
altType | string | Optional | One of: location |
callbackUrl | string | Optional | The URL endpoint that CRM needs to retrieve shipping rates. This must be a public URL. |
name | string | Optional | Name of the shipping carrier |
services | array | Optional | An array of available shipping carrier services |
services[] | Model | Each item | Expand Create Shipping Carrier — request body — body services item |
Referenced models: Create Shipping Carrier — request body — body services item
Update Shipping Rate — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
altId | string | Optional | Location Id or Agency Id |
altType | string | Optional | One of: location |
amount | number | Optional | The amount of the shipping rate if it is normal rate (0 means free ). Fixed Handling fee if it is a carrier rate (it will add to the carrier rate). |
conditionType | string | Optional | Type of condition to provide the conditional pricing One of: none, price, weight |
currency | string | Optional | The currency of the amount of the rate / handling fee |
description | string | Optional | Delivery description |
isCarrierRate | boolean | Optional | is this a carrier rate |
maxCondition | number | Optional | Maximum condition for applying this price. set 0 or null if there is no maximum |
minCondition | number | Optional | Minimum condition for applying this price. set 0 or null if there is no minimum |
name | string | Optional | Name of the shipping zone |
percentageOfRateFee | number | Optional | Percentage of rate fee if it is a carrier rate. |
shippingCarrierId | string | Optional | Shipping carrier id |
shippingCarrierServices | array | Optional | An array of items |
shippingCarrierServices[] | Model | Each item | Expand Create Shipping Carrier — request body — body services item |
Referenced models: Create Shipping Carrier — request body — body services item
Update Shipping Zone — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
altId | string | Optional | Location Id or Agency Id |
altType | string | Optional | One of: location |
countries | array | Optional | List of countries that are available |
countries[] | Model | Each item | Expand Create Shipping Zone — request body — body countries item |
name | string | Optional | Name of the shipping zone |
Referenced models: Create Shipping Zone — request body — body countries item