Sign in
latestOpenAPI 3.0.02026-08-10134271194.2 KB

da24e062ff11

Purchase State Line Item

Remove Line Item from Purchase State

for the deletion of line items by vendor (only allow if the cps has more than one line item)

put/vendor/customer/{customerRelationshipId}/purchase-state/{customerPurchaseStateId}/line-item/{lineItemId}/remove

Path parameters

customerRelationshipIdstring required
customerPurchaseStateIdstring required
lineItemIdstring required

Request body

{"stackTrail":"paths:/vendor/customer/{customerRelationshipId}/purchase-state/{customerPurchaseStateId}/line-item/{lineItemId}/remove:put:requestBody:content:application/json:schema","oasType":"schema","type":"unknown"}

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'