SMsmartrr
Purchase State

Update Address on Purchase State

Changed on
put/vendor/customer/{customerRelationshipId}/purchase-state/{customerPurchaseStateId}/address

Request

  • Base URL
    https://smartrr-dev.local.com
  • URL
    https://smartrr-dev.local.com/vendor/customer/{customerRelationshipId}/purchase-state/{customerPurchaseStateId}/address
  • Auth
    API key in header x-smartrr-access-token

Path parameters

customerRelationshipIdstring required
customerPurchaseStateIdstring required

Request body

latitudenumber nullable
longitudenumber nullable
citystring
provincestring
provinceCodestring

The code for the region of the address, such as the province, state, or district. For example QC for Quebec, Canada.

zipstring
countrystring
countryCode'AF' | 'AX' | 'AL' | 'DZ' | 'AD' | 'AO' | 'AI' | 'AG' | 'AR' | 'AM' | 'AW' | 'AC' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CA' | 'CV' | 'BQ' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'CI' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'SZ' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | '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' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'AN' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MK' | 'NO' | 'OM' | 'PK' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'QA' | 'CM' | 'RE' | 'RO' | 'RU' | 'RW' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'KR' | 'SS' | 'ES' | 'LK' | 'VC' | 'SD' | 'SR' | 'SJ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TA' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'ZZ'

ISO 3166-1 alpha-2 country codes with some differences

address1string
address2string
shopifyIdstring
emailstring
phonestring

Formatted using E.164 standard. For example, +16135551111.

firstNamestring
lastNamestring
companystring

Response

Successful response

idstring required
createdDatestring required

A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ

updatedDatestring required

A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ

deletedAtstring

A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ

totalFromLineItemsstring required
totalLineItemsDiscountstring required
totalLineItemsAfterDiscountstring required
totalShippingstring required
totalDiscountstring required
shopifyIdstring
receivedFromShopifyDatestring

A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ

shopifyUpdateDatestring required

A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ

purchaseStateStatus'ACTIVE' | 'PAUSED' | 'CANCELLED' | 'EXPIRED' | 'FAILED' required
createdViaCustomerPortalboolean required
initialSubmissionDatestring required

A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ

externalSubscriptionCreatedDatestring required

A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ

cancelledAtstring required

A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ

pausedAtstring required

A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ

externalSubscriptionCancelledAtstring required

A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ

nextBillingDatestring required

A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ

isRepeatCustomerboolean required
sellingPlanIdstring
currency'STN' | 'VED' | 'USD' | 'USDC' | 'EUR' | 'GBP' | 'CAD' | 'AFN' | 'ALL' | 'DZD' | 'AOA' | 'ARS' | 'AMD' | 'AWG' | 'AUD' | 'BBD' | 'AZN' | 'BDT' | 'BSD' | 'BHD' | 'BIF' | 'BZD' | 'BMD' | 'BTN' | 'BAM' | 'BRL' | 'BOB' | 'BWP' | 'BND' | 'BGN' | 'MMK' | 'KHR' | 'CVE' | 'KYD' | 'XAF' | 'CLP' | 'CNY' | 'COP' | 'KMF' | 'CDF' | 'CRC' | 'HRK' | 'CZK' | 'DKK' | 'DOP' | 'XCD' | 'EGP' | 'ETB' | 'XPF' | 'FJD' | 'GMD' | 'GHS' | 'GTQ' | 'GYD' | 'GEL' | 'HTG' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'ILS' | 'IQD' | 'JMD' | 'JPY' | 'JEP' | 'JOD' | 'KZT' | 'KES' | 'KWD' | 'KGS' | 'LAK' | 'LVL' | 'LBP' | 'LSL' | 'LRD' | 'LTL' | 'MGA' | 'MKD' | 'MOP' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MUR' | 'MDL' | 'MAD' | 'MNT' | 'MZN' | 'NAD' | 'NPR' | 'ANG' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'OMR' | 'PAB' | 'PKR' | 'PGK' | 'PYG' | 'PEN' | 'PHP' | 'PLN' | 'QAR' | 'RON' | 'RUB' | 'RWF' | 'WST' | 'SAR' | 'STD' | 'RSD' | 'SCR' | 'SGD' | 'SDG' | 'SYP' | 'ZAR' | 'KRW' | 'SSP' | 'SBD' | 'LKR' | 'SRD' | 'SZL' | 'SEK' | 'CHF' | 'TWD' | 'THB' | 'TZS' | 'TTD' | 'TND' | 'TRY' | 'TMT' | 'UGX' | 'UAH' | 'AED' | 'UYU' | 'UZS' | 'VUV' | 'VND' | 'XOF' | 'YER' | 'ZMW' | 'BYN' | 'BYR' | 'DJF' | 'ERN' | 'FKP' | 'GIP' | 'GNF' | 'IRR' | 'KID' | 'LYD' | 'MRU' | 'SLL' | 'SHP' | 'SOS' | 'TJS' | 'TOP' | 'VEF' | 'VES' | 'XXX' required
totalEstimatedTaxstring
totalShippingDiscountstring
totalEstimatedNetstring required
externalSubscriptionIdstring
externalSubscriptionType'RECHARGE'
externalSubscriptionStatus'ACTIVE' | 'PAUSED' | 'CANCELLED' | 'EXPIRED' | 'FAILED'
originalExternalSubscriptionStatus'ACTIVE' | 'PAUSED' | 'CANCELLED' | 'EXPIRED' | 'FAILED'

Changes

  • bc858719395dRevision changes
    • info

      added the optional property /////////////////// to the response with the status

    • info

      added the optional property ///////// to the response with the status