ultracart_api 3.10.152 → 4.0.32.rc

Sign up to get free protection for your applications and to get access to all the features.
Files changed (1609) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +9 -7
  3. data/README.md +1166 -1489
  4. data/Rakefile +10 -8
  5. data/docs/AccountsReceivableRetryConfig.md +46 -23
  6. data/docs/AccountsReceivableRetryConfigResponse.md +32 -15
  7. data/docs/AccountsReceivableRetryDayActivity.md +22 -10
  8. data/docs/AccountsReceivableRetryStatAccount.md +24 -11
  9. data/docs/AccountsReceivableRetryStatMetrics.md +38 -18
  10. data/docs/AccountsReceivableRetryStatRevenue.md +20 -9
  11. data/docs/AccountsReceivableRetryStatsResponse.md +28 -13
  12. data/docs/Activity.md +28 -15
  13. data/docs/AddLibraryItemRequest.md +38 -18
  14. data/docs/AdjustInternalCertificateRequest.md +28 -13
  15. data/docs/AdjustInternalCertificateResponse.md +28 -13
  16. data/docs/AffiliateApi.md +173 -126
  17. data/docs/AffiliateClick.md +38 -20
  18. data/docs/AffiliateClickQuery.md +28 -13
  19. data/docs/AffiliateClicksResponse.md +26 -12
  20. data/docs/AffiliateLedger.md +54 -26
  21. data/docs/AffiliateLedgerQuery.md +28 -13
  22. data/docs/AffiliateLedgersResponse.md +26 -12
  23. data/docs/AffiliateLink.md +44 -21
  24. data/docs/ApiUserApplicationProfile.md +26 -12
  25. data/docs/ApplyLibraryItemRequest.md +24 -11
  26. data/docs/ApplyLibraryItemResponse.md +38 -18
  27. data/docs/AutoOrder.md +60 -31
  28. data/docs/AutoOrderApi.md +693 -557
  29. data/docs/AutoOrderItem.md +64 -33
  30. data/docs/AutoOrderItemFutureSchedule.md +24 -11
  31. data/docs/AutoOrderItemOption.md +20 -9
  32. data/docs/AutoOrderItemSimpleSchedule.md +22 -10
  33. data/docs/AutoOrderLog.md +20 -9
  34. data/docs/AutoOrderQuery.md +58 -28
  35. data/docs/AutoOrderQueryBatch.md +18 -8
  36. data/docs/AutoOrderResponse.md +26 -12
  37. data/docs/AutoOrdersRequest.md +18 -8
  38. data/docs/AutoOrdersResponse.md +26 -12
  39. data/docs/AvalaraConfig.md +42 -20
  40. data/docs/BaseResponse.md +24 -11
  41. data/docs/Browser.md +22 -10
  42. data/docs/BrowserDevice.md +18 -8
  43. data/docs/BrowserOS.md +26 -12
  44. data/docs/BrowserUserAgent.md +24 -11
  45. data/docs/Cart.md +68 -33
  46. data/docs/CartAffiliate.md +20 -9
  47. data/docs/CartAffirmCheckoutResponse.md +20 -9
  48. data/docs/CartBilling.md +46 -24
  49. data/docs/CartBuysafe.md +28 -13
  50. data/docs/CartCheckout.md +44 -24
  51. data/docs/CartCoupon.md +18 -8
  52. data/docs/CartCurrencyConversion.md +20 -9
  53. data/docs/CartCustomerProfile.md +60 -30
  54. data/docs/CartCustomerProfileAddress.md +44 -21
  55. data/docs/CartCustomerProfileCreditCard.md +28 -13
  56. data/docs/CartFinalizeOrderRequest.md +20 -9
  57. data/docs/CartFinalizeOrderRequestOptions.md +42 -20
  58. data/docs/CartFinalizeOrderResponse.md +26 -12
  59. data/docs/CartGift.md +28 -13
  60. data/docs/CartGiftCertificate.md +22 -10
  61. data/docs/CartItem.md +74 -37
  62. data/docs/CartItemAttribute.md +22 -10
  63. data/docs/CartItemMultimedia.md +34 -16
  64. data/docs/CartItemMultimediaThumbnail.md +26 -12
  65. data/docs/CartItemOption.md +40 -19
  66. data/docs/CartItemOptionValue.md +26 -12
  67. data/docs/CartItemPhysical.md +24 -11
  68. data/docs/CartItemVariationSelection.md +20 -9
  69. data/docs/CartKitComponentOption.md +44 -21
  70. data/docs/CartMarketing.md +20 -10
  71. data/docs/CartPayment.md +30 -14
  72. data/docs/CartPaymentAffirm.md +18 -8
  73. data/docs/CartPaymentAmazon.md +18 -8
  74. data/docs/CartPaymentCheck.md +18 -8
  75. data/docs/CartPaymentCreditCard.md +34 -16
  76. data/docs/CartPaymentPurchaseOrder.md +18 -8
  77. data/docs/CartProfileLoginRequest.md +22 -10
  78. data/docs/CartProfileLoginResponse.md +20 -9
  79. data/docs/CartProfileRegisterRequest.md +20 -9
  80. data/docs/CartProfileRegisterResponse.md +20 -9
  81. data/docs/CartProperty.md +24 -11
  82. data/docs/CartResponse.md +20 -9
  83. data/docs/CartSettings.md +28 -13
  84. data/docs/CartSettingsBilling.md +18 -8
  85. data/docs/CartSettingsGift.md +24 -11
  86. data/docs/CartSettingsGiftWrap.md +22 -10
  87. data/docs/CartSettingsPayment.md +42 -20
  88. data/docs/CartSettingsPaymentAmazon.md +22 -10
  89. data/docs/CartSettingsPaymentCreditCard.md +22 -10
  90. data/docs/CartSettingsPaymentPayPal.md +26 -12
  91. data/docs/CartSettingsProvince.md +20 -9
  92. data/docs/CartSettingsShipping.md +26 -12
  93. data/docs/CartSettingsShippingCalendar.md +26 -12
  94. data/docs/CartSettingsShippingEstimate.md +44 -21
  95. data/docs/CartSettingsTaxes.md +18 -8
  96. data/docs/CartSettingsTerms.md +20 -9
  97. data/docs/CartShipping.md +54 -26
  98. data/docs/CartSummary.md +48 -23
  99. data/docs/CartTaxes.md +22 -10
  100. data/docs/CartUpsellAfter.md +22 -10
  101. data/docs/CartValidationRequest.md +20 -9
  102. data/docs/CartValidationResponse.md +20 -9
  103. data/docs/ChannelPartnerApi.md +382 -578
  104. data/docs/ChannelPartnerCancelResponse.md +26 -12
  105. data/docs/ChannelPartnerEstimateShippingResponse.md +26 -12
  106. data/docs/ChannelPartnerEstimateTaxResponse.md +26 -12
  107. data/docs/ChannelPartnerImportResponse.md +30 -14
  108. data/docs/ChannelPartnerOrder.md +176 -87
  109. data/docs/ChannelPartnerOrderItem.md +30 -14
  110. data/docs/ChannelPartnerOrderItemOption.md +20 -9
  111. data/docs/ChannelPartnerOrderTransaction.md +20 -9
  112. data/docs/ChannelPartnerOrderTransactionDetail.md +20 -9
  113. data/docs/ChannelPartnerShippingEstimate.md +20 -9
  114. data/docs/ChargebackApi.md +420 -301
  115. data/docs/ChargebackDispute.md +62 -30
  116. data/docs/ChargebackDisputeResponse.md +26 -12
  117. data/docs/ChargebackDisputesResponse.md +26 -12
  118. data/docs/CheckoutAllowedCountriesResponse.md +18 -8
  119. data/docs/CheckoutApi.md +1566 -1023
  120. data/docs/CheckoutHandoffRequest.md +32 -15
  121. data/docs/CheckoutHandoffResponse.md +22 -10
  122. data/docs/CheckoutSetupBrowserKeyRequest.md +18 -8
  123. data/docs/CheckoutSetupBrowserKeyResponse.md +18 -8
  124. data/docs/CheckoutStateProvinceResponse.md +18 -8
  125. data/docs/CityStateZip.md +26 -12
  126. data/docs/CountriesResponse.md +18 -8
  127. data/docs/Country.md +20 -9
  128. data/docs/Coupon.md +136 -73
  129. data/docs/CouponAmountOffItems.md +24 -11
  130. data/docs/CouponAmountOffShipping.md +22 -10
  131. data/docs/CouponAmountOffShippingWithItemsPurchase.md +24 -11
  132. data/docs/CouponAmountOffSubtotal.md +20 -9
  133. data/docs/CouponAmountOffSubtotalAndShipping.md +20 -9
  134. data/docs/CouponAmountOffSubtotalFreeShippingWithPurchase.md +24 -11
  135. data/docs/CouponAmountOffSubtotalWithBlockPurchase.md +24 -11
  136. data/docs/CouponAmountOffSubtotalWithItemsPurchase.md +24 -11
  137. data/docs/CouponAmountOffSubtotalWithPurchase.md +22 -10
  138. data/docs/CouponAmountShippingWithSubtotal.md +24 -11
  139. data/docs/CouponApi.md +1500 -1043
  140. data/docs/CouponAutoApplyCondition.md +22 -10
  141. data/docs/CouponAutoApplyConditions.md +28 -13
  142. data/docs/CouponAutomaticallyApplyCouponCodes.md +18 -8
  143. data/docs/CouponBuyOneGetOneLimit.md +20 -9
  144. data/docs/CouponCodesRequest.md +30 -14
  145. data/docs/CouponCodesResponse.md +28 -13
  146. data/docs/CouponDeletesRequest.md +20 -9
  147. data/docs/CouponDiscountItemWithItemPurchase.md +26 -12
  148. data/docs/CouponDiscountItems.md +24 -11
  149. data/docs/CouponEditorValues.md +36 -17
  150. data/docs/CouponExistsResponse.md +28 -13
  151. data/docs/CouponFreeItemAndShippingWithSubtotal.md +26 -12
  152. data/docs/CouponFreeItemWithItemPurchase.md +24 -11
  153. data/docs/CouponFreeItemWithSubtotal.md +24 -11
  154. data/docs/CouponFreeItemsWithItemPurchase.md +26 -12
  155. data/docs/CouponFreeItemsWithMixMatchPurchase.md +26 -12
  156. data/docs/CouponFreeShipping.md +18 -8
  157. data/docs/CouponFreeShippingSpecificItems.md +18 -8
  158. data/docs/CouponFreeShippingWithItemsPurchase.md +20 -9
  159. data/docs/CouponFreeShippingWithSubtotal.md +22 -10
  160. data/docs/CouponItemSearchResult.md +32 -15
  161. data/docs/CouponItemSearchResultsResponse.md +26 -12
  162. data/docs/CouponMultipleAmountsOffItems.md +20 -9
  163. data/docs/CouponPercentOffItemWithItemsQuantityPurchase.md +26 -12
  164. data/docs/CouponPercentOffItems.md +24 -11
  165. data/docs/CouponPercentOffItemsAndFreeShipping.md +22 -10
  166. data/docs/CouponPercentOffItemsWithItemsPurchase.md +24 -11
  167. data/docs/CouponPercentOffMsrpItems.md +24 -13
  168. data/docs/CouponPercentOffRetailPriceItems.md +24 -11
  169. data/docs/CouponPercentOffShipping.md +20 -9
  170. data/docs/CouponPercentOffSubtotal.md +18 -8
  171. data/docs/CouponPercentOffSubtotalAndFreeShipping.md +20 -9
  172. data/docs/CouponPercentOffSubtotalLimit.md +22 -10
  173. data/docs/CouponPercentOffSubtotalWithItemsPurchase.md +20 -9
  174. data/docs/CouponPercentOffSubtotalWithSubtotal.md +22 -10
  175. data/docs/CouponQuery.md +36 -17
  176. data/docs/CouponResponse.md +28 -13
  177. data/docs/CouponRestriction.md +24 -11
  178. data/docs/CouponTierAmount.md +22 -10
  179. data/docs/CouponTierItemDiscount.md +20 -9
  180. data/docs/CouponTierPercent.md +22 -10
  181. data/docs/CouponTierQuantityAmount.md +22 -10
  182. data/docs/CouponTierQuantityPercent.md +22 -10
  183. data/docs/CouponTieredAmountOffItems.md +22 -10
  184. data/docs/CouponTieredAmountOffSubtotal.md +20 -9
  185. data/docs/CouponTieredPercentOffItems.md +22 -10
  186. data/docs/CouponTieredPercentOffShipping.md +22 -10
  187. data/docs/CouponTieredPercentOffSubtotal.md +20 -9
  188. data/docs/CouponType.md +20 -9
  189. data/docs/CouponsRequest.md +18 -8
  190. data/docs/CouponsResponse.md +26 -12
  191. data/docs/Currency.md +26 -12
  192. data/docs/Customer.md +134 -69
  193. data/docs/CustomerActivity.md +24 -15
  194. data/docs/CustomerAffiliate.md +24 -11
  195. data/docs/CustomerApi.md +1380 -1077
  196. data/docs/CustomerAttachment.md +26 -12
  197. data/docs/CustomerBilling.md +50 -24
  198. data/docs/CustomerCard.md +32 -15
  199. data/docs/CustomerEditorValues.md +36 -19
  200. data/docs/CustomerEmail.md +28 -13
  201. data/docs/CustomerEmailListChanges.md +20 -9
  202. data/docs/CustomerLoyalty.md +30 -14
  203. data/docs/CustomerLoyaltyLedger.md +46 -22
  204. data/docs/CustomerLoyaltyRedemption.md +42 -20
  205. data/docs/CustomerOrdersSummary.md +24 -11
  206. data/docs/CustomerPricingTier.md +20 -9
  207. data/docs/CustomerPrivacy.md +24 -11
  208. data/docs/CustomerQuery.md +74 -36
  209. data/docs/CustomerQuotesSummary.md +24 -11
  210. data/docs/CustomerResponse.md +26 -12
  211. data/docs/CustomerReviewer.md +36 -17
  212. data/docs/CustomerShipping.md +50 -24
  213. data/docs/CustomerSoftwareEntitlement.md +32 -15
  214. data/docs/CustomerStoreCredit.md +28 -13
  215. data/docs/CustomerStoreCreditAddRequest.md +24 -11
  216. data/docs/CustomerStoreCreditLedgerEntry.md +30 -14
  217. data/docs/CustomerStoreCreditResponse.md +26 -12
  218. data/docs/CustomerTag.md +18 -8
  219. data/docs/CustomerTaxCodes.md +26 -12
  220. data/docs/CustomersResponse.md +26 -12
  221. data/docs/DataTablesServerSideResponse.md +24 -11
  222. data/docs/Distance.md +20 -9
  223. data/docs/DistributionCenter.md +86 -57
  224. data/docs/DistributionCentersResponse.md +26 -12
  225. data/docs/EmailBaseTemplateListResponse.md +18 -8
  226. data/docs/EmailCampaign.md +64 -33
  227. data/docs/EmailCampaignFolder.md +26 -12
  228. data/docs/EmailCampaignFolderResponse.md +26 -12
  229. data/docs/EmailCampaignFoldersResponse.md +26 -12
  230. data/docs/EmailCampaignResponse.md +26 -12
  231. data/docs/EmailCampaignsResponse.md +26 -12
  232. data/docs/EmailClick.md +20 -9
  233. data/docs/EmailClicksResponse.md +26 -12
  234. data/docs/EmailCommseq.md +24 -11
  235. data/docs/EmailCommseqEmail.md +68 -33
  236. data/docs/EmailCommseqEmailResponse.md +26 -12
  237. data/docs/EmailCommseqEmailSendTestRequest.md +36 -17
  238. data/docs/EmailCommseqEmailSendTestResponse.md +24 -11
  239. data/docs/EmailCommseqEmailsRequest.md +26 -12
  240. data/docs/EmailCommseqEmailsResponse.md +26 -12
  241. data/docs/EmailCommseqPostcard.md +42 -20
  242. data/docs/EmailCommseqPostcardResponse.md +26 -12
  243. data/docs/EmailCommseqPostcardSendTestRequest.md +42 -20
  244. data/docs/EmailCommseqPostcardSendTestResponse.md +30 -14
  245. data/docs/EmailCommseqPostcardsRequest.md +18 -8
  246. data/docs/EmailCommseqPostcardsResponse.md +26 -12
  247. data/docs/EmailCommseqResponse.md +26 -12
  248. data/docs/EmailCommseqStat.md +90 -44
  249. data/docs/EmailCommseqStatResponse.md +26 -12
  250. data/docs/EmailCommseqStep.md +36 -17
  251. data/docs/EmailCommseqStepLog.md +22 -10
  252. data/docs/EmailCommseqStepLogsResponse.md +26 -12
  253. data/docs/EmailCommseqWebhookSendTestRequest.md +30 -14
  254. data/docs/EmailCommseqWebhookSendTestResponse.md +30 -14
  255. data/docs/EmailCommseqsResponse.md +26 -12
  256. data/docs/EmailCustomer.md +32 -15
  257. data/docs/EmailCustomerEditorUrlResponse.md +26 -12
  258. data/docs/EmailCustomersResponse.md +26 -12
  259. data/docs/EmailDashboardActivity.md +30 -14
  260. data/docs/EmailDashboardActivityResponse.md +26 -12
  261. data/docs/EmailDashboardStatsResponse.md +26 -12
  262. data/docs/EmailDomain.md +42 -20
  263. data/docs/EmailEditorTokenResponse.md +26 -12
  264. data/docs/EmailFlow.md +72 -38
  265. data/docs/EmailFlowBackPopulateRequest.md +20 -9
  266. data/docs/EmailFlowBackPopulateResponse.md +24 -11
  267. data/docs/EmailFlowFolder.md +26 -12
  268. data/docs/EmailFlowFolderResponse.md +26 -12
  269. data/docs/EmailFlowFoldersResponse.md +26 -12
  270. data/docs/EmailFlowResponse.md +26 -12
  271. data/docs/EmailFlowsResponse.md +26 -12
  272. data/docs/EmailGlobalSettings.md +18 -8
  273. data/docs/EmailGlobalSettingsResponse.md +26 -12
  274. data/docs/EmailGlobalUnsubscribeRequest.md +18 -8
  275. data/docs/EmailGlobalUnsubscribeResponse.md +18 -8
  276. data/docs/EmailHistogramPropertyNamesResponse.md +18 -8
  277. data/docs/EmailHistogramPropertyValuesResponse.md +18 -8
  278. data/docs/EmailList.md +40 -19
  279. data/docs/EmailListArchiveResponse.md +26 -12
  280. data/docs/EmailListCustomer.md +24 -11
  281. data/docs/EmailListCustomersResponse.md +26 -12
  282. data/docs/EmailListResponse.md +26 -12
  283. data/docs/EmailListSegmentFolder.md +26 -12
  284. data/docs/EmailListSegmentFolderResponse.md +26 -12
  285. data/docs/EmailListSegmentFoldersResponse.md +26 -12
  286. data/docs/EmailListSegmentMembership.md +24 -11
  287. data/docs/EmailListSegmentUsedBy.md +22 -10
  288. data/docs/EmailListSubscribeResponse.md +20 -9
  289. data/docs/EmailListsResponse.md +26 -12
  290. data/docs/EmailOrder.md +24 -11
  291. data/docs/EmailOrdersResponse.md +26 -12
  292. data/docs/EmailPerformance.md +62 -30
  293. data/docs/EmailPerformanceCustomerHistogram.md +18 -8
  294. data/docs/EmailPerformanceCustomerHistogramPeriod.md +26 -12
  295. data/docs/EmailPerformanceDaily.md +30 -14
  296. data/docs/EmailPerformanceResponse.md +26 -12
  297. data/docs/EmailPlan.md +50 -24
  298. data/docs/EmailPlanAdditional.md +34 -16
  299. data/docs/EmailPlanResponse.md +26 -12
  300. data/docs/EmailPostcardStat.md +80 -39
  301. data/docs/EmailSegment.md +58 -29
  302. data/docs/EmailSegmentArchiveResponse.md +26 -12
  303. data/docs/EmailSegmentCustomer.md +24 -11
  304. data/docs/EmailSegmentCustomersResponse.md +26 -12
  305. data/docs/EmailSegmentDownloadPrepareResponse.md +32 -15
  306. data/docs/EmailSegmentResponse.md +26 -12
  307. data/docs/EmailSegmentsResponse.md +26 -12
  308. data/docs/EmailSendingDomainResponse.md +26 -12
  309. data/docs/EmailSendingDomainsResponse.md +26 -12
  310. data/docs/EmailSettings.md +40 -22
  311. data/docs/EmailSettingsResponse.md +26 -12
  312. data/docs/EmailStat.md +92 -45
  313. data/docs/EmailStatPostcardSummaryRequest.md +20 -9
  314. data/docs/EmailStatPostcardSummaryResponse.md +26 -12
  315. data/docs/EmailStatSummaryRequest.md +22 -10
  316. data/docs/EmailStatSummaryResponse.md +26 -12
  317. data/docs/EmailStepStat.md +56 -37
  318. data/docs/EmailStepStatRequest.md +20 -9
  319. data/docs/EmailStepStatResponse.md +26 -12
  320. data/docs/EmailStepWaitingRequest.md +18 -8
  321. data/docs/EmailStepWaitingResponse.md +18 -8
  322. data/docs/EmailTemplate.md +38 -18
  323. data/docs/EmailTemplatesResponse.md +26 -12
  324. data/docs/EmailThirdPartyList.md +20 -9
  325. data/docs/EmailThirdPartyListImportRequest.md +18 -8
  326. data/docs/EmailThirdPartyProvider.md +38 -18
  327. data/docs/EmailThirdPartyProvidersResponse.md +26 -12
  328. data/docs/EmailThirdPartyTag.md +20 -9
  329. data/docs/EmailVerifyTokenRequest.md +20 -9
  330. data/docs/EmailVerifyTokenResponse.md +26 -12
  331. data/docs/EmailVerifyTokenValidateRequest.md +18 -8
  332. data/docs/EmailVerifyTokenValidateResponse.md +24 -11
  333. data/docs/EmailWebhookEditorValuesResponse.md +30 -14
  334. data/docs/Error.md +26 -12
  335. data/docs/ErrorResponse.md +24 -11
  336. data/docs/Experiment.md +52 -31
  337. data/docs/ExperimentResponse.md +26 -12
  338. data/docs/ExperimentVariation.md +60 -30
  339. data/docs/ExperimentVariationStat.md +38 -19
  340. data/docs/ExperimentsResponse.md +26 -12
  341. data/docs/FulfillmentApi.md +459 -318
  342. data/docs/FulfillmentInventory.md +20 -9
  343. data/docs/FulfillmentShipment.md +26 -12
  344. data/docs/GeoPoint.md +20 -9
  345. data/docs/GeocodeRequest.md +26 -12
  346. data/docs/GeocodeResponse.md +28 -13
  347. data/docs/GiftCertificate.md +44 -21
  348. data/docs/GiftCertificateApi.md +622 -433
  349. data/docs/GiftCertificateCreateRequest.md +26 -12
  350. data/docs/GiftCertificateLedgerEntry.md +28 -13
  351. data/docs/GiftCertificateQuery.md +34 -16
  352. data/docs/GiftCertificateResponse.md +26 -12
  353. data/docs/GiftCertificatesResponse.md +26 -12
  354. data/docs/Group.md +26 -12
  355. data/docs/GroupResponse.md +26 -12
  356. data/docs/GroupUserMembership.md +26 -12
  357. data/docs/GroupsResponse.md +26 -12
  358. data/docs/HTTPHeader.md +20 -9
  359. data/docs/IntegrationLog.md +52 -26
  360. data/docs/IntegrationLogApi.md +400 -286
  361. data/docs/IntegrationLogFile.md +24 -11
  362. data/docs/IntegrationLogLog.md +20 -9
  363. data/docs/IntegrationLogQueryFilterValues.md +40 -19
  364. data/docs/IntegrationLogQueryRequest.md +42 -23
  365. data/docs/IntegrationLogQueryResponse.md +28 -13
  366. data/docs/IntegrationLogResponse.md +26 -12
  367. data/docs/IntegrationLogSummary.md +34 -16
  368. data/docs/IntegrationLogSummaryQueryRequest.md +20 -9
  369. data/docs/IntegrationLogSummaryQueryResponse.md +26 -12
  370. data/docs/Item.md +118 -58
  371. data/docs/ItemAccounting.md +20 -9
  372. data/docs/ItemAmember.md +20 -9
  373. data/docs/ItemApi.md +733 -1167
  374. data/docs/ItemAutoOrder.md +50 -29
  375. data/docs/ItemAutoOrderStep.md +46 -22
  376. data/docs/ItemAutoOrderStepArbitraryUnitCostSchedule.md +20 -9
  377. data/docs/ItemAutoOrderStepGrandfatherPricing.md +20 -9
  378. data/docs/ItemCCBill.md +28 -13
  379. data/docs/ItemChannelPartnerMapping.md +54 -26
  380. data/docs/ItemChargeback.md +20 -9
  381. data/docs/ItemChargebackAddendum.md +24 -11
  382. data/docs/ItemChargebackAdjustmentRequest.md +22 -10
  383. data/docs/ItemCheckout.md +24 -11
  384. data/docs/ItemContent.md +42 -20
  385. data/docs/ItemContentAssignment.md +28 -13
  386. data/docs/ItemContentAttribute.md +24 -11
  387. data/docs/ItemContentMultimedia.md +46 -22
  388. data/docs/ItemContentMultimediaThumbnail.md +28 -13
  389. data/docs/ItemDigitalDelivery.md +28 -13
  390. data/docs/ItemDigitalItem.md +26 -17
  391. data/docs/ItemEbay.md +154 -76
  392. data/docs/ItemEbayCategorySpecific.md +20 -9
  393. data/docs/ItemEbayMarketListing.md +26 -12
  394. data/docs/ItemEbayMarketPlaceAnalysis.md +36 -17
  395. data/docs/ItemEmailNotifications.md +20 -9
  396. data/docs/ItemEnrollment123.md +18 -8
  397. data/docs/ItemFulfillmentAddon.md +24 -12
  398. data/docs/ItemGiftCertificate.md +20 -9
  399. data/docs/ItemGoogleProductSearch.md +112 -55
  400. data/docs/ItemIdentifiers.md +24 -11
  401. data/docs/ItemInstantPaymentNotification.md +22 -10
  402. data/docs/ItemInstantPaymentNotifications.md +18 -8
  403. data/docs/ItemInternal.md +18 -8
  404. data/docs/ItemKitComponent.md +26 -12
  405. data/docs/ItemKitDefinition.md +18 -8
  406. data/docs/ItemOption.md +44 -21
  407. data/docs/ItemOptionValue.md +46 -22
  408. data/docs/ItemOptionValueAdditionalItem.md +20 -9
  409. data/docs/ItemOptionValueDigitalItem.md +20 -9
  410. data/docs/ItemPaymentProcessing.md +26 -12
  411. data/docs/ItemPhysical.md +24 -11
  412. data/docs/ItemPricing.md +52 -25
  413. data/docs/ItemPricingTier.md +26 -12
  414. data/docs/ItemPricingTierDiscount.md +20 -9
  415. data/docs/ItemPricingTierLimit.md +22 -12
  416. data/docs/ItemProperty.md +22 -10
  417. data/docs/ItemRealtimePricing.md +22 -10
  418. data/docs/ItemRelated.md +22 -10
  419. data/docs/ItemRelatedItem.md +22 -10
  420. data/docs/ItemReporting.md +20 -9
  421. data/docs/ItemResponse.md +26 -12
  422. data/docs/ItemRestriction.md +32 -15
  423. data/docs/ItemRestrictionItem.md +22 -10
  424. data/docs/ItemRevguard.md +30 -14
  425. data/docs/ItemReviews.md +34 -17
  426. data/docs/ItemSalesforce.md +20 -9
  427. data/docs/ItemShipping.md +112 -55
  428. data/docs/ItemShippingCase.md +24 -11
  429. data/docs/ItemShippingDestinationMarkup.md +28 -13
  430. data/docs/ItemShippingDestinationRestriction.md +22 -10
  431. data/docs/ItemShippingDistributionCenter.md +44 -21
  432. data/docs/ItemShippingMethod.md +46 -22
  433. data/docs/ItemShippingPackageRequirement.md +20 -9
  434. data/docs/ItemTag.md +20 -9
  435. data/docs/ItemTags.md +18 -8
  436. data/docs/ItemTax.md +24 -11
  437. data/docs/ItemTaxExemption.md +26 -12
  438. data/docs/ItemThirdPartyEmailMarketing.md +26 -12
  439. data/docs/ItemVariantItem.md +28 -13
  440. data/docs/ItemVariation.md +26 -12
  441. data/docs/ItemVariationOption.md +24 -11
  442. data/docs/ItemWishlistMember.md +22 -10
  443. data/docs/ItemsRequest.md +18 -8
  444. data/docs/ItemsResponse.md +26 -12
  445. data/docs/KeyValue.md +22 -10
  446. data/docs/LibraryFilterValues.md +24 -11
  447. data/docs/LibraryFilterValuesResponse.md +26 -12
  448. data/docs/LibraryItem.md +96 -47
  449. data/docs/LibraryItemAccount.md +22 -10
  450. data/docs/LibraryItemAsset.md +20 -9
  451. data/docs/LibraryItemAttribute.md +20 -9
  452. data/docs/LibraryItemEmail.md +22 -10
  453. data/docs/LibraryItemPublishedMeta.md +32 -15
  454. data/docs/LibraryItemPurchasedMeta.md +22 -10
  455. data/docs/LibraryItemQuery.md +40 -19
  456. data/docs/LibraryItemResponse.md +26 -12
  457. data/docs/LibraryItemScreenshot.md +20 -9
  458. data/docs/LibraryItemsResponse.md +26 -12
  459. data/docs/LinkedAccount.md +22 -10
  460. data/docs/ListSegmentMembership.md +22 -10
  461. data/docs/LookupRequest.md +26 -13
  462. data/docs/LookupResponse.md +26 -12
  463. data/docs/Mailgun.md +18 -8
  464. data/docs/Metric.md +32 -15
  465. data/docs/Notification.md +38 -18
  466. data/docs/OauthApi.md +179 -124
  467. data/docs/OauthRevokeSuccessResponse.md +20 -9
  468. data/docs/OauthTokenResponse.md +32 -15
  469. data/docs/Order.md +84 -45
  470. data/docs/OrderAffiliate.md +22 -10
  471. data/docs/OrderAffiliateLedger.md +34 -16
  472. data/docs/OrderApi.md +1856 -1469
  473. data/docs/OrderAutoOrder.md +56 -27
  474. data/docs/OrderBilling.md +48 -25
  475. data/docs/OrderBuysafe.md +28 -13
  476. data/docs/OrderByTokenQuery.md +18 -8
  477. data/docs/OrderChannelPartner.md +38 -18
  478. data/docs/OrderCheckout.md +44 -24
  479. data/docs/OrderCoupon.md +26 -12
  480. data/docs/OrderDigitalItem.md +32 -15
  481. data/docs/OrderDigitalOrder.md +26 -12
  482. data/docs/OrderEdi.md +24 -11
  483. data/docs/OrderFormat.md +48 -23
  484. data/docs/OrderFormatResponse.md +20 -9
  485. data/docs/OrderFraudScore.md +56 -27
  486. data/docs/OrderGift.md +36 -17
  487. data/docs/OrderGiftCertificate.md +22 -10
  488. data/docs/OrderInternal.md +26 -13
  489. data/docs/OrderItem.md +128 -68
  490. data/docs/OrderItemEdi.md +20 -9
  491. data/docs/OrderItemEdiIdentification.md +20 -9
  492. data/docs/OrderItemEdiLot.md +22 -10
  493. data/docs/OrderItemOption.md +38 -18
  494. data/docs/OrderItemOptionFileAttachment.md +24 -11
  495. data/docs/OrderItemProperty.md +24 -11
  496. data/docs/OrderItemTag.md +18 -8
  497. data/docs/OrderLinkedShipment.md +26 -12
  498. data/docs/OrderMarketing.md +22 -11
  499. data/docs/OrderPackingSlipResponse.md +26 -12
  500. data/docs/OrderPayment.md +52 -25
  501. data/docs/OrderPaymentCheck.md +18 -8
  502. data/docs/OrderPaymentCreditCard.md +38 -19
  503. data/docs/OrderPaymentECheck.md +36 -17
  504. data/docs/OrderPaymentInsurance.md +24 -11
  505. data/docs/OrderPaymentPurchaseOrder.md +18 -8
  506. data/docs/OrderPaymentTransaction.md +24 -12
  507. data/docs/OrderPaymentTransactionDetail.md +22 -10
  508. data/docs/OrderProcessPaymentRequest.md +20 -9
  509. data/docs/OrderProcessPaymentResponse.md +26 -12
  510. data/docs/OrderProperty.md +24 -11
  511. data/docs/OrderQuery.md +94 -46
  512. data/docs/OrderQueryBatch.md +18 -8
  513. data/docs/OrderQuote.md +22 -10
  514. data/docs/OrderReplacement.md +46 -22
  515. data/docs/OrderReplacementItem.md +22 -10
  516. data/docs/OrderReplacementResponse.md +28 -13
  517. data/docs/OrderResponse.md +26 -12
  518. data/docs/OrderSalesforce.md +18 -8
  519. data/docs/OrderShipping.md +76 -38
  520. data/docs/OrderSummary.md +56 -27
  521. data/docs/OrderTag.md +18 -8
  522. data/docs/OrderTaxes.md +50 -24
  523. data/docs/OrderTokenResponse.md +26 -12
  524. data/docs/OrderTrackingNumberDetail.md +40 -19
  525. data/docs/OrderTrackingNumberDetails.md +52 -25
  526. data/docs/OrdersResponse.md +26 -12
  527. data/docs/Permission.md +22 -10
  528. data/docs/PricingTier.md +78 -40
  529. data/docs/PricingTierNotification.md +22 -10
  530. data/docs/PricingTiersResponse.md +26 -12
  531. data/docs/Property.md +20 -9
  532. data/docs/PublishLibraryItemRequest.md +18 -8
  533. data/docs/RegisterAffiliateClickRequest.md +28 -13
  534. data/docs/RegisterAffiliateClickResponse.md +24 -11
  535. data/docs/ResponseMetadata.md +20 -9
  536. data/docs/ResultSet.md +28 -13
  537. data/docs/ScreenRecording.md +116 -57
  538. data/docs/ScreenRecordingAdPlatform.md +30 -14
  539. data/docs/ScreenRecordingFilter.md +136 -67
  540. data/docs/ScreenRecordingFilterGeoDistance.md +26 -12
  541. data/docs/ScreenRecordingFilterIpSearch.md +24 -11
  542. data/docs/ScreenRecordingFilterPageView.md +50 -24
  543. data/docs/ScreenRecordingFilterPageViewEvent.md +20 -9
  544. data/docs/ScreenRecordingFilterPageViewEventParam.md +26 -12
  545. data/docs/ScreenRecordingFilterPageViewParam.md +20 -9
  546. data/docs/ScreenRecordingFilterPageViewReferrerParam.md +20 -9
  547. data/docs/ScreenRecordingFilterRangeBigDecimal.md +26 -12
  548. data/docs/ScreenRecordingFilterRangeDate.md +20 -9
  549. data/docs/ScreenRecordingFilterRangeInteger.md +26 -12
  550. data/docs/ScreenRecordingFilterStringSearch.md +26 -12
  551. data/docs/ScreenRecordingFilterValues.md +58 -28
  552. data/docs/ScreenRecordingFilterValuesEvent.md +20 -9
  553. data/docs/ScreenRecordingFilterValuesEventParams.md +26 -12
  554. data/docs/ScreenRecordingFilterValuesPageParam.md +20 -9
  555. data/docs/ScreenRecordingFilterValuesPageView.md +28 -13
  556. data/docs/ScreenRecordingHeatmap.md +64 -31
  557. data/docs/ScreenRecordingHeatmapIndexRequest.md +18 -8
  558. data/docs/ScreenRecordingHeatmapIndexResponse.md +26 -12
  559. data/docs/ScreenRecordingHeatmapRequest.md +22 -10
  560. data/docs/ScreenRecordingHeatmapReset.md +18 -8
  561. data/docs/ScreenRecordingHeatmapResponse.md +26 -12
  562. data/docs/ScreenRecordingHeatmapUrl.md +28 -13
  563. data/docs/ScreenRecordingMerchantNotesRequest.md +18 -8
  564. data/docs/ScreenRecordingMultifield.md +26 -12
  565. data/docs/ScreenRecordingPageView.md +54 -26
  566. data/docs/ScreenRecordingPageViewDataResponse.md +26 -12
  567. data/docs/ScreenRecordingPageViewEvent.md +28 -13
  568. data/docs/ScreenRecordingPageViewEventParameter.md +20 -9
  569. data/docs/ScreenRecordingPageViewParameter.md +20 -9
  570. data/docs/ScreenRecordingQueryRequest.md +18 -8
  571. data/docs/ScreenRecordingQueryResponse.md +38 -18
  572. data/docs/ScreenRecordingResponse.md +28 -13
  573. data/docs/ScreenRecordingSegment.md +36 -17
  574. data/docs/ScreenRecordingSegmentResponse.md +26 -12
  575. data/docs/ScreenRecordingSegmentsResponse.md +26 -12
  576. data/docs/ScreenRecordingSettings.md +32 -15
  577. data/docs/ScreenRecordingSettingsResponse.md +26 -12
  578. data/docs/ScreenRecordingStoreFront.md +20 -9
  579. data/docs/ScreenRecordingTagsRequest.md +18 -8
  580. data/docs/ScreenRecordingTagsResponse.md +26 -12
  581. data/docs/ScreenRecordingUserAgent.md +26 -12
  582. data/docs/ScreenRecordingUserAgentDevice.md +18 -8
  583. data/docs/ScreenRecordingUserAgentOS.md +22 -10
  584. data/docs/ScreenRecordingUserProperty.md +20 -9
  585. data/docs/ScreenshotsResponse.md +26 -12
  586. data/docs/SelfConfig.md +18 -8
  587. data/docs/SimpleValue.md +20 -9
  588. data/docs/SingleSignOnAuthorizeRequest.md +20 -9
  589. data/docs/SingleSignOnAuthorizeResponse.md +20 -9
  590. data/docs/SingleSignOnTokenRequest.md +20 -9
  591. data/docs/SingleSignOnTokenResponse.md +22 -10
  592. data/docs/SovosConfig.md +30 -14
  593. data/docs/SsoApi.md +300 -201
  594. data/docs/StateProvince.md +20 -9
  595. data/docs/StepWaiting.md +20 -9
  596. data/docs/StorefrontApi.md +13005 -9053
  597. data/docs/TaxApi.md +2101 -1421
  598. data/docs/TaxCity.md +34 -16
  599. data/docs/TaxCountry.md +34 -16
  600. data/docs/TaxCountryCode.md +26 -12
  601. data/docs/TaxCounty.md +36 -17
  602. data/docs/TaxJarConfig.md +30 -14
  603. data/docs/TaxPostalCode.md +30 -14
  604. data/docs/TaxProviderActivateResult.md +20 -9
  605. data/docs/TaxProviderAvalara.md +24 -11
  606. data/docs/TaxProviderAvalaraCompaniesResult.md +18 -8
  607. data/docs/TaxProviderAvalaraCompany.md +26 -12
  608. data/docs/TaxProviderSelf.md +26 -12
  609. data/docs/TaxProviderSelfCountriesResponse.md +18 -8
  610. data/docs/TaxProviderSelfRegionsResponse.md +18 -8
  611. data/docs/TaxProviderSovos.md +24 -11
  612. data/docs/TaxProviderTaxJar.md +24 -11
  613. data/docs/TaxProviderTestResult.md +20 -9
  614. data/docs/TaxProviderUltraCart.md +26 -12
  615. data/docs/TaxProviderUltraCartState.md +36 -17
  616. data/docs/TaxProvidersResponse.md +34 -16
  617. data/docs/TaxState.md +52 -25
  618. data/docs/TaxStateCode.md +26 -12
  619. data/docs/TempMultimedia.md +30 -14
  620. data/docs/TempMultimediaResponse.md +26 -12
  621. data/docs/ThumbnailParametersRequest.md +26 -12
  622. data/docs/ThumbnailParametersResponse.md +26 -12
  623. data/docs/TransactionEmail.md +56 -27
  624. data/docs/TransactionEmailListResponse.md +26 -12
  625. data/docs/TransactionEmailOption.md +32 -15
  626. data/docs/TransactionEmailResponse.md +26 -12
  627. data/docs/Twilio.md +24 -11
  628. data/docs/TwilioResponse.md +28 -13
  629. data/docs/TwiliosResponse.md +26 -12
  630. data/docs/UltraCartConfig.md +18 -8
  631. data/docs/UploadCouponCodesRequest.md +26 -12
  632. data/docs/UploadCouponCodesResponse.md +30 -14
  633. data/docs/User.md +44 -21
  634. data/docs/UserApi.md +823 -558
  635. data/docs/UserGroupMembership.md +22 -10
  636. data/docs/UserLogin.md +24 -11
  637. data/docs/UserLoginsResponse.md +26 -12
  638. data/docs/UserResponse.md +26 -12
  639. data/docs/UsersResponse.md +26 -12
  640. data/docs/VerificationRecord.md +22 -10
  641. data/docs/Warning.md +20 -9
  642. data/docs/Webhook.md +52 -26
  643. data/docs/WebhookApi.md +636 -447
  644. data/docs/WebhookEventCategory.md +26 -12
  645. data/docs/WebhookEventSubscription.md +34 -16
  646. data/docs/WebhookLog.md +38 -18
  647. data/docs/WebhookLogResponse.md +26 -12
  648. data/docs/WebhookLogSummariesResponse.md +26 -12
  649. data/docs/WebhookLogSummary.md +22 -10
  650. data/docs/WebhookResponse.md +26 -12
  651. data/docs/WebhookSampleRequest.md +24 -11
  652. data/docs/WebhookSampleRequestResponse.md +26 -12
  653. data/docs/WebhooksResponse.md +26 -12
  654. data/docs/Weight.md +20 -9
  655. data/git_push.sh +57 -55
  656. data/lib/ultracart_api/api/affiliate_api.rb +191 -164
  657. data/lib/ultracart_api/api/auto_order_api.rb +672 -639
  658. data/lib/ultracart_api/api/channel_partner_api.rb +370 -664
  659. data/lib/ultracart_api/api/chargeback_api.rb +410 -356
  660. data/lib/ultracart_api/api/checkout_api.rb +1341 -1111
  661. data/lib/ultracart_api/api/coupon_api.rb +1390 -1161
  662. data/lib/ultracart_api/api/customer_api.rb +1292 -1218
  663. data/lib/ultracart_api/api/fulfillment_api.rb +452 -381
  664. data/lib/ultracart_api/api/gift_certificate_api.rb +594 -502
  665. data/lib/ultracart_api/api/integration_log_api.rb +404 -350
  666. data/lib/ultracart_api/api/item_api.rb +686 -1303
  667. data/lib/ultracart_api/api/oauth_api.rb +198 -171
  668. data/lib/ultracart_api/api/order_api.rb +1728 -1645
  669. data/lib/ultracart_api/api/sso_api.rb +289 -243
  670. data/lib/ultracart_api/api/storefront_api.rb +11407 -10209
  671. data/lib/ultracart_api/api/tax_api.rb +1916 -1580
  672. data/lib/ultracart_api/api/user_api.rb +755 -634
  673. data/lib/ultracart_api/api/webhook_api.rb +601 -514
  674. data/lib/ultracart_api/api_client.rb +399 -400
  675. data/lib/ultracart_api/api_error.rb +57 -38
  676. data/lib/ultracart_api/configuration.rb +302 -229
  677. data/lib/ultracart_api/models/accounts_receivable_retry_config.rb +364 -341
  678. data/lib/ultracart_api/models/accounts_receivable_retry_config_response.rb +287 -252
  679. data/lib/ultracart_api/models/accounts_receivable_retry_day_activity.rb +240 -205
  680. data/lib/ultracart_api/models/accounts_receivable_retry_stat_account.rb +250 -215
  681. data/lib/ultracart_api/models/accounts_receivable_retry_stat_metrics.rb +309 -274
  682. data/lib/ultracart_api/models/accounts_receivable_retry_stat_revenue.rb +228 -193
  683. data/lib/ultracart_api/models/accounts_receivable_retry_stats_response.rb +267 -232
  684. data/lib/ultracart_api/models/activity.rb +264 -247
  685. data/lib/ultracart_api/models/add_library_item_request.rb +324 -289
  686. data/lib/ultracart_api/models/adjust_internal_certificate_request.rb +270 -235
  687. data/lib/ultracart_api/models/adjust_internal_certificate_response.rb +267 -232
  688. data/lib/ultracart_api/models/affiliate_click.rb +319 -304
  689. data/lib/ultracart_api/models/affiliate_click_query.rb +270 -235
  690. data/lib/ultracart_api/models/affiliate_clicks_response.rb +259 -224
  691. data/lib/ultracart_api/models/affiliate_ledger.rb +431 -396
  692. data/lib/ultracart_api/models/affiliate_ledger_query.rb +270 -235
  693. data/lib/ultracart_api/models/affiliate_ledgers_response.rb +259 -224
  694. data/lib/ultracart_api/models/affiliate_link.rb +408 -373
  695. data/lib/ultracart_api/models/api_user_application_profile.rb +260 -225
  696. data/lib/ultracart_api/models/apply_library_item_request.rb +250 -215
  697. data/lib/ultracart_api/models/apply_library_item_response.rb +319 -284
  698. data/lib/ultracart_api/models/auto_order.rb +469 -455
  699. data/lib/ultracart_api/models/auto_order_item.rb +487 -472
  700. data/lib/ultracart_api/models/auto_order_item_future_schedule.rb +250 -215
  701. data/lib/ultracart_api/models/auto_order_item_option.rb +260 -225
  702. data/lib/ultracart_api/models/auto_order_item_simple_schedule.rb +274 -239
  703. data/lib/ultracart_api/models/auto_order_log.rb +230 -195
  704. data/lib/ultracart_api/models/auto_order_query.rb +480 -445
  705. data/lib/ultracart_api/models/auto_order_query_batch.rb +222 -187
  706. data/lib/ultracart_api/models/auto_order_response.rb +256 -221
  707. data/lib/ultracart_api/models/auto_orders_request.rb +222 -187
  708. data/lib/ultracart_api/models/auto_orders_response.rb +258 -223
  709. data/lib/ultracart_api/models/avalara_config.rb +340 -305
  710. data/lib/ultracart_api/models/base_response.rb +247 -212
  711. data/lib/ultracart_api/models/browser.rb +237 -202
  712. data/lib/ultracart_api/models/browser_device.rb +219 -184
  713. data/lib/ultracart_api/models/browser_os.rb +255 -220
  714. data/lib/ultracart_api/models/browser_user_agent.rb +246 -211
  715. data/lib/ultracart_api/models/cart.rb +506 -471
  716. data/lib/ultracart_api/models/cart_affiliate.rb +245 -210
  717. data/lib/ultracart_api/models/cart_affirm_checkout_response.rb +232 -197
  718. data/lib/ultracart_api/models/cart_billing.rb +572 -587
  719. data/lib/ultracart_api/models/cart_buysafe.rb +269 -234
  720. data/lib/ultracart_api/models/cart_checkout.rb +500 -540
  721. data/lib/ultracart_api/models/cart_coupon.rb +220 -185
  722. data/lib/ultracart_api/models/cart_currency_conversion.rb +232 -197
  723. data/lib/ultracart_api/models/cart_customer_profile.rb +438 -413
  724. data/lib/ultracart_api/models/cart_customer_profile_address.rb +350 -315
  725. data/lib/ultracart_api/models/cart_customer_profile_credit_card.rb +304 -269
  726. data/lib/ultracart_api/models/cart_finalize_order_request.rb +228 -193
  727. data/lib/ultracart_api/models/cart_finalize_order_request_options.rb +355 -320
  728. data/lib/ultracart_api/models/cart_finalize_order_response.rb +260 -225
  729. data/lib/ultracart_api/models/cart_gift.rb +313 -278
  730. data/lib/ultracart_api/models/cart_gift_certificate.rb +238 -203
  731. data/lib/ultracart_api/models/cart_item.rb +504 -481
  732. data/lib/ultracart_api/models/cart_item_attribute.rb +240 -205
  733. data/lib/ultracart_api/models/cart_item_multimedia.rb +336 -301
  734. data/lib/ultracart_api/models/cart_item_multimedia_thumbnail.rb +260 -225
  735. data/lib/ultracart_api/models/cart_item_option.rb +378 -343
  736. data/lib/ultracart_api/models/cart_item_option_value.rb +258 -223
  737. data/lib/ultracart_api/models/cart_item_physical.rb +246 -211
  738. data/lib/ultracart_api/models/cart_item_variation_selection.rb +230 -195
  739. data/lib/ultracart_api/models/cart_kit_component_option.rb +398 -363
  740. data/lib/ultracart_api/models/cart_marketing.rb +230 -205
  741. data/lib/ultracart_api/models/cart_payment.rb +275 -240
  742. data/lib/ultracart_api/models/cart_payment_affirm.rb +220 -185
  743. data/lib/ultracart_api/models/cart_payment_amazon.rb +220 -185
  744. data/lib/ultracart_api/models/cart_payment_check.rb +220 -185
  745. data/lib/ultracart_api/models/cart_payment_credit_card.rb +300 -265
  746. data/lib/ultracart_api/models/cart_payment_purchase_order.rb +220 -185
  747. data/lib/ultracart_api/models/cart_profile_login_request.rb +239 -204
  748. data/lib/ultracart_api/models/cart_profile_login_response.rb +231 -196
  749. data/lib/ultracart_api/models/cart_profile_register_request.rb +229 -194
  750. data/lib/ultracart_api/models/cart_profile_register_response.rb +231 -196
  751. data/lib/ultracart_api/models/cart_property.rb +280 -245
  752. data/lib/ultracart_api/models/cart_response.rb +231 -196
  753. data/lib/ultracart_api/models/cart_settings.rb +264 -229
  754. data/lib/ultracart_api/models/cart_settings_billing.rb +222 -187
  755. data/lib/ultracart_api/models/cart_settings_gift.rb +251 -216
  756. data/lib/ultracart_api/models/cart_settings_gift_wrap.rb +239 -204
  757. data/lib/ultracart_api/models/cart_settings_payment.rb +337 -302
  758. data/lib/ultracart_api/models/cart_settings_payment_amazon.rb +240 -205
  759. data/lib/ultracart_api/models/cart_settings_payment_credit_card.rb +242 -207
  760. data/lib/ultracart_api/models/cart_settings_payment_pay_pal.rb +260 -225
  761. data/lib/ultracart_api/models/cart_settings_province.rb +228 -193
  762. data/lib/ultracart_api/models/cart_settings_shipping.rb +262 -227
  763. data/lib/ultracart_api/models/cart_settings_shipping_calendar.rb +264 -229
  764. data/lib/ultracart_api/models/cart_settings_shipping_estimate.rb +345 -310
  765. data/lib/ultracart_api/models/cart_settings_taxes.rb +221 -186
  766. data/lib/ultracart_api/models/cart_settings_terms.rb +230 -195
  767. data/lib/ultracart_api/models/cart_shipping.rb +625 -590
  768. data/lib/ultracart_api/models/cart_summary.rb +354 -319
  769. data/lib/ultracart_api/models/cart_taxes.rb +255 -220
  770. data/lib/ultracart_api/models/cart_upsell_after.rb +255 -220
  771. data/lib/ultracart_api/models/cart_validation_request.rb +231 -196
  772. data/lib/ultracart_api/models/cart_validation_response.rb +231 -196
  773. data/lib/ultracart_api/models/channel_partner_cancel_response.rb +259 -224
  774. data/lib/ultracart_api/models/channel_partner_estimate_shipping_response.rb +259 -224
  775. data/lib/ultracart_api/models/channel_partner_estimate_tax_response.rb +256 -221
  776. data/lib/ultracart_api/models/channel_partner_import_response.rb +281 -246
  777. data/lib/ultracart_api/models/channel_partner_order.rb +1604 -1569
  778. data/lib/ultracart_api/models/channel_partner_order_item.rb +331 -296
  779. data/lib/ultracart_api/models/channel_partner_order_item_option.rb +230 -195
  780. data/lib/ultracart_api/models/channel_partner_order_transaction.rb +232 -197
  781. data/lib/ultracart_api/models/channel_partner_order_transaction_detail.rb +230 -195
  782. data/lib/ultracart_api/models/channel_partner_shipping_estimate.rb +230 -195
  783. data/lib/ultracart_api/models/chargeback_dispute.rb +649 -614
  784. data/lib/ultracart_api/models/chargeback_dispute_response.rb +256 -221
  785. data/lib/ultracart_api/models/chargeback_disputes_response.rb +258 -223
  786. data/lib/ultracart_api/models/checkout_allowed_countries_response.rb +221 -186
  787. data/lib/ultracart_api/models/checkout_handoff_request.rb +323 -288
  788. data/lib/ultracart_api/models/checkout_handoff_response.rb +241 -206
  789. data/lib/ultracart_api/models/checkout_setup_browser_key_request.rb +222 -187
  790. data/lib/ultracart_api/models/checkout_setup_browser_key_response.rb +220 -185
  791. data/lib/ultracart_api/models/checkout_state_province_response.rb +221 -186
  792. data/lib/ultracart_api/models/city_state_zip.rb +255 -220
  793. data/lib/ultracart_api/models/countries_response.rb +221 -186
  794. data/lib/ultracart_api/models/country.rb +260 -225
  795. data/lib/ultracart_api/models/coupon.rb +864 -908
  796. data/lib/ultracart_api/models/coupon_amount_off_items.rb +267 -232
  797. data/lib/ultracart_api/models/coupon_amount_off_shipping.rb +257 -222
  798. data/lib/ultracart_api/models/coupon_amount_off_shipping_with_items_purchase.rb +269 -234
  799. data/lib/ultracart_api/models/coupon_amount_off_subtotal.rb +245 -210
  800. data/lib/ultracart_api/models/coupon_amount_off_subtotal_and_shipping.rb +245 -210
  801. data/lib/ultracart_api/models/coupon_amount_off_subtotal_free_shipping_with_purchase.rb +267 -232
  802. data/lib/ultracart_api/models/coupon_amount_off_subtotal_with_block_purchase.rb +265 -230
  803. data/lib/ultracart_api/models/coupon_amount_off_subtotal_with_items_purchase.rb +267 -232
  804. data/lib/ultracart_api/models/coupon_amount_off_subtotal_with_purchase.rb +255 -220
  805. data/lib/ultracart_api/models/coupon_amount_shipping_with_subtotal.rb +267 -232
  806. data/lib/ultracart_api/models/coupon_auto_apply_condition.rb +239 -204
  807. data/lib/ultracart_api/models/coupon_auto_apply_conditions.rb +269 -234
  808. data/lib/ultracart_api/models/coupon_automatically_apply_coupon_codes.rb +222 -187
  809. data/lib/ultracart_api/models/coupon_buy_one_get_one_limit.rb +232 -197
  810. data/lib/ultracart_api/models/coupon_codes_request.rb +277 -242
  811. data/lib/ultracart_api/models/coupon_codes_response.rb +269 -234
  812. data/lib/ultracart_api/models/coupon_deletes_request.rb +234 -199
  813. data/lib/ultracart_api/models/coupon_discount_item_with_item_purchase.rb +275 -240
  814. data/lib/ultracart_api/models/coupon_discount_items.rb +267 -232
  815. data/lib/ultracart_api/models/coupon_editor_values.rb +330 -295
  816. data/lib/ultracart_api/models/coupon_exists_response.rb +267 -232
  817. data/lib/ultracart_api/models/coupon_free_item_and_shipping_with_subtotal.rb +279 -244
  818. data/lib/ultracart_api/models/coupon_free_item_with_item_purchase.rb +254 -219
  819. data/lib/ultracart_api/models/coupon_free_item_with_subtotal.rb +267 -232
  820. data/lib/ultracart_api/models/coupon_free_items_with_item_purchase.rb +260 -225
  821. data/lib/ultracart_api/models/coupon_free_items_with_mix_match_purchase.rb +260 -225
  822. data/lib/ultracart_api/models/coupon_free_shipping.rb +222 -187
  823. data/lib/ultracart_api/models/coupon_free_shipping_specific_items.rb +222 -187
  824. data/lib/ultracart_api/models/coupon_free_shipping_with_items_purchase.rb +234 -199
  825. data/lib/ultracart_api/models/coupon_free_shipping_with_subtotal.rb +257 -222
  826. data/lib/ultracart_api/models/coupon_item_search_result.rb +290 -255
  827. data/lib/ultracart_api/models/coupon_item_search_results_response.rb +259 -224
  828. data/lib/ultracart_api/models/coupon_multiple_amounts_off_items.rb +232 -197
  829. data/lib/ultracart_api/models/coupon_percent_off_item_with_items_quantity_purchase.rb +264 -229
  830. data/lib/ultracart_api/models/coupon_percent_off_items.rb +254 -219
  831. data/lib/ultracart_api/models/coupon_percent_off_items_and_free_shipping.rb +244 -209
  832. data/lib/ultracart_api/models/coupon_percent_off_items_with_items_purchase.rb +254 -219
  833. data/lib/ultracart_api/models/coupon_percent_off_msrp_items.rb +254 -239
  834. data/lib/ultracart_api/models/coupon_percent_off_retail_price_items.rb +254 -219
  835. data/lib/ultracart_api/models/coupon_percent_off_shipping.rb +232 -197
  836. data/lib/ultracart_api/models/coupon_percent_off_subtotal.rb +220 -185
  837. data/lib/ultracart_api/models/coupon_percent_off_subtotal_and_free_shipping.rb +232 -197
  838. data/lib/ultracart_api/models/coupon_percent_off_subtotal_limit.rb +255 -220
  839. data/lib/ultracart_api/models/coupon_percent_off_subtotal_with_items_purchase.rb +232 -197
  840. data/lib/ultracart_api/models/coupon_percent_off_subtotal_with_subtotal.rb +255 -220
  841. data/lib/ultracart_api/models/coupon_query.rb +310 -275
  842. data/lib/ultracart_api/models/coupon_response.rb +268 -233
  843. data/lib/ultracart_api/models/coupon_restriction.rb +246 -211
  844. data/lib/ultracart_api/models/coupon_tier_amount.rb +255 -220
  845. data/lib/ultracart_api/models/coupon_tier_item_discount.rb +232 -197
  846. data/lib/ultracart_api/models/coupon_tier_percent.rb +255 -220
  847. data/lib/ultracart_api/models/coupon_tier_quantity_amount.rb +255 -220
  848. data/lib/ultracart_api/models/coupon_tier_quantity_percent.rb +255 -220
  849. data/lib/ultracart_api/models/coupon_tiered_amount_off_items.rb +244 -209
  850. data/lib/ultracart_api/models/coupon_tiered_amount_off_subtotal.rb +234 -199
  851. data/lib/ultracart_api/models/coupon_tiered_percent_off_items.rb +244 -209
  852. data/lib/ultracart_api/models/coupon_tiered_percent_off_shipping.rb +259 -224
  853. data/lib/ultracart_api/models/coupon_tiered_percent_off_subtotal.rb +234 -199
  854. data/lib/ultracart_api/models/coupon_type.rb +230 -195
  855. data/lib/ultracart_api/models/coupons_request.rb +222 -187
  856. data/lib/ultracart_api/models/coupons_response.rb +258 -223
  857. data/lib/ultracart_api/models/currency.rb +260 -225
  858. data/lib/ultracart_api/models/customer.rb +978 -972
  859. data/lib/ultracart_api/models/customer_activity.rb +254 -255
  860. data/lib/ultracart_api/models/customer_affiliate.rb +250 -215
  861. data/lib/ultracart_api/models/customer_attachment.rb +260 -225
  862. data/lib/ultracart_api/models/customer_billing.rb +575 -540
  863. data/lib/ultracart_api/models/customer_card.rb +290 -255
  864. data/lib/ultracart_api/models/customer_editor_values.rb +328 -317
  865. data/lib/ultracart_api/models/customer_email.rb +300 -265
  866. data/lib/ultracart_api/models/customer_email_list_changes.rb +234 -199
  867. data/lib/ultracart_api/models/customer_loyalty.rb +283 -248
  868. data/lib/ultracart_api/models/customer_loyalty_ledger.rb +360 -325
  869. data/lib/ultracart_api/models/customer_loyalty_redemption.rb +340 -305
  870. data/lib/ultracart_api/models/customer_orders_summary.rb +250 -215
  871. data/lib/ultracart_api/models/customer_pricing_tier.rb +245 -210
  872. data/lib/ultracart_api/models/customer_privacy.rb +250 -215
  873. data/lib/ultracart_api/models/customer_query.rb +789 -754
  874. data/lib/ultracart_api/models/customer_quotes_summary.rb +250 -215
  875. data/lib/ultracart_api/models/customer_response.rb +256 -221
  876. data/lib/ultracart_api/models/customer_reviewer.rb +310 -275
  877. data/lib/ultracart_api/models/customer_shipping.rb +575 -540
  878. data/lib/ultracart_api/models/customer_software_entitlement.rb +365 -330
  879. data/lib/ultracart_api/models/customer_store_credit.rb +274 -239
  880. data/lib/ultracart_api/models/customer_store_credit_add_request.rb +250 -215
  881. data/lib/ultracart_api/models/customer_store_credit_ledger_entry.rb +295 -260
  882. data/lib/ultracart_api/models/customer_store_credit_response.rb +256 -221
  883. data/lib/ultracart_api/models/customer_tag.rb +235 -200
  884. data/lib/ultracart_api/models/customer_tax_codes.rb +260 -225
  885. data/lib/ultracart_api/models/customers_response.rb +258 -223
  886. data/lib/ultracart_api/models/data_tables_server_side_response.rb +248 -213
  887. data/lib/ultracart_api/models/distance.rb +264 -229
  888. data/lib/ultracart_api/models/distribution_center.rb +559 -674
  889. data/lib/ultracart_api/models/distribution_centers_response.rb +258 -223
  890. data/lib/ultracart_api/models/email_base_template_list_response.rb +221 -186
  891. data/lib/ultracart_api/models/email_campaign.rb +467 -452
  892. data/lib/ultracart_api/models/email_campaign_folder.rb +275 -240
  893. data/lib/ultracart_api/models/email_campaign_folder_response.rb +256 -221
  894. data/lib/ultracart_api/models/email_campaign_folders_response.rb +258 -223
  895. data/lib/ultracart_api/models/email_campaign_response.rb +256 -221
  896. data/lib/ultracart_api/models/email_campaigns_response.rb +258 -223
  897. data/lib/ultracart_api/models/email_click.rb +230 -195
  898. data/lib/ultracart_api/models/email_clicks_response.rb +258 -223
  899. data/lib/ultracart_api/models/email_commseq.rb +252 -217
  900. data/lib/ultracart_api/models/email_commseq_email.rb +470 -435
  901. data/lib/ultracart_api/models/email_commseq_email_response.rb +256 -221
  902. data/lib/ultracart_api/models/email_commseq_email_send_test_request.rb +304 -269
  903. data/lib/ultracart_api/models/email_commseq_email_send_test_response.rb +247 -212
  904. data/lib/ultracart_api/models/email_commseq_emails_request.rb +258 -223
  905. data/lib/ultracart_api/models/email_commseq_emails_response.rb +258 -223
  906. data/lib/ultracart_api/models/email_commseq_postcard.rb +340 -305
  907. data/lib/ultracart_api/models/email_commseq_postcard_response.rb +256 -221
  908. data/lib/ultracart_api/models/email_commseq_postcard_send_test_request.rb +329 -294
  909. data/lib/ultracart_api/models/email_commseq_postcard_send_test_response.rb +274 -239
  910. data/lib/ultracart_api/models/email_commseq_postcards_request.rb +221 -186
  911. data/lib/ultracart_api/models/email_commseq_postcards_response.rb +258 -223
  912. data/lib/ultracart_api/models/email_commseq_response.rb +256 -221
  913. data/lib/ultracart_api/models/email_commseq_stat.rb +580 -545
  914. data/lib/ultracart_api/models/email_commseq_stat_response.rb +256 -221
  915. data/lib/ultracart_api/models/email_commseq_step.rb +348 -313
  916. data/lib/ultracart_api/models/email_commseq_step_log.rb +240 -205
  917. data/lib/ultracart_api/models/email_commseq_step_logs_response.rb +258 -223
  918. data/lib/ultracart_api/models/email_commseq_webhook_send_test_request.rb +275 -240
  919. data/lib/ultracart_api/models/email_commseq_webhook_send_test_response.rb +277 -242
  920. data/lib/ultracart_api/models/email_commseqs_response.rb +258 -223
  921. data/lib/ultracart_api/models/email_customer.rb +292 -257
  922. data/lib/ultracart_api/models/email_customer_editor_url_response.rb +256 -221
  923. data/lib/ultracart_api/models/email_customers_response.rb +262 -227
  924. data/lib/ultracart_api/models/email_dashboard_activity.rb +280 -245
  925. data/lib/ultracart_api/models/email_dashboard_activity_response.rb +258 -223
  926. data/lib/ultracart_api/models/email_dashboard_stats_response.rb +258 -223
  927. data/lib/ultracart_api/models/email_domain.rb +329 -294
  928. data/lib/ultracart_api/models/email_editor_token_response.rb +256 -221
  929. data/lib/ultracart_api/models/email_flow.rb +505 -500
  930. data/lib/ultracart_api/models/email_flow_back_populate_request.rb +230 -195
  931. data/lib/ultracart_api/models/email_flow_back_populate_response.rb +247 -212
  932. data/lib/ultracart_api/models/email_flow_folder.rb +275 -240
  933. data/lib/ultracart_api/models/email_flow_folder_response.rb +256 -221
  934. data/lib/ultracart_api/models/email_flow_folders_response.rb +258 -223
  935. data/lib/ultracart_api/models/email_flow_response.rb +256 -221
  936. data/lib/ultracart_api/models/email_flows_response.rb +258 -223
  937. data/lib/ultracart_api/models/email_global_settings.rb +219 -184
  938. data/lib/ultracart_api/models/email_global_settings_response.rb +256 -221
  939. data/lib/ultracart_api/models/email_global_unsubscribe_request.rb +219 -184
  940. data/lib/ultracart_api/models/email_global_unsubscribe_response.rb +219 -184
  941. data/lib/ultracart_api/models/email_histogram_property_names_response.rb +221 -186
  942. data/lib/ultracart_api/models/email_histogram_property_values_response.rb +221 -186
  943. data/lib/ultracart_api/models/email_list.rb +347 -312
  944. data/lib/ultracart_api/models/email_list_archive_response.rb +256 -221
  945. data/lib/ultracart_api/models/email_list_customer.rb +250 -215
  946. data/lib/ultracart_api/models/email_list_customers_response.rb +262 -227
  947. data/lib/ultracart_api/models/email_list_response.rb +256 -221
  948. data/lib/ultracart_api/models/email_list_segment_folder.rb +275 -240
  949. data/lib/ultracart_api/models/email_list_segment_folder_response.rb +256 -221
  950. data/lib/ultracart_api/models/email_list_segment_folders_response.rb +258 -223
  951. data/lib/ultracart_api/models/email_list_segment_membership.rb +250 -215
  952. data/lib/ultracart_api/models/email_list_segment_used_by.rb +240 -205
  953. data/lib/ultracart_api/models/email_list_subscribe_response.rb +228 -193
  954. data/lib/ultracart_api/models/email_lists_response.rb +258 -223
  955. data/lib/ultracart_api/models/email_order.rb +249 -214
  956. data/lib/ultracart_api/models/email_orders_response.rb +258 -223
  957. data/lib/ultracart_api/models/email_performance.rb +475 -440
  958. data/lib/ultracart_api/models/email_performance_customer_histogram.rb +222 -187
  959. data/lib/ultracart_api/models/email_performance_customer_histogram_period.rb +260 -225
  960. data/lib/ultracart_api/models/email_performance_daily.rb +280 -245
  961. data/lib/ultracart_api/models/email_performance_response.rb +256 -221
  962. data/lib/ultracart_api/models/email_plan.rb +365 -330
  963. data/lib/ultracart_api/models/email_plan_additional.rb +291 -256
  964. data/lib/ultracart_api/models/email_plan_response.rb +256 -221
  965. data/lib/ultracart_api/models/email_postcard_stat.rb +531 -496
  966. data/lib/ultracart_api/models/email_segment.rb +445 -420
  967. data/lib/ultracart_api/models/email_segment_archive_response.rb +256 -221
  968. data/lib/ultracart_api/models/email_segment_customer.rb +250 -215
  969. data/lib/ultracart_api/models/email_segment_customers_response.rb +262 -227
  970. data/lib/ultracart_api/models/email_segment_download_prepare_response.rb +283 -248
  971. data/lib/ultracart_api/models/email_segment_response.rb +256 -221
  972. data/lib/ultracart_api/models/email_segments_response.rb +258 -223
  973. data/lib/ultracart_api/models/email_sending_domain_response.rb +256 -221
  974. data/lib/ultracart_api/models/email_sending_domains_response.rb +258 -223
  975. data/lib/ultracart_api/models/email_settings.rb +318 -311
  976. data/lib/ultracart_api/models/email_settings_response.rb +256 -221
  977. data/lib/ultracart_api/models/email_stat.rb +591 -556
  978. data/lib/ultracart_api/models/email_stat_postcard_summary_request.rb +230 -195
  979. data/lib/ultracart_api/models/email_stat_postcard_summary_response.rb +258 -223
  980. data/lib/ultracart_api/models/email_stat_summary_request.rb +241 -206
  981. data/lib/ultracart_api/models/email_stat_summary_response.rb +258 -223
  982. data/lib/ultracart_api/models/email_step_stat.rb +410 -475
  983. data/lib/ultracart_api/models/email_step_stat_request.rb +230 -195
  984. data/lib/ultracart_api/models/email_step_stat_response.rb +258 -223
  985. data/lib/ultracart_api/models/email_step_waiting_request.rb +221 -186
  986. data/lib/ultracart_api/models/email_step_waiting_response.rb +221 -186
  987. data/lib/ultracart_api/models/email_template.rb +365 -330
  988. data/lib/ultracart_api/models/email_templates_response.rb +258 -223
  989. data/lib/ultracart_api/models/email_third_party_list.rb +230 -195
  990. data/lib/ultracart_api/models/email_third_party_list_import_request.rb +222 -187
  991. data/lib/ultracart_api/models/email_third_party_provider.rb +324 -289
  992. data/lib/ultracart_api/models/email_third_party_providers_response.rb +258 -223
  993. data/lib/ultracart_api/models/email_third_party_tag.rb +230 -195
  994. data/lib/ultracart_api/models/email_verify_token_request.rb +230 -195
  995. data/lib/ultracart_api/models/email_verify_token_response.rb +257 -222
  996. data/lib/ultracart_api/models/email_verify_token_validate_request.rb +220 -185
  997. data/lib/ultracart_api/models/email_verify_token_validate_response.rb +247 -212
  998. data/lib/ultracart_api/models/email_webhook_editor_values_response.rb +278 -243
  999. data/lib/ultracart_api/models/error.rb +260 -225
  1000. data/lib/ultracart_api/models/error_response.rb +247 -212
  1001. data/lib/ultracart_api/models/experiment.rb +426 -463
  1002. data/lib/ultracart_api/models/experiment_response.rb +256 -221
  1003. data/lib/ultracart_api/models/experiment_variation.rb +432 -407
  1004. data/lib/ultracart_api/models/experiment_variation_stat.rb +320 -295
  1005. data/lib/ultracart_api/models/experiments_response.rb +258 -223
  1006. data/lib/ultracart_api/models/fulfillment_inventory.rb +228 -193
  1007. data/lib/ultracart_api/models/fulfillment_shipment.rb +262 -227
  1008. data/lib/ultracart_api/models/geo_point.rb +228 -193
  1009. data/lib/ultracart_api/models/geocode_request.rb +260 -225
  1010. data/lib/ultracart_api/models/geocode_response.rb +265 -230
  1011. data/lib/ultracart_api/models/gift_certificate.rb +367 -332
  1012. data/lib/ultracart_api/models/gift_certificate_create_request.rb +260 -225
  1013. data/lib/ultracart_api/models/gift_certificate_ledger_entry.rb +285 -250
  1014. data/lib/ultracart_api/models/gift_certificate_query.rb +300 -265
  1015. data/lib/ultracart_api/models/gift_certificate_response.rb +256 -221
  1016. data/lib/ultracart_api/models/gift_certificates_response.rb +258 -223
  1017. data/lib/ultracart_api/models/group.rb +266 -231
  1018. data/lib/ultracart_api/models/group_response.rb +256 -221
  1019. data/lib/ultracart_api/models/group_user_membership.rb +260 -225
  1020. data/lib/ultracart_api/models/groups_response.rb +258 -223
  1021. data/lib/ultracart_api/models/http_header.rb +230 -195
  1022. data/lib/ultracart_api/models/integration_log.rb +379 -355
  1023. data/lib/ultracart_api/models/integration_log_file.rb +246 -211
  1024. data/lib/ultracart_api/models/integration_log_log.rb +228 -193
  1025. data/lib/ultracart_api/models/integration_log_query_filter_values.rb +340 -305
  1026. data/lib/ultracart_api/models/integration_log_query_request.rb +333 -329
  1027. data/lib/ultracart_api/models/integration_log_query_response.rb +267 -232
  1028. data/lib/ultracart_api/models/integration_log_response.rb +256 -221
  1029. data/lib/ultracart_api/models/integration_log_summary.rb +291 -256
  1030. data/lib/ultracart_api/models/integration_log_summary_query_request.rb +230 -195
  1031. data/lib/ultracart_api/models/integration_log_summary_query_response.rb +258 -223
  1032. data/lib/ultracart_api/models/item.rb +748 -713
  1033. data/lib/ultracart_api/models/item_accounting.rb +260 -225
  1034. data/lib/ultracart_api/models/item_amember.rb +245 -210
  1035. data/lib/ultracart_api/models/item_auto_order.rb +403 -418
  1036. data/lib/ultracart_api/models/item_auto_order_step.rb +413 -378
  1037. data/lib/ultracart_api/models/item_auto_order_step_arbitrary_unit_cost_schedule.rb +230 -195
  1038. data/lib/ultracart_api/models/item_auto_order_step_grandfather_pricing.rb +230 -195
  1039. data/lib/ultracart_api/models/item_cc_bill.rb +270 -235
  1040. data/lib/ultracart_api/models/item_channel_partner_mapping.rb +445 -410
  1041. data/lib/ultracart_api/models/item_chargeback.rb +234 -199
  1042. data/lib/ultracart_api/models/item_chargeback_addendum.rb +250 -215
  1043. data/lib/ultracart_api/models/item_chargeback_adjustment_request.rb +240 -205
  1044. data/lib/ultracart_api/models/item_checkout.rb +265 -230
  1045. data/lib/ultracart_api/models/item_content.rb +361 -326
  1046. data/lib/ultracart_api/models/item_content_assignment.rb +285 -250
  1047. data/lib/ultracart_api/models/item_content_attribute.rb +280 -245
  1048. data/lib/ultracart_api/models/item_content_multimedia.rb +441 -406
  1049. data/lib/ultracart_api/models/item_content_multimedia_thumbnail.rb +270 -235
  1050. data/lib/ultracart_api/models/item_digital_delivery.rb +317 -282
  1051. data/lib/ultracart_api/models/item_digital_item.rb +305 -334
  1052. data/lib/ultracart_api/models/item_ebay.rb +901 -866
  1053. data/lib/ultracart_api/models/item_ebay_category_specific.rb +230 -195
  1054. data/lib/ultracart_api/models/item_ebay_market_listing.rb +260 -225
  1055. data/lib/ultracart_api/models/item_ebay_market_place_analysis.rb +311 -276
  1056. data/lib/ultracart_api/models/item_email_notifications.rb +230 -195
  1057. data/lib/ultracart_api/models/item_enrollment123.rb +220 -185
  1058. data/lib/ultracart_api/models/item_fulfillment_addon.rb +250 -225
  1059. data/lib/ultracart_api/models/item_gift_certificate.rb +230 -195
  1060. data/lib/ultracart_api/models/item_google_product_search.rb +1289 -1254
  1061. data/lib/ultracart_api/models/item_identifiers.rb +310 -275
  1062. data/lib/ultracart_api/models/item_instant_payment_notification.rb +270 -235
  1063. data/lib/ultracart_api/models/item_instant_payment_notifications.rb +222 -187
  1064. data/lib/ultracart_api/models/item_internal.rb +235 -200
  1065. data/lib/ultracart_api/models/item_kit_component.rb +260 -225
  1066. data/lib/ultracart_api/models/item_kit_definition.rb +222 -187
  1067. data/lib/ultracart_api/models/item_option.rb +416 -381
  1068. data/lib/ultracart_api/models/item_option_value.rb +409 -374
  1069. data/lib/ultracart_api/models/item_option_value_additional_item.rb +230 -195
  1070. data/lib/ultracart_api/models/item_option_value_digital_item.rb +230 -195
  1071. data/lib/ultracart_api/models/item_payment_processing.rb +264 -229
  1072. data/lib/ultracart_api/models/item_physical.rb +246 -211
  1073. data/lib/ultracart_api/models/item_pricing.rb +422 -387
  1074. data/lib/ultracart_api/models/item_pricing_tier.rb +261 -226
  1075. data/lib/ultracart_api/models/item_pricing_tier_discount.rb +230 -195
  1076. data/lib/ultracart_api/models/item_pricing_tier_limit.rb +240 -227
  1077. data/lib/ultracart_api/models/item_property.rb +270 -235
  1078. data/lib/ultracart_api/models/item_realtime_pricing.rb +240 -205
  1079. data/lib/ultracart_api/models/item_related.rb +242 -207
  1080. data/lib/ultracart_api/models/item_related_item.rb +274 -239
  1081. data/lib/ultracart_api/models/item_reporting.rb +232 -197
  1082. data/lib/ultracart_api/models/item_response.rb +256 -221
  1083. data/lib/ultracart_api/models/item_restriction.rb +292 -257
  1084. data/lib/ultracart_api/models/item_restriction_item.rb +274 -239
  1085. data/lib/ultracart_api/models/item_revguard.rb +280 -245
  1086. data/lib/ultracart_api/models/item_reviews.rb +300 -276
  1087. data/lib/ultracart_api/models/item_salesforce.rb +230 -195
  1088. data/lib/ultracart_api/models/item_shipping.rb +713 -678
  1089. data/lib/ultracart_api/models/item_shipping_case.rb +265 -230
  1090. data/lib/ultracart_api/models/item_shipping_destination_markup.rb +315 -280
  1091. data/lib/ultracart_api/models/item_shipping_destination_restriction.rb +304 -269
  1092. data/lib/ultracart_api/models/item_shipping_distribution_center.rb +380 -345
  1093. data/lib/ultracart_api/models/item_shipping_method.rb +394 -359
  1094. data/lib/ultracart_api/models/item_shipping_package_requirement.rb +230 -195
  1095. data/lib/ultracart_api/models/item_tag.rb +279 -244
  1096. data/lib/ultracart_api/models/item_tags.rb +222 -187
  1097. data/lib/ultracart_api/models/item_tax.rb +286 -251
  1098. data/lib/ultracart_api/models/item_tax_exemption.rb +335 -300
  1099. data/lib/ultracart_api/models/item_third_party_email_marketing.rb +302 -267
  1100. data/lib/ultracart_api/models/item_variant_item.rb +289 -254
  1101. data/lib/ultracart_api/models/item_variation.rb +292 -257
  1102. data/lib/ultracart_api/models/item_variation_option.rb +265 -230
  1103. data/lib/ultracart_api/models/item_wishlist_member.rb +255 -220
  1104. data/lib/ultracart_api/models/items_request.rb +222 -187
  1105. data/lib/ultracart_api/models/items_response.rb +259 -224
  1106. data/lib/ultracart_api/models/key_value.rb +240 -205
  1107. data/lib/ultracart_api/models/library_filter_values.rb +254 -219
  1108. data/lib/ultracart_api/models/library_filter_values_response.rb +256 -221
  1109. data/lib/ultracart_api/models/library_item.rb +606 -571
  1110. data/lib/ultracart_api/models/library_item_account.rb +237 -202
  1111. data/lib/ultracart_api/models/library_item_asset.rb +228 -193
  1112. data/lib/ultracart_api/models/library_item_attribute.rb +228 -193
  1113. data/lib/ultracart_api/models/library_item_email.rb +237 -202
  1114. data/lib/ultracart_api/models/library_item_published_meta.rb +290 -255
  1115. data/lib/ultracart_api/models/library_item_purchased_meta.rb +240 -205
  1116. data/lib/ultracart_api/models/library_item_query.rb +330 -295
  1117. data/lib/ultracart_api/models/library_item_response.rb +256 -221
  1118. data/lib/ultracart_api/models/library_item_screenshot.rb +228 -193
  1119. data/lib/ultracart_api/models/library_items_response.rb +259 -224
  1120. data/lib/ultracart_api/models/linked_account.rb +240 -205
  1121. data/lib/ultracart_api/models/list_segment_membership.rb +237 -202
  1122. data/lib/ultracart_api/models/lookup_request.rb +255 -229
  1123. data/lib/ultracart_api/models/lookup_response.rb +258 -223
  1124. data/lib/ultracart_api/models/mailgun.rb +219 -184
  1125. data/lib/ultracart_api/models/metric.rb +282 -247
  1126. data/lib/ultracart_api/models/notification.rb +322 -287
  1127. data/lib/ultracart_api/models/oauth_revoke_success_response.rb +230 -195
  1128. data/lib/ultracart_api/models/oauth_token_response.rb +321 -286
  1129. data/lib/ultracart_api/models/order.rb +604 -610
  1130. data/lib/ultracart_api/models/order_affiliate.rb +242 -207
  1131. data/lib/ultracart_api/models/order_affiliate_ledger.rb +334 -299
  1132. data/lib/ultracart_api/models/order_auto_order.rb +448 -413
  1133. data/lib/ultracart_api/models/order_billing.rb +597 -612
  1134. data/lib/ultracart_api/models/order_buysafe.rb +268 -233
  1135. data/lib/ultracart_api/models/order_by_token_query.rb +220 -185
  1136. data/lib/ultracart_api/models/order_channel_partner.rb +335 -300
  1137. data/lib/ultracart_api/models/order_checkout.rb +469 -509
  1138. data/lib/ultracart_api/models/order_coupon.rb +290 -255
  1139. data/lib/ultracart_api/models/order_digital_item.rb +290 -255
  1140. data/lib/ultracart_api/models/order_digital_order.rb +262 -227
  1141. data/lib/ultracart_api/models/order_edi.rb +265 -230
  1142. data/lib/ultracart_api/models/order_format.rb +404 -369
  1143. data/lib/ultracart_api/models/order_format_response.rb +232 -197
  1144. data/lib/ultracart_api/models/order_fraud_score.rb +444 -409
  1145. data/lib/ultracart_api/models/order_gift.rb +351 -316
  1146. data/lib/ultracart_api/models/order_gift_certificate.rb +239 -204
  1147. data/lib/ultracart_api/models/order_internal.rb +275 -252
  1148. data/lib/ultracart_api/models/order_item.rb +889 -919
  1149. data/lib/ultracart_api/models/order_item_edi.rb +234 -199
  1150. data/lib/ultracart_api/models/order_item_edi_identification.rb +230 -195
  1151. data/lib/ultracart_api/models/order_item_edi_lot.rb +240 -205
  1152. data/lib/ultracart_api/models/order_item_option.rb +378 -343
  1153. data/lib/ultracart_api/models/order_item_option_file_attachment.rb +250 -215
  1154. data/lib/ultracart_api/models/order_item_property.rb +280 -245
  1155. data/lib/ultracart_api/models/order_item_tag.rb +235 -200
  1156. data/lib/ultracart_api/models/order_linked_shipment.rb +264 -229
  1157. data/lib/ultracart_api/models/order_marketing.rb +270 -245
  1158. data/lib/ultracart_api/models/order_packing_slip_response.rb +257 -222
  1159. data/lib/ultracart_api/models/order_payment.rb +432 -397
  1160. data/lib/ultracart_api/models/order_payment_check.rb +220 -185
  1161. data/lib/ultracart_api/models/order_payment_credit_card.rb +354 -328
  1162. data/lib/ultracart_api/models/order_payment_e_check.rb +476 -441
  1163. data/lib/ultracart_api/models/order_payment_insurance.rb +250 -215
  1164. data/lib/ultracart_api/models/order_payment_purchase_order.rb +220 -185
  1165. data/lib/ultracart_api/models/order_payment_transaction.rb +252 -227
  1166. data/lib/ultracart_api/models/order_payment_transaction_detail.rb +240 -205
  1167. data/lib/ultracart_api/models/order_process_payment_request.rb +230 -195
  1168. data/lib/ultracart_api/models/order_process_payment_response.rb +256 -221
  1169. data/lib/ultracart_api/models/order_property.rb +280 -245
  1170. data/lib/ultracart_api/models/order_query.rb +826 -791
  1171. data/lib/ultracart_api/models/order_query_batch.rb +222 -187
  1172. data/lib/ultracart_api/models/order_quote.rb +240 -205
  1173. data/lib/ultracart_api/models/order_replacement.rb +467 -432
  1174. data/lib/ultracart_api/models/order_replacement_item.rb +255 -220
  1175. data/lib/ultracart_api/models/order_replacement_response.rb +264 -229
  1176. data/lib/ultracart_api/models/order_response.rb +256 -221
  1177. data/lib/ultracart_api/models/order_salesforce.rb +220 -185
  1178. data/lib/ultracart_api/models/order_shipping.rb +770 -745
  1179. data/lib/ultracart_api/models/order_summary.rb +390 -355
  1180. data/lib/ultracart_api/models/order_tag.rb +235 -200
  1181. data/lib/ultracart_api/models/order_taxes.rb +395 -360
  1182. data/lib/ultracart_api/models/order_token_response.rb +257 -222
  1183. data/lib/ultracart_api/models/order_tracking_number_detail.rb +320 -285
  1184. data/lib/ultracart_api/models/order_tracking_number_details.rb +374 -339
  1185. data/lib/ultracart_api/models/orders_response.rb +259 -224
  1186. data/lib/ultracart_api/models/permission.rb +240 -205
  1187. data/lib/ultracart_api/models/pricing_tier.rb +533 -518
  1188. data/lib/ultracart_api/models/pricing_tier_notification.rb +270 -235
  1189. data/lib/ultracart_api/models/pricing_tiers_response.rb +259 -224
  1190. data/lib/ultracart_api/models/property.rb +228 -193
  1191. data/lib/ultracart_api/models/publish_library_item_request.rb +220 -185
  1192. data/lib/ultracart_api/models/register_affiliate_click_request.rb +270 -235
  1193. data/lib/ultracart_api/models/register_affiliate_click_response.rb +254 -219
  1194. data/lib/ultracart_api/models/response_metadata.rb +229 -194
  1195. data/lib/ultracart_api/models/result_set.rb +270 -235
  1196. data/lib/ultracart_api/models/screen_recording.rb +688 -653
  1197. data/lib/ultracart_api/models/screen_recording_ad_platform.rb +280 -245
  1198. data/lib/ultracart_api/models/screen_recording_filter.rb +758 -723
  1199. data/lib/ultracart_api/models/screen_recording_filter_geo_distance.rb +255 -220
  1200. data/lib/ultracart_api/models/screen_recording_filter_ip_search.rb +246 -211
  1201. data/lib/ultracart_api/models/screen_recording_filter_page_view.rb +369 -334
  1202. data/lib/ultracart_api/models/screen_recording_filter_page_view_event.rb +230 -195
  1203. data/lib/ultracart_api/models/screen_recording_filter_page_view_event_param.rb +255 -220
  1204. data/lib/ultracart_api/models/screen_recording_filter_page_view_param.rb +228 -193
  1205. data/lib/ultracart_api/models/screen_recording_filter_page_view_referrer_param.rb +228 -193
  1206. data/lib/ultracart_api/models/screen_recording_filter_range_big_decimal.rb +255 -220
  1207. data/lib/ultracart_api/models/screen_recording_filter_range_date.rb +230 -195
  1208. data/lib/ultracart_api/models/screen_recording_filter_range_integer.rb +255 -220
  1209. data/lib/ultracart_api/models/screen_recording_filter_string_search.rb +255 -220
  1210. data/lib/ultracart_api/models/screen_recording_filter_values.rb +435 -400
  1211. data/lib/ultracart_api/models/screen_recording_filter_values_event.rb +230 -195
  1212. data/lib/ultracart_api/models/screen_recording_filter_values_event_params.rb +263 -228
  1213. data/lib/ultracart_api/models/screen_recording_filter_values_page_param.rb +230 -195
  1214. data/lib/ultracart_api/models/screen_recording_filter_values_page_view.rb +272 -237
  1215. data/lib/ultracart_api/models/screen_recording_heatmap.rb +426 -391
  1216. data/lib/ultracart_api/models/screen_recording_heatmap_index_request.rb +219 -184
  1217. data/lib/ultracart_api/models/screen_recording_heatmap_index_response.rb +258 -223
  1218. data/lib/ultracart_api/models/screen_recording_heatmap_request.rb +239 -204
  1219. data/lib/ultracart_api/models/screen_recording_heatmap_reset.rb +219 -184
  1220. data/lib/ultracart_api/models/screen_recording_heatmap_response.rb +256 -221
  1221. data/lib/ultracart_api/models/screen_recording_heatmap_url.rb +266 -231
  1222. data/lib/ultracart_api/models/screen_recording_merchant_notes_request.rb +219 -184
  1223. data/lib/ultracart_api/models/screen_recording_multifield.rb +255 -220
  1224. data/lib/ultracart_api/models/screen_recording_page_view.rb +391 -356
  1225. data/lib/ultracart_api/models/screen_recording_page_view_data_response.rb +256 -221
  1226. data/lib/ultracart_api/models/screen_recording_page_view_event.rb +267 -232
  1227. data/lib/ultracart_api/models/screen_recording_page_view_event_parameter.rb +228 -193
  1228. data/lib/ultracart_api/models/screen_recording_page_view_parameter.rb +228 -193
  1229. data/lib/ultracart_api/models/screen_recording_query_request.rb +219 -184
  1230. data/lib/ultracart_api/models/screen_recording_query_response.rb +314 -279
  1231. data/lib/ultracart_api/models/screen_recording_response.rb +265 -230
  1232. data/lib/ultracart_api/models/screen_recording_segment.rb +302 -267
  1233. data/lib/ultracart_api/models/screen_recording_segment_response.rb +256 -221
  1234. data/lib/ultracart_api/models/screen_recording_segments_response.rb +258 -223
  1235. data/lib/ultracart_api/models/screen_recording_settings.rb +284 -249
  1236. data/lib/ultracart_api/models/screen_recording_settings_response.rb +256 -221
  1237. data/lib/ultracart_api/models/screen_recording_store_front.rb +228 -193
  1238. data/lib/ultracart_api/models/screen_recording_tags_request.rb +221 -186
  1239. data/lib/ultracart_api/models/screen_recording_tags_response.rb +258 -223
  1240. data/lib/ultracart_api/models/screen_recording_user_agent.rb +255 -220
  1241. data/lib/ultracart_api/models/screen_recording_user_agent_device.rb +219 -184
  1242. data/lib/ultracart_api/models/screen_recording_user_agent_os.rb +237 -202
  1243. data/lib/ultracart_api/models/screen_recording_user_property.rb +228 -193
  1244. data/lib/ultracart_api/models/screenshots_response.rb +259 -224
  1245. data/lib/ultracart_api/models/self_config.rb +220 -185
  1246. data/lib/ultracart_api/models/simple_value.rb +230 -195
  1247. data/lib/ultracart_api/models/single_sign_on_authorize_request.rb +230 -195
  1248. data/lib/ultracart_api/models/single_sign_on_authorize_response.rb +230 -195
  1249. data/lib/ultracart_api/models/single_sign_on_token_request.rb +230 -195
  1250. data/lib/ultracart_api/models/single_sign_on_token_response.rb +240 -205
  1251. data/lib/ultracart_api/models/sovos_config.rb +280 -245
  1252. data/lib/ultracart_api/models/state_province.rb +245 -210
  1253. data/lib/ultracart_api/models/step_waiting.rb +228 -193
  1254. data/lib/ultracart_api/models/tax_city.rb +302 -267
  1255. data/lib/ultracart_api/models/tax_country.rb +302 -267
  1256. data/lib/ultracart_api/models/tax_country_code.rb +260 -225
  1257. data/lib/ultracart_api/models/tax_county.rb +312 -277
  1258. data/lib/ultracart_api/models/tax_jar_config.rb +280 -245
  1259. data/lib/ultracart_api/models/tax_postal_code.rb +280 -245
  1260. data/lib/ultracart_api/models/tax_provider_activate_result.rb +229 -194
  1261. data/lib/ultracart_api/models/tax_provider_avalara.rb +249 -214
  1262. data/lib/ultracart_api/models/tax_provider_avalara_companies_result.rb +222 -187
  1263. data/lib/ultracart_api/models/tax_provider_avalara_company.rb +260 -225
  1264. data/lib/ultracart_api/models/tax_provider_self.rb +261 -226
  1265. data/lib/ultracart_api/models/tax_provider_self_countries_response.rb +222 -187
  1266. data/lib/ultracart_api/models/tax_provider_self_regions_response.rb +222 -187
  1267. data/lib/ultracart_api/models/tax_provider_sovos.rb +249 -214
  1268. data/lib/ultracart_api/models/tax_provider_tax_jar.rb +249 -214
  1269. data/lib/ultracart_api/models/tax_provider_test_result.rb +229 -194
  1270. data/lib/ultracart_api/models/tax_provider_ultra_cart.rb +261 -226
  1271. data/lib/ultracart_api/models/tax_provider_ultra_cart_state.rb +310 -275
  1272. data/lib/ultracart_api/models/tax_providers_response.rb +292 -257
  1273. data/lib/ultracart_api/models/tax_state.rb +392 -357
  1274. data/lib/ultracart_api/models/tax_state_code.rb +260 -225
  1275. data/lib/ultracart_api/models/temp_multimedia.rb +329 -294
  1276. data/lib/ultracart_api/models/temp_multimedia_response.rb +256 -221
  1277. data/lib/ultracart_api/models/thumbnail_parameters_request.rb +255 -220
  1278. data/lib/ultracart_api/models/thumbnail_parameters_response.rb +257 -222
  1279. data/lib/ultracart_api/models/transaction_email.rb +414 -379
  1280. data/lib/ultracart_api/models/transaction_email_list_response.rb +258 -223
  1281. data/lib/ultracart_api/models/transaction_email_option.rb +282 -247
  1282. data/lib/ultracart_api/models/transaction_email_response.rb +256 -221
  1283. data/lib/ultracart_api/models/twilio.rb +248 -213
  1284. data/lib/ultracart_api/models/twilio_response.rb +265 -230
  1285. data/lib/ultracart_api/models/twilios_response.rb +258 -223
  1286. data/lib/ultracart_api/models/ultra_cart_config.rb +220 -185
  1287. data/lib/ultracart_api/models/upload_coupon_codes_request.rb +259 -224
  1288. data/lib/ultracart_api/models/upload_coupon_codes_response.rb +283 -248
  1289. data/lib/ultracart_api/models/user.rb +377 -342
  1290. data/lib/ultracart_api/models/user_group_membership.rb +240 -205
  1291. data/lib/ultracart_api/models/user_login.rb +250 -215
  1292. data/lib/ultracart_api/models/user_logins_response.rb +259 -224
  1293. data/lib/ultracart_api/models/user_response.rb +256 -221
  1294. data/lib/ultracart_api/models/users_response.rb +258 -223
  1295. data/lib/ultracart_api/models/verification_record.rb +237 -202
  1296. data/lib/ultracart_api/models/warning.rb +230 -195
  1297. data/lib/ultracart_api/models/webhook.rb +437 -412
  1298. data/lib/ultracart_api/models/webhook_event_category.rb +264 -229
  1299. data/lib/ultracart_api/models/webhook_event_subscription.rb +300 -265
  1300. data/lib/ultracart_api/models/webhook_log.rb +324 -289
  1301. data/lib/ultracart_api/models/webhook_log_response.rb +256 -221
  1302. data/lib/ultracart_api/models/webhook_log_summaries_response.rb +259 -224
  1303. data/lib/ultracart_api/models/webhook_log_summary.rb +240 -205
  1304. data/lib/ultracart_api/models/webhook_response.rb +256 -221
  1305. data/lib/ultracart_api/models/webhook_sample_request.rb +252 -217
  1306. data/lib/ultracart_api/models/webhook_sample_request_response.rb +256 -221
  1307. data/lib/ultracart_api/models/webhooks_response.rb +258 -223
  1308. data/lib/ultracart_api/models/weight.rb +264 -229
  1309. data/lib/ultracart_api/version.rb +15 -15
  1310. data/lib/ultracart_api.rb +689 -836
  1311. data/spec/api_client_spec.rb +226 -243
  1312. data/spec/configuration_spec.rb +42 -42
  1313. data/spec/spec_helper.rb +111 -111
  1314. data/ultracart_api.gemspec +38 -46
  1315. metadata +5 -459
  1316. data/docs/AccountsReceivableRetryTransactionReject.md +0 -9
  1317. data/docs/AutoOrderAddonItem.md +0 -13
  1318. data/docs/AutoOrderAddonItemOption.md +0 -9
  1319. data/docs/AutoOrderManagement.md +0 -8
  1320. data/docs/CartItemProperty.md +0 -11
  1321. data/docs/ChannelPartner.md +0 -15
  1322. data/docs/ChannelPartnerShipToPreference.md +0 -14
  1323. data/docs/ChannelPartnerShipToPreferenceResponse.md +0 -12
  1324. data/docs/ChannelPartnerShipToPreferencesResponse.md +0 -12
  1325. data/docs/ChannelPartnersResponse.md +0 -12
  1326. data/docs/Conversation.md +0 -26
  1327. data/docs/ConversationAgentAuth.md +0 -13
  1328. data/docs/ConversationAgentAuthResponse.md +0 -12
  1329. data/docs/ConversationAgentProfile.md +0 -14
  1330. data/docs/ConversationAgentProfileResponse.md +0 -12
  1331. data/docs/ConversationApi.md +0 -1768
  1332. data/docs/ConversationAutocompleteRequest.md +0 -9
  1333. data/docs/ConversationAutocompleteResponse.md +0 -14
  1334. data/docs/ConversationAutocompleteValue.md +0 -9
  1335. data/docs/ConversationCannedMessage.md +0 -11
  1336. data/docs/ConversationCannedMessageResponse.md +0 -12
  1337. data/docs/ConversationCannedMessagesResponse.md +0 -12
  1338. data/docs/ConversationCannedMessagesSearch.md +0 -9
  1339. data/docs/ConversationDepartment.md +0 -12
  1340. data/docs/ConversationDepartmentMember.md +0 -10
  1341. data/docs/ConversationDepartmentMembersResponse.md +0 -12
  1342. data/docs/ConversationDepartmentResponse.md +0 -12
  1343. data/docs/ConversationDepartmentSettings.md +0 -7
  1344. data/docs/ConversationDepartmentsResponse.md +0 -12
  1345. data/docs/ConversationEngagement.md +0 -16
  1346. data/docs/ConversationEngagementEquation.md +0 -8
  1347. data/docs/ConversationEngagementEquationFunction.md +0 -21
  1348. data/docs/ConversationEngagementEquationGroup.md +0 -8
  1349. data/docs/ConversationEngagementResponse.md +0 -12
  1350. data/docs/ConversationEngagementsResponse.md +0 -12
  1351. data/docs/ConversationEventAddCoupon.md +0 -10
  1352. data/docs/ConversationEventAddItem.md +0 -10
  1353. data/docs/ConversationEventQueuePosition.md +0 -9
  1354. data/docs/ConversationEventRRWeb.md +0 -14
  1355. data/docs/ConversationEventReadMessage.md +0 -10
  1356. data/docs/ConversationEventTyping.md +0 -10
  1357. data/docs/ConversationEventWebchatContext.md +0 -10
  1358. data/docs/ConversationJoinRequest.md +0 -8
  1359. data/docs/ConversationLocationCountry.md +0 -10
  1360. data/docs/ConversationLocationStateProvince.md +0 -9
  1361. data/docs/ConversationLocationsResponse.md +0 -12
  1362. data/docs/ConversationMessage.md +0 -22
  1363. data/docs/ConversationMessageTranslation.md +0 -9
  1364. data/docs/ConversationMessageTransportStatus.md +0 -9
  1365. data/docs/ConversationMessagesResponse.md +0 -12
  1366. data/docs/ConversationMultimediaUploadUrl.md +0 -9
  1367. data/docs/ConversationMultimediaUploadUrlResponse.md +0 -12
  1368. data/docs/ConversationParticipant.md +0 -20
  1369. data/docs/ConversationPermissions.md +0 -8
  1370. data/docs/ConversationPermissionsResponse.md +0 -12
  1371. data/docs/ConversationResponse.md +0 -12
  1372. data/docs/ConversationSearchRequest.md +0 -19
  1373. data/docs/ConversationSearchResponse.md +0 -11
  1374. data/docs/ConversationSentiment.md +0 -13
  1375. data/docs/ConversationStartRequest.md +0 -10
  1376. data/docs/ConversationStartResponse.md +0 -8
  1377. data/docs/ConversationSummary.md +0 -24
  1378. data/docs/ConversationTwilioAccount.md +0 -9
  1379. data/docs/ConversationWebchatContext.md +0 -15
  1380. data/docs/ConversationWebchatQueueStatus.md +0 -22
  1381. data/docs/ConversationWebchatQueueStatusAgent.md +0 -13
  1382. data/docs/ConversationWebchatQueueStatusQueueEntry.md +0 -15
  1383. data/docs/ConversationWebchatQueueStatusUpdateRequest.md +0 -8
  1384. data/docs/ConversationWebchatQueueStatusesResponse.md +0 -12
  1385. data/docs/ConversationWebsocketMessage.md +0 -31
  1386. data/docs/ConversationsResponse.md +0 -12
  1387. data/docs/CouponMoreLoyaltyCashback.md +0 -8
  1388. data/docs/CouponMoreLoyaltyPoints.md +0 -8
  1389. data/docs/CouponNoDiscount.md +0 -8
  1390. data/docs/CouponPercentMoreLoyaltyCashback.md +0 -8
  1391. data/docs/CouponPercentMoreLoyaltyPoints.md +0 -8
  1392. data/docs/CouponTieredPercentOffSubtotalBasedOnMSRP.md +0 -9
  1393. data/docs/CustomerEDI.md +0 -10
  1394. data/docs/CustomerMagicLinkResponse.md +0 -12
  1395. data/docs/CustomerMergeRequest.md +0 -9
  1396. data/docs/DatawarehouseApi.md +0 -512
  1397. data/docs/EmailCommseqSequenceTestRequest.md +0 -22
  1398. data/docs/EmailCommseqSequenceTestResponse.md +0 -11
  1399. data/docs/EmailCommseqSmsSendTestRequest.md +0 -10
  1400. data/docs/EmailCommseqSmsSendTestResponse.md +0 -13
  1401. data/docs/EmailPostcardTracking.md +0 -32
  1402. data/docs/EmailPostcardTrackingResponse.md +0 -12
  1403. data/docs/FileManagerDirectory.md +0 -20
  1404. data/docs/FileManagerFile.md +0 -29
  1405. data/docs/FileManagerPage.md +0 -15
  1406. data/docs/FileManagerPageResponse.md +0 -12
  1407. data/docs/FileManagerUploadRequest.md +0 -10
  1408. data/docs/FileManagerUploadUrlResponse.md +0 -13
  1409. data/docs/HitPageView.md +0 -18
  1410. data/docs/HitPageViewMetaData.md +0 -9
  1411. data/docs/HitSessionStart.md +0 -24
  1412. data/docs/HitSessionUtm.md +0 -22
  1413. data/docs/ItemDigitalItemPdfMeta.md +0 -18
  1414. data/docs/ItemDigitalItemResponse.md +0 -12
  1415. data/docs/ItemDigitalItemsResponse.md +0 -12
  1416. data/docs/ItemReview.md +0 -44
  1417. data/docs/ItemReviewResponse.md +0 -12
  1418. data/docs/ItemReviewsResponse.md +0 -12
  1419. data/docs/OrderEdiDocument.md +0 -21
  1420. data/docs/OrderEdiDocumentsResponse.md +0 -12
  1421. data/docs/OrderInvoiceResponse.md +0 -12
  1422. data/docs/OrderPaymentCreditCardDualVaulted.md +0 -10
  1423. data/docs/OrderPaymentCreditCardDualVaultedProperty.md +0 -9
  1424. data/docs/OrderPointOfSale.md +0 -10
  1425. data/docs/OrderReason.md +0 -10
  1426. data/docs/OrderRefundableResponse.md +0 -19
  1427. data/docs/OrderTransactionalMerchantNote.md +0 -11
  1428. data/docs/OrderUtm.md +0 -31
  1429. data/docs/PointOfSaleLocation.md +0 -17
  1430. data/docs/PointOfSaleReader.md +0 -16
  1431. data/docs/PointOfSaleRegister.md +0 -11
  1432. data/docs/Report.md +0 -18
  1433. data/docs/ReportAuth.md +0 -11
  1434. data/docs/ReportAuthResponse.md +0 -12
  1435. data/docs/ReportDataSet.md +0 -24
  1436. data/docs/ReportDataSetColumn.md +0 -13
  1437. data/docs/ReportDataSetPage.md +0 -17
  1438. data/docs/ReportDataSetPageResponse.md +0 -12
  1439. data/docs/ReportDataSetQuery.md +0 -19
  1440. data/docs/ReportDataSetResponse.md +0 -12
  1441. data/docs/ReportDataSetRow.md +0 -8
  1442. data/docs/ReportDataSetSchema.md +0 -10
  1443. data/docs/ReportDataSource.md +0 -14
  1444. data/docs/ReportDataSourceSchema.md +0 -11
  1445. data/docs/ReportDryRunQueriesRequest.md +0 -13
  1446. data/docs/ReportDryRunQueriesResponse.md +0 -8
  1447. data/docs/ReportDryRunQueryResult.md +0 -9
  1448. data/docs/ReportExecuteQueriesRequest.md +0 -15
  1449. data/docs/ReportFilter.md +0 -13
  1450. data/docs/ReportFilterConnection.md +0 -10
  1451. data/docs/ReportPage.md +0 -13
  1452. data/docs/ReportPageFilter.md +0 -11
  1453. data/docs/ReportPageVisualization.md +0 -17
  1454. data/docs/ReportPageVisualizationDimension.md +0 -14
  1455. data/docs/ReportPageVisualizationMetric.md +0 -11
  1456. data/docs/ReportResponse.md +0 -12
  1457. data/docs/ReportWebsocketEvent.md +0 -9
  1458. data/docs/ReportsResponse.md +0 -12
  1459. data/docs/RulerValidationRequest.md +0 -8
  1460. data/docs/RulerValidationResponse.md +0 -9
  1461. data/docs/StoreFront.md +0 -18
  1462. data/docs/StoreFrontsResponse.md +0 -12
  1463. data/lib/ultracart_api/api/conversation_api.rb +0 -1936
  1464. data/lib/ultracart_api/api/datawarehouse_api.rb +0 -584
  1465. data/lib/ultracart_api/models/accounts_receivable_retry_transaction_reject.rb +0 -195
  1466. data/lib/ultracart_api/models/auto_order_addon_item.rb +0 -232
  1467. data/lib/ultracart_api/models/auto_order_addon_item_option.rb +0 -225
  1468. data/lib/ultracart_api/models/auto_order_management.rb +0 -185
  1469. data/lib/ultracart_api/models/cart_item_property.rb +0 -245
  1470. data/lib/ultracart_api/models/channel_partner.rb +0 -255
  1471. data/lib/ultracart_api/models/channel_partner_ship_to_preference.rb +0 -262
  1472. data/lib/ultracart_api/models/channel_partner_ship_to_preference_response.rb +0 -221
  1473. data/lib/ultracart_api/models/channel_partner_ship_to_preferences_response.rb +0 -224
  1474. data/lib/ultracart_api/models/channel_partners_response.rb +0 -224
  1475. data/lib/ultracart_api/models/conversation.rb +0 -390
  1476. data/lib/ultracart_api/models/conversation_agent_auth.rb +0 -231
  1477. data/lib/ultracart_api/models/conversation_agent_auth_response.rb +0 -221
  1478. data/lib/ultracart_api/models/conversation_agent_profile.rb +0 -279
  1479. data/lib/ultracart_api/models/conversation_agent_profile_response.rb +0 -221
  1480. data/lib/ultracart_api/models/conversation_autocomplete_request.rb +0 -193
  1481. data/lib/ultracart_api/models/conversation_autocomplete_response.rb +0 -241
  1482. data/lib/ultracart_api/models/conversation_autocomplete_value.rb +0 -193
  1483. data/lib/ultracart_api/models/conversation_canned_message.rb +0 -213
  1484. data/lib/ultracart_api/models/conversation_canned_message_response.rb +0 -221
  1485. data/lib/ultracart_api/models/conversation_canned_messages_response.rb +0 -223
  1486. data/lib/ultracart_api/models/conversation_canned_messages_search.rb +0 -193
  1487. data/lib/ultracart_api/models/conversation_department.rb +0 -222
  1488. data/lib/ultracart_api/models/conversation_department_member.rb +0 -202
  1489. data/lib/ultracart_api/models/conversation_department_members_response.rb +0 -223
  1490. data/lib/ultracart_api/models/conversation_department_response.rb +0 -221
  1491. data/lib/ultracart_api/models/conversation_department_settings.rb +0 -175
  1492. data/lib/ultracart_api/models/conversation_departments_response.rb +0 -223
  1493. data/lib/ultracart_api/models/conversation_engagement.rb +0 -293
  1494. data/lib/ultracart_api/models/conversation_engagement_equation.rb +0 -186
  1495. data/lib/ultracart_api/models/conversation_engagement_equation_function.rb +0 -414
  1496. data/lib/ultracart_api/models/conversation_engagement_equation_group.rb +0 -186
  1497. data/lib/ultracart_api/models/conversation_engagement_response.rb +0 -221
  1498. data/lib/ultracart_api/models/conversation_engagements_response.rb +0 -223
  1499. data/lib/ultracart_api/models/conversation_event_add_coupon.rb +0 -202
  1500. data/lib/ultracart_api/models/conversation_event_add_item.rb +0 -204
  1501. data/lib/ultracart_api/models/conversation_event_queue_position.rb +0 -195
  1502. data/lib/ultracart_api/models/conversation_event_read_message.rb +0 -203
  1503. data/lib/ultracart_api/models/conversation_event_rr_web.rb +0 -273
  1504. data/lib/ultracart_api/models/conversation_event_typing.rb +0 -202
  1505. data/lib/ultracart_api/models/conversation_event_webchat_context.rb +0 -202
  1506. data/lib/ultracart_api/models/conversation_join_request.rb +0 -184
  1507. data/lib/ultracart_api/models/conversation_location_country.rb +0 -204
  1508. data/lib/ultracart_api/models/conversation_location_state_province.rb +0 -193
  1509. data/lib/ultracart_api/models/conversation_locations_response.rb +0 -223
  1510. data/lib/ultracart_api/models/conversation_message.rb +0 -356
  1511. data/lib/ultracart_api/models/conversation_message_translation.rb +0 -193
  1512. data/lib/ultracart_api/models/conversation_message_transport_status.rb +0 -228
  1513. data/lib/ultracart_api/models/conversation_messages_response.rb +0 -223
  1514. data/lib/ultracart_api/models/conversation_multimedia_upload_url.rb +0 -193
  1515. data/lib/ultracart_api/models/conversation_multimedia_upload_url_response.rb +0 -221
  1516. data/lib/ultracart_api/models/conversation_participant.rb +0 -295
  1517. data/lib/ultracart_api/models/conversation_permissions.rb +0 -184
  1518. data/lib/ultracart_api/models/conversation_permissions_response.rb +0 -221
  1519. data/lib/ultracart_api/models/conversation_response.rb +0 -221
  1520. data/lib/ultracart_api/models/conversation_search_request.rb +0 -285
  1521. data/lib/ultracart_api/models/conversation_search_response.rb +0 -213
  1522. data/lib/ultracart_api/models/conversation_sentiment.rb +0 -269
  1523. data/lib/ultracart_api/models/conversation_start_request.rb +0 -204
  1524. data/lib/ultracart_api/models/conversation_start_response.rb +0 -184
  1525. data/lib/ultracart_api/models/conversation_summary.rb +0 -369
  1526. data/lib/ultracart_api/models/conversation_twilio_account.rb +0 -195
  1527. data/lib/ultracart_api/models/conversation_webchat_context.rb +0 -254
  1528. data/lib/ultracart_api/models/conversation_webchat_queue_status.rb +0 -315
  1529. data/lib/ultracart_api/models/conversation_webchat_queue_status_agent.rb +0 -266
  1530. data/lib/ultracart_api/models/conversation_webchat_queue_status_queue_entry.rb +0 -248
  1531. data/lib/ultracart_api/models/conversation_webchat_queue_status_update_request.rb +0 -219
  1532. data/lib/ultracart_api/models/conversation_webchat_queue_statuses_response.rb +0 -223
  1533. data/lib/ultracart_api/models/conversation_websocket_message.rb +0 -441
  1534. data/lib/ultracart_api/models/conversations_response.rb +0 -223
  1535. data/lib/ultracart_api/models/coupon_more_loyalty_cashback.rb +0 -185
  1536. data/lib/ultracart_api/models/coupon_more_loyalty_points.rb +0 -185
  1537. data/lib/ultracart_api/models/coupon_no_discount.rb +0 -185
  1538. data/lib/ultracart_api/models/coupon_percent_more_loyalty_cashback.rb +0 -185
  1539. data/lib/ultracart_api/models/coupon_percent_more_loyalty_points.rb +0 -185
  1540. data/lib/ultracart_api/models/coupon_tiered_percent_off_subtotal_based_on_msrp.rb +0 -199
  1541. data/lib/ultracart_api/models/customer_edi.rb +0 -205
  1542. data/lib/ultracart_api/models/customer_magic_link_response.rb +0 -222
  1543. data/lib/ultracart_api/models/customer_merge_request.rb +0 -195
  1544. data/lib/ultracart_api/models/email_commseq_sequence_test_request.rb +0 -312
  1545. data/lib/ultracart_api/models/email_commseq_sequence_test_response.rb +0 -212
  1546. data/lib/ultracart_api/models/email_commseq_sms_send_test_request.rb +0 -202
  1547. data/lib/ultracart_api/models/email_commseq_sms_send_test_response.rb +0 -232
  1548. data/lib/ultracart_api/models/email_postcard_tracking.rb +0 -404
  1549. data/lib/ultracart_api/models/email_postcard_tracking_response.rb +0 -221
  1550. data/lib/ultracart_api/models/file_manager_directory.rb +0 -292
  1551. data/lib/ultracart_api/models/file_manager_file.rb +0 -376
  1552. data/lib/ultracart_api/models/file_manager_page.rb +0 -253
  1553. data/lib/ultracart_api/models/file_manager_page_response.rb +0 -221
  1554. data/lib/ultracart_api/models/file_manager_upload_request.rb +0 -202
  1555. data/lib/ultracart_api/models/file_manager_upload_url_response.rb +0 -230
  1556. data/lib/ultracart_api/models/hit_page_view.rb +0 -276
  1557. data/lib/ultracart_api/models/hit_page_view_meta_data.rb +0 -193
  1558. data/lib/ultracart_api/models/hit_session_start.rb +0 -328
  1559. data/lib/ultracart_api/models/hit_session_utm.rb +0 -310
  1560. data/lib/ultracart_api/models/item_digital_item_pdf_meta.rb +0 -315
  1561. data/lib/ultracart_api/models/item_digital_item_response.rb +0 -221
  1562. data/lib/ultracart_api/models/item_digital_items_response.rb +0 -224
  1563. data/lib/ultracart_api/models/item_review.rb +0 -801
  1564. data/lib/ultracart_api/models/item_review_response.rb +0 -221
  1565. data/lib/ultracart_api/models/item_reviews_response.rb +0 -224
  1566. data/lib/ultracart_api/models/order_edi_document.rb +0 -337
  1567. data/lib/ultracart_api/models/order_edi_documents_response.rb +0 -224
  1568. data/lib/ultracart_api/models/order_invoice_response.rb +0 -222
  1569. data/lib/ultracart_api/models/order_payment_credit_card_dual_vaulted.rb +0 -204
  1570. data/lib/ultracart_api/models/order_payment_credit_card_dual_vaulted_property.rb +0 -193
  1571. data/lib/ultracart_api/models/order_point_of_sale.rb +0 -202
  1572. data/lib/ultracart_api/models/order_reason.rb +0 -205
  1573. data/lib/ultracart_api/models/order_refundable_response.rb +0 -300
  1574. data/lib/ultracart_api/models/order_transactional_merchant_note.rb +0 -215
  1575. data/lib/ultracart_api/models/order_utm.rb +0 -392
  1576. data/lib/ultracart_api/models/point_of_sale_location.rb +0 -290
  1577. data/lib/ultracart_api/models/point_of_sale_reader.rb +0 -299
  1578. data/lib/ultracart_api/models/point_of_sale_register.rb +0 -215
  1579. data/lib/ultracart_api/models/report.rb +0 -317
  1580. data/lib/ultracart_api/models/report_auth.rb +0 -212
  1581. data/lib/ultracart_api/models/report_auth_response.rb +0 -221
  1582. data/lib/ultracart_api/models/report_data_set.rb +0 -381
  1583. data/lib/ultracart_api/models/report_data_set_column.rb +0 -229
  1584. data/lib/ultracart_api/models/report_data_set_page.rb +0 -273
  1585. data/lib/ultracart_api/models/report_data_set_page_response.rb +0 -221
  1586. data/lib/ultracart_api/models/report_data_set_query.rb +0 -330
  1587. data/lib/ultracart_api/models/report_data_set_response.rb +0 -221
  1588. data/lib/ultracart_api/models/report_data_set_row.rb +0 -186
  1589. data/lib/ultracart_api/models/report_data_set_schema.rb +0 -238
  1590. data/lib/ultracart_api/models/report_data_source.rb +0 -242
  1591. data/lib/ultracart_api/models/report_data_source_schema.rb +0 -248
  1592. data/lib/ultracart_api/models/report_dry_run_queries_request.rb +0 -231
  1593. data/lib/ultracart_api/models/report_dry_run_queries_response.rb +0 -186
  1594. data/lib/ultracart_api/models/report_dry_run_query_result.rb +0 -193
  1595. data/lib/ultracart_api/models/report_execute_queries_request.rb +0 -288
  1596. data/lib/ultracart_api/models/report_filter.rb +0 -272
  1597. data/lib/ultracart_api/models/report_filter_connection.rb +0 -203
  1598. data/lib/ultracart_api/models/report_page.rb +0 -237
  1599. data/lib/ultracart_api/models/report_page_filter.rb +0 -214
  1600. data/lib/ultracart_api/models/report_page_visualization.rb +0 -309
  1601. data/lib/ultracart_api/models/report_page_visualization_dimension.rb +0 -244
  1602. data/lib/ultracart_api/models/report_page_visualization_metric.rb +0 -248
  1603. data/lib/ultracart_api/models/report_response.rb +0 -221
  1604. data/lib/ultracart_api/models/report_websocket_event.rb +0 -228
  1605. data/lib/ultracart_api/models/reports_response.rb +0 -223
  1606. data/lib/ultracart_api/models/ruler_validation_request.rb +0 -184
  1607. data/lib/ultracart_api/models/ruler_validation_response.rb +0 -193
  1608. data/lib/ultracart_api/models/store_front.rb +0 -274
  1609. data/lib/ultracart_api/models/store_fronts_response.rb +0 -223
data/docs/OrderApi.md CHANGED
@@ -1,1469 +1,1856 @@
1
- # UltracartClient::OrderApi
2
-
3
- All URIs are relative to *https://secure.ultracart.com/rest/v2*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**adjust_order_total**](OrderApi.md#adjust_order_total) | **POST** /order/orders/{order_id}/adjust_order_total/{desired_total} | Adjusts an order total
8
- [**cancel_order**](OrderApi.md#cancel_order) | **POST** /order/orders/{order_id}/cancel | Cancel an order
9
- [**delete_order**](OrderApi.md#delete_order) | **DELETE** /order/orders/{order_id} | Delete an order
10
- [**duplicate_order**](OrderApi.md#duplicate_order) | **POST** /order/orders/{order_id}/duplicate | Duplicate an order
11
- [**format**](OrderApi.md#format) | **POST** /order/orders/{order_id}/format | Format order
12
- [**generate_invoice**](OrderApi.md#generate_invoice) | **GET** /order/orders/{order_id}/invoice | Generate an invoice for this order.
13
- [**generate_order_token**](OrderApi.md#generate_order_token) | **GET** /order/orders/token/{order_id} | Generate an order token for a given order id
14
- [**generate_packing_slip_all_dc**](OrderApi.md#generate_packing_slip_all_dc) | **GET** /order/orders/{order_id}/packing_slip | Generate a packing slip for this order across all distribution centers.
15
- [**generate_packing_slip_specific_dc**](OrderApi.md#generate_packing_slip_specific_dc) | **GET** /order/orders/{order_id}/packing_slip/{distribution_center_code} | Generate a packing slip for this order for the given distribution center.
16
- [**get_accounts_receivable_retry_config**](OrderApi.md#get_accounts_receivable_retry_config) | **GET** /order/accountsReceivableRetryConfig | Retrieve A/R Retry Configuration
17
- [**get_accounts_receivable_retry_stats**](OrderApi.md#get_accounts_receivable_retry_stats) | **GET** /order/accountsReceivableRetryConfig/stats | Retrieve A/R Retry Statistics
18
- [**get_order**](OrderApi.md#get_order) | **GET** /order/orders/{order_id} | Retrieve an order
19
- [**get_order_by_token**](OrderApi.md#get_order_by_token) | **POST** /order/orders/token | Retrieve an order using a token
20
- [**get_order_edi_documents**](OrderApi.md#get_order_edi_documents) | **GET** /order/orders/{order_id}/edi | Retrieve EDI documents associated with this order.
21
- [**get_orders**](OrderApi.md#get_orders) | **GET** /order/orders | Retrieve orders
22
- [**get_orders_batch**](OrderApi.md#get_orders_batch) | **POST** /order/orders/batch | Retrieve order batch
23
- [**get_orders_by_query**](OrderApi.md#get_orders_by_query) | **POST** /order/orders/query | Retrieve orders by query
24
- [**insert_order**](OrderApi.md#insert_order) | **POST** /order/orders | Insert an order
25
- [**is_refundable_order**](OrderApi.md#is_refundable_order) | **GET** /order/orders/{order_id}/refundable | Determine if an order can be refunded
26
- [**process_payment**](OrderApi.md#process_payment) | **POST** /order/orders/{order_id}/process_payment | Process payment
27
- [**refund_order**](OrderApi.md#refund_order) | **PUT** /order/orders/{order_id}/refund | Refund an order
28
- [**replacement**](OrderApi.md#replacement) | **POST** /order/orders/{order_id}/replacement | Replacement order
29
- [**resend_receipt**](OrderApi.md#resend_receipt) | **POST** /order/orders/{order_id}/resend_receipt | Resend receipt
30
- [**resend_shipment_confirmation**](OrderApi.md#resend_shipment_confirmation) | **POST** /order/orders/{order_id}/resend_shipment_confirmation | Resend shipment confirmation
31
- [**update_accounts_receivable_retry_config**](OrderApi.md#update_accounts_receivable_retry_config) | **POST** /order/accountsReceivableRetryConfig | Update A/R Retry Configuration
32
- [**update_order**](OrderApi.md#update_order) | **PUT** /order/orders/{order_id} | Update an order
33
-
34
-
35
- # **adjust_order_total**
36
- > BaseResponse adjust_order_total(order_id, desired_total)
37
-
38
- Adjusts an order total
39
-
40
- Adjusts an order total. Adjusts individual items appropriately and considers taxes. Desired total should be provided in the same currency as the order and must be less than the current total and greater than zero. This call will change the order total. It returns true if the desired total is achieved. If the goal seeking algorithm falls short (usually by pennies), this method returns back false. View the merchant notes for the order for further details.
41
-
42
- ### Example
43
- ```ruby
44
- # load the gem
45
- require 'ultracart_api'
46
-
47
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
48
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
49
- api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
50
-
51
-
52
- order_id = 'order_id_example' # String | The order id to cancel.
53
-
54
- desired_total = 'desired_total_example' # String | The desired total with no formatting. example 123.45
55
-
56
-
57
- begin
58
- #Adjusts an order total
59
- result = api_instance.adjust_order_total(order_id, desired_total)
60
- p result
61
- rescue UltracartClient::ApiError => e
62
- puts "Exception when calling OrderApi->adjust_order_total: #{e}"
63
- end
64
- ```
65
-
66
- ### Parameters
67
-
68
- Name | Type | Description | Notes
69
- ------------- | ------------- | ------------- | -------------
70
- **order_id** | **String**| The order id to cancel. |
71
- **desired_total** | **String**| The desired total with no formatting. example 123.45 |
72
-
73
- ### Return type
74
-
75
- [**BaseResponse**](BaseResponse.md)
76
-
77
- ### Authorization
78
-
79
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
80
-
81
- ### HTTP request headers
82
-
83
- - **Content-Type**: application/json
84
- - **Accept**: application/json
85
-
86
-
87
-
88
- # **cancel_order**
89
- > BaseResponse cancel_order(order_id, opts)
90
-
91
- Cancel an order
92
-
93
- Cancel an order on the UltraCart account. If the success flag is false, then consult the error message for why it failed.
94
-
95
- ### Example
96
- ```ruby
97
- # load the gem
98
- require 'ultracart_api'
99
-
100
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
101
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
102
- api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
103
-
104
-
105
- order_id = 'order_id_example' # String | The order id to cancel.
106
-
107
- opts = {
108
- lock_self_ship_orders: true, # BOOLEAN | Flag to prevent a order shipping during a refund process
109
- skip_refund_and_hold: true # BOOLEAN | Skip refund and move order to Held Orders department
110
- }
111
-
112
- begin
113
- #Cancel an order
114
- result = api_instance.cancel_order(order_id, opts)
115
- p result
116
- rescue UltracartClient::ApiError => e
117
- puts "Exception when calling OrderApi->cancel_order: #{e}"
118
- end
119
- ```
120
-
121
- ### Parameters
122
-
123
- Name | Type | Description | Notes
124
- ------------- | ------------- | ------------- | -------------
125
- **order_id** | **String**| The order id to cancel. |
126
- **lock_self_ship_orders** | **BOOLEAN**| Flag to prevent a order shipping during a refund process | [optional]
127
- **skip_refund_and_hold** | **BOOLEAN**| Skip refund and move order to Held Orders department | [optional]
128
-
129
- ### Return type
130
-
131
- [**BaseResponse**](BaseResponse.md)
132
-
133
- ### Authorization
134
-
135
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
136
-
137
- ### HTTP request headers
138
-
139
- - **Content-Type**: application/json
140
- - **Accept**: application/json
141
-
142
-
143
-
144
- # **delete_order**
145
- > delete_order(order_id)
146
-
147
- Delete an order
148
-
149
- Delete an order on the UltraCart account.
150
-
151
- ### Example
152
- ```ruby
153
- # load the gem
154
- require 'ultracart_api'
155
-
156
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
157
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
158
- api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
159
-
160
-
161
- order_id = 'order_id_example' # String | The order id to delete.
162
-
163
-
164
- begin
165
- #Delete an order
166
- api_instance.delete_order(order_id)
167
- rescue UltracartClient::ApiError => e
168
- puts "Exception when calling OrderApi->delete_order: #{e}"
169
- end
170
- ```
171
-
172
- ### Parameters
173
-
174
- Name | Type | Description | Notes
175
- ------------- | ------------- | ------------- | -------------
176
- **order_id** | **String**| The order id to delete. |
177
-
178
- ### Return type
179
-
180
- nil (empty response body)
181
-
182
- ### Authorization
183
-
184
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
185
-
186
- ### HTTP request headers
187
-
188
- - **Content-Type**: application/json
189
- - **Accept**: application/json
190
-
191
-
192
-
193
- # **duplicate_order**
194
- > OrderResponse duplicate_order(order_id, opts)
195
-
196
- Duplicate an order
197
-
198
- Perform a duplicate of the specified order_id and return a new order located in Accounts Receivable.
199
-
200
- ### Example
201
- ```ruby
202
- # load the gem
203
- require 'ultracart_api'
204
-
205
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
206
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
207
- api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
208
-
209
-
210
- order_id = 'order_id_example' # String | The order id to duplicate.
211
-
212
- opts = {
213
- _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
214
- }
215
-
216
- begin
217
- #Duplicate an order
218
- result = api_instance.duplicate_order(order_id, opts)
219
- p result
220
- rescue UltracartClient::ApiError => e
221
- puts "Exception when calling OrderApi->duplicate_order: #{e}"
222
- end
223
- ```
224
-
225
- ### Parameters
226
-
227
- Name | Type | Description | Notes
228
- ------------- | ------------- | ------------- | -------------
229
- **order_id** | **String**| The order id to duplicate. |
230
- **_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
231
-
232
- ### Return type
233
-
234
- [**OrderResponse**](OrderResponse.md)
235
-
236
- ### Authorization
237
-
238
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
239
-
240
- ### HTTP request headers
241
-
242
- - **Content-Type**: application/json
243
- - **Accept**: application/json
244
-
245
-
246
-
247
- # **format**
248
- > OrderFormatResponse format(order_id, format_options)
249
-
250
- Format order
251
-
252
- Format the order for display at text or html
253
-
254
- ### Example
255
- ```ruby
256
- # load the gem
257
- require 'ultracart_api'
258
-
259
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
260
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
261
- api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
262
-
263
-
264
- order_id = 'order_id_example' # String | The order id to format
265
-
266
- format_options = UltracartClient::OrderFormat.new # OrderFormat | Format options
267
-
268
-
269
- begin
270
- #Format order
271
- result = api_instance.format(order_id, format_options)
272
- p result
273
- rescue UltracartClient::ApiError => e
274
- puts "Exception when calling OrderApi->format: #{e}"
275
- end
276
- ```
277
-
278
- ### Parameters
279
-
280
- Name | Type | Description | Notes
281
- ------------- | ------------- | ------------- | -------------
282
- **order_id** | **String**| The order id to format |
283
- **format_options** | [**OrderFormat**](OrderFormat.md)| Format options |
284
-
285
- ### Return type
286
-
287
- [**OrderFormatResponse**](OrderFormatResponse.md)
288
-
289
- ### Authorization
290
-
291
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
292
-
293
- ### HTTP request headers
294
-
295
- - **Content-Type**: application/json
296
- - **Accept**: application/json
297
-
298
-
299
-
300
- # **generate_invoice**
301
- > OrderInvoiceResponse generate_invoice(order_id)
302
-
303
- Generate an invoice for this order.
304
-
305
- The invoice PDF that is returned is base 64 encoded
306
-
307
- ### Example
308
- ```ruby
309
- # load the gem
310
- require 'ultracart_api'
311
-
312
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
313
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
314
- api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
315
-
316
-
317
- order_id = 'order_id_example' # String | Order ID
318
-
319
-
320
- begin
321
- #Generate an invoice for this order.
322
- result = api_instance.generate_invoice(order_id)
323
- p result
324
- rescue UltracartClient::ApiError => e
325
- puts "Exception when calling OrderApi->generate_invoice: #{e}"
326
- end
327
- ```
328
-
329
- ### Parameters
330
-
331
- Name | Type | Description | Notes
332
- ------------- | ------------- | ------------- | -------------
333
- **order_id** | **String**| Order ID |
334
-
335
- ### Return type
336
-
337
- [**OrderInvoiceResponse**](OrderInvoiceResponse.md)
338
-
339
- ### Authorization
340
-
341
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
342
-
343
- ### HTTP request headers
344
-
345
- - **Content-Type**: application/json
346
- - **Accept**: application/json
347
-
348
-
349
-
350
- # **generate_order_token**
351
- > OrderTokenResponse generate_order_token(order_id)
352
-
353
- Generate an order token for a given order id
354
-
355
- Retrieves a single order token for a given order id. The token can be used with the getOrderByToken API.
356
-
357
- ### Example
358
- ```ruby
359
- # load the gem
360
- require 'ultracart_api'
361
-
362
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
363
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
364
- api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
365
-
366
-
367
- order_id = 'order_id_example' # String | The order id to generate a token for.
368
-
369
-
370
- begin
371
- #Generate an order token for a given order id
372
- result = api_instance.generate_order_token(order_id)
373
- p result
374
- rescue UltracartClient::ApiError => e
375
- puts "Exception when calling OrderApi->generate_order_token: #{e}"
376
- end
377
- ```
378
-
379
- ### Parameters
380
-
381
- Name | Type | Description | Notes
382
- ------------- | ------------- | ------------- | -------------
383
- **order_id** | **String**| The order id to generate a token for. |
384
-
385
- ### Return type
386
-
387
- [**OrderTokenResponse**](OrderTokenResponse.md)
388
-
389
- ### Authorization
390
-
391
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
392
-
393
- ### HTTP request headers
394
-
395
- - **Content-Type**: application/json
396
- - **Accept**: application/json
397
-
398
-
399
-
400
- # **generate_packing_slip_all_dc**
401
- > OrderPackingSlipResponse generate_packing_slip_all_dc(order_id)
402
-
403
- Generate a packing slip for this order across all distribution centers.
404
-
405
- The packing slip PDF that is returned is base 64 encoded
406
-
407
- ### Example
408
- ```ruby
409
- # load the gem
410
- require 'ultracart_api'
411
-
412
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
413
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
414
- api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
415
-
416
-
417
- order_id = 'order_id_example' # String | Order ID
418
-
419
-
420
- begin
421
- #Generate a packing slip for this order across all distribution centers.
422
- result = api_instance.generate_packing_slip_all_dc(order_id)
423
- p result
424
- rescue UltracartClient::ApiError => e
425
- puts "Exception when calling OrderApi->generate_packing_slip_all_dc: #{e}"
426
- end
427
- ```
428
-
429
- ### Parameters
430
-
431
- Name | Type | Description | Notes
432
- ------------- | ------------- | ------------- | -------------
433
- **order_id** | **String**| Order ID |
434
-
435
- ### Return type
436
-
437
- [**OrderPackingSlipResponse**](OrderPackingSlipResponse.md)
438
-
439
- ### Authorization
440
-
441
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
442
-
443
- ### HTTP request headers
444
-
445
- - **Content-Type**: application/json
446
- - **Accept**: application/json
447
-
448
-
449
-
450
- # **generate_packing_slip_specific_dc**
451
- > OrderPackingSlipResponse generate_packing_slip_specific_dc(distribution_center_code, order_id)
452
-
453
- Generate a packing slip for this order for the given distribution center.
454
-
455
- The packing slip PDF that is returned is base 64 encoded
456
-
457
- ### Example
458
- ```ruby
459
- # load the gem
460
- require 'ultracart_api'
461
-
462
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
463
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
464
- api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
465
-
466
-
467
- distribution_center_code = 'distribution_center_code_example' # String | Distribution center code
468
-
469
- order_id = 'order_id_example' # String | Order ID
470
-
471
-
472
- begin
473
- #Generate a packing slip for this order for the given distribution center.
474
- result = api_instance.generate_packing_slip_specific_dc(distribution_center_code, order_id)
475
- p result
476
- rescue UltracartClient::ApiError => e
477
- puts "Exception when calling OrderApi->generate_packing_slip_specific_dc: #{e}"
478
- end
479
- ```
480
-
481
- ### Parameters
482
-
483
- Name | Type | Description | Notes
484
- ------------- | ------------- | ------------- | -------------
485
- **distribution_center_code** | **String**| Distribution center code |
486
- **order_id** | **String**| Order ID |
487
-
488
- ### Return type
489
-
490
- [**OrderPackingSlipResponse**](OrderPackingSlipResponse.md)
491
-
492
- ### Authorization
493
-
494
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
495
-
496
- ### HTTP request headers
497
-
498
- - **Content-Type**: application/json
499
- - **Accept**: application/json
500
-
501
-
502
-
503
- # **get_accounts_receivable_retry_config**
504
- > AccountsReceivableRetryConfigResponse get_accounts_receivable_retry_config
505
-
506
- Retrieve A/R Retry Configuration
507
-
508
- Retrieve A/R Retry Configuration. This is primarily an internal API call. It is doubtful you would ever need to use it.
509
-
510
- ### Example
511
- ```ruby
512
- # load the gem
513
- require 'ultracart_api'
514
-
515
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
516
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
517
- api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
518
-
519
-
520
-
521
- begin
522
- #Retrieve A/R Retry Configuration
523
- result = api_instance.get_accounts_receivable_retry_config
524
- p result
525
- rescue UltracartClient::ApiError => e
526
- puts "Exception when calling OrderApi->get_accounts_receivable_retry_config: #{e}"
527
- end
528
- ```
529
-
530
- ### Parameters
531
- This endpoint does not need any parameter.
532
-
533
- ### Return type
534
-
535
- [**AccountsReceivableRetryConfigResponse**](AccountsReceivableRetryConfigResponse.md)
536
-
537
- ### Authorization
538
-
539
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
540
-
541
- ### HTTP request headers
542
-
543
- - **Content-Type**: application/json
544
- - **Accept**: application/json
545
-
546
-
547
-
548
- # **get_accounts_receivable_retry_stats**
549
- > AccountsReceivableRetryStatsResponse get_accounts_receivable_retry_stats(opts)
550
-
551
- Retrieve A/R Retry Statistics
552
-
553
- Retrieve A/R Retry Statistics. This is primarily an internal API call. It is doubtful you would ever need to use it.
554
-
555
- ### Example
556
- ```ruby
557
- # load the gem
558
- require 'ultracart_api'
559
-
560
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
561
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
562
- api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
563
-
564
-
565
- opts = {
566
- from: 'from_example', # String |
567
- to: 'to_example' # String |
568
- }
569
-
570
- begin
571
- #Retrieve A/R Retry Statistics
572
- result = api_instance.get_accounts_receivable_retry_stats(opts)
573
- p result
574
- rescue UltracartClient::ApiError => e
575
- puts "Exception when calling OrderApi->get_accounts_receivable_retry_stats: #{e}"
576
- end
577
- ```
578
-
579
- ### Parameters
580
-
581
- Name | Type | Description | Notes
582
- ------------- | ------------- | ------------- | -------------
583
- **from** | **String**| | [optional]
584
- **to** | **String**| | [optional]
585
-
586
- ### Return type
587
-
588
- [**AccountsReceivableRetryStatsResponse**](AccountsReceivableRetryStatsResponse.md)
589
-
590
- ### Authorization
591
-
592
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
593
-
594
- ### HTTP request headers
595
-
596
- - **Content-Type**: application/json
597
- - **Accept**: application/json
598
-
599
-
600
-
601
- # **get_order**
602
- > OrderResponse get_order(order_id, opts)
603
-
604
- Retrieve an order
605
-
606
- Retrieves a single order using the specified order id.
607
-
608
- ### Example
609
- ```ruby
610
- # load the gem
611
- require 'ultracart_api'
612
-
613
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
614
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
615
- api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
616
-
617
-
618
- order_id = 'order_id_example' # String | The order id to retrieve.
619
-
620
- opts = {
621
- _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
622
- }
623
-
624
- begin
625
- #Retrieve an order
626
- result = api_instance.get_order(order_id, opts)
627
- p result
628
- rescue UltracartClient::ApiError => e
629
- puts "Exception when calling OrderApi->get_order: #{e}"
630
- end
631
- ```
632
-
633
- ### Parameters
634
-
635
- Name | Type | Description | Notes
636
- ------------- | ------------- | ------------- | -------------
637
- **order_id** | **String**| The order id to retrieve. |
638
- **_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
639
-
640
- ### Return type
641
-
642
- [**OrderResponse**](OrderResponse.md)
643
-
644
- ### Authorization
645
-
646
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
647
-
648
- ### HTTP request headers
649
-
650
- - **Content-Type**: application/json
651
- - **Accept**: application/json
652
-
653
-
654
-
655
- # **get_order_by_token**
656
- > OrderResponse get_order_by_token(order_by_token_query, opts)
657
-
658
- Retrieve an order using a token
659
-
660
- Retrieves a single order using the specified order token.
661
-
662
- ### Example
663
- ```ruby
664
- # load the gem
665
- require 'ultracart_api'
666
-
667
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
668
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
669
- api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
670
-
671
-
672
- order_by_token_query = UltracartClient::OrderByTokenQuery.new # OrderByTokenQuery | Order by token query
673
-
674
- opts = {
675
- _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
676
- }
677
-
678
- begin
679
- #Retrieve an order using a token
680
- result = api_instance.get_order_by_token(order_by_token_query, opts)
681
- p result
682
- rescue UltracartClient::ApiError => e
683
- puts "Exception when calling OrderApi->get_order_by_token: #{e}"
684
- end
685
- ```
686
-
687
- ### Parameters
688
-
689
- Name | Type | Description | Notes
690
- ------------- | ------------- | ------------- | -------------
691
- **order_by_token_query** | [**OrderByTokenQuery**](OrderByTokenQuery.md)| Order by token query |
692
- **_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
693
-
694
- ### Return type
695
-
696
- [**OrderResponse**](OrderResponse.md)
697
-
698
- ### Authorization
699
-
700
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
701
-
702
- ### HTTP request headers
703
-
704
- - **Content-Type**: application/json
705
- - **Accept**: application/json
706
-
707
-
708
-
709
- # **get_order_edi_documents**
710
- > OrderEdiDocumentsResponse get_order_edi_documents(order_id)
711
-
712
- Retrieve EDI documents associated with this order.
713
-
714
- Retrieve EDI documents associated with this order.
715
-
716
- ### Example
717
- ```ruby
718
- # load the gem
719
- require 'ultracart_api'
720
-
721
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
722
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
723
- api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
724
-
725
-
726
- order_id = 'order_id_example' # String | The order id to retrieve EDI documents for.
727
-
728
-
729
- begin
730
- #Retrieve EDI documents associated with this order.
731
- result = api_instance.get_order_edi_documents(order_id)
732
- p result
733
- rescue UltracartClient::ApiError => e
734
- puts "Exception when calling OrderApi->get_order_edi_documents: #{e}"
735
- end
736
- ```
737
-
738
- ### Parameters
739
-
740
- Name | Type | Description | Notes
741
- ------------- | ------------- | ------------- | -------------
742
- **order_id** | **String**| The order id to retrieve EDI documents for. |
743
-
744
- ### Return type
745
-
746
- [**OrderEdiDocumentsResponse**](OrderEdiDocumentsResponse.md)
747
-
748
- ### Authorization
749
-
750
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
751
-
752
- ### HTTP request headers
753
-
754
- - **Content-Type**: application/json; charset=UTF-8
755
- - **Accept**: application/json
756
-
757
-
758
-
759
- # **get_orders**
760
- > OrdersResponse get_orders(opts)
761
-
762
- Retrieve orders
763
-
764
- Retrieves a group of orders from the account. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
765
-
766
- ### Example
767
- ```ruby
768
- # load the gem
769
- require 'ultracart_api'
770
-
771
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
772
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
773
- api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
774
-
775
-
776
- opts = {
777
- order_id: 'order_id_example', # String | Order Id
778
- payment_method: 'payment_method_example', # String | Payment Method
779
- company: 'company_example', # String | Company
780
- first_name: 'first_name_example', # String | First Name
781
- last_name: 'last_name_example', # String | Last Name
782
- city: 'city_example', # String | City
783
- state_region: 'state_region_example', # String | State/Region
784
- postal_code: 'postal_code_example', # String | Postal Code
785
- country_code: 'country_code_example', # String | Country Code (ISO-3166 two letter)
786
- phone: 'phone_example', # String | Phone
787
- email: 'email_example', # String | Email
788
- cc_email: 'cc_email_example', # String | CC Email
789
- total: 8.14, # Float | Total
790
- screen_branding_theme_code: 'screen_branding_theme_code_example', # String | Screen Branding Theme Code
791
- storefront_host_name: 'storefront_host_name_example', # String | StoreFront Host Name
792
- creation_date_begin: 'creation_date_begin_example', # String | Creation Date Begin
793
- creation_date_end: 'creation_date_end_example', # String | Creation Date End
794
- payment_date_begin: 'payment_date_begin_example', # String | Payment Date Begin
795
- payment_date_end: 'payment_date_end_example', # String | Payment Date End
796
- shipment_date_begin: 'shipment_date_begin_example', # String | Shipment Date Begin
797
- shipment_date_end: 'shipment_date_end_example', # String | Shipment Date End
798
- rma: 'rma_example', # String | RMA
799
- purchase_order_number: 'purchase_order_number_example', # String | Purchase Order Number
800
- item_id: 'item_id_example', # String | Item Id
801
- current_stage: 'current_stage_example', # String | Current Stage
802
- channel_partner_code: 'channel_partner_code_example', # String | Channel Partner Code
803
- channel_partner_order_id: 'channel_partner_order_id_example', # String | Channel Partner Order ID
804
- _limit: 100, # Integer | The maximum number of records to return on this one API call. (Maximum 200)
805
- _offset: 0, # Integer | Pagination of the record set. Offset is a zero based index.
806
- _sort: '_sort_example', # String | The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
807
- _expand: '_expand_example' # String | The object expansion to perform on the result.
808
- }
809
-
810
- begin
811
- #Retrieve orders
812
- result = api_instance.get_orders(opts)
813
- p result
814
- rescue UltracartClient::ApiError => e
815
- puts "Exception when calling OrderApi->get_orders: #{e}"
816
- end
817
- ```
818
-
819
- ### Parameters
820
-
821
- Name | Type | Description | Notes
822
- ------------- | ------------- | ------------- | -------------
823
- **order_id** | **String**| Order Id | [optional]
824
- **payment_method** | **String**| Payment Method | [optional]
825
- **company** | **String**| Company | [optional]
826
- **first_name** | **String**| First Name | [optional]
827
- **last_name** | **String**| Last Name | [optional]
828
- **city** | **String**| City | [optional]
829
- **state_region** | **String**| State/Region | [optional]
830
- **postal_code** | **String**| Postal Code | [optional]
831
- **country_code** | **String**| Country Code (ISO-3166 two letter) | [optional]
832
- **phone** | **String**| Phone | [optional]
833
- **email** | **String**| Email | [optional]
834
- **cc_email** | **String**| CC Email | [optional]
835
- **total** | **Float**| Total | [optional]
836
- **screen_branding_theme_code** | **String**| Screen Branding Theme Code | [optional]
837
- **storefront_host_name** | **String**| StoreFront Host Name | [optional]
838
- **creation_date_begin** | **String**| Creation Date Begin | [optional]
839
- **creation_date_end** | **String**| Creation Date End | [optional]
840
- **payment_date_begin** | **String**| Payment Date Begin | [optional]
841
- **payment_date_end** | **String**| Payment Date End | [optional]
842
- **shipment_date_begin** | **String**| Shipment Date Begin | [optional]
843
- **shipment_date_end** | **String**| Shipment Date End | [optional]
844
- **rma** | **String**| RMA | [optional]
845
- **purchase_order_number** | **String**| Purchase Order Number | [optional]
846
- **item_id** | **String**| Item Id | [optional]
847
- **current_stage** | **String**| Current Stage | [optional]
848
- **channel_partner_code** | **String**| Channel Partner Code | [optional]
849
- **channel_partner_order_id** | **String**| Channel Partner Order ID | [optional]
850
- **_limit** | **Integer**| The maximum number of records to return on this one API call. (Maximum 200) | [optional] [default to 100]
851
- **_offset** | **Integer**| Pagination of the record set. Offset is a zero based index. | [optional] [default to 0]
852
- **_sort** | **String**| The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional]
853
- **_expand** | **String**| The object expansion to perform on the result. | [optional]
854
-
855
- ### Return type
856
-
857
- [**OrdersResponse**](OrdersResponse.md)
858
-
859
- ### Authorization
860
-
861
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
862
-
863
- ### HTTP request headers
864
-
865
- - **Content-Type**: application/json
866
- - **Accept**: application/json
867
-
868
-
869
-
870
- # **get_orders_batch**
871
- > OrdersResponse get_orders_batch(order_batch, opts)
872
-
873
- Retrieve order batch
874
-
875
- Retrieves a group of orders from the account based on an array of order ids. If more than 500 order ids are specified, the API call will fail with a bad request error.
876
-
877
- ### Example
878
- ```ruby
879
- # load the gem
880
- require 'ultracart_api'
881
-
882
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
883
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
884
- api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
885
-
886
-
887
- order_batch = UltracartClient::OrderQueryBatch.new # OrderQueryBatch | Order batch
888
-
889
- opts = {
890
- _expand: '_expand_example' # String | The object expansion to perform on the result.
891
- }
892
-
893
- begin
894
- #Retrieve order batch
895
- result = api_instance.get_orders_batch(order_batch, opts)
896
- p result
897
- rescue UltracartClient::ApiError => e
898
- puts "Exception when calling OrderApi->get_orders_batch: #{e}"
899
- end
900
- ```
901
-
902
- ### Parameters
903
-
904
- Name | Type | Description | Notes
905
- ------------- | ------------- | ------------- | -------------
906
- **order_batch** | [**OrderQueryBatch**](OrderQueryBatch.md)| Order batch |
907
- **_expand** | **String**| The object expansion to perform on the result. | [optional]
908
-
909
- ### Return type
910
-
911
- [**OrdersResponse**](OrdersResponse.md)
912
-
913
- ### Authorization
914
-
915
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
916
-
917
- ### HTTP request headers
918
-
919
- - **Content-Type**: application/json
920
- - **Accept**: application/json
921
-
922
-
923
-
924
- # **get_orders_by_query**
925
- > OrdersResponse get_orders_by_query(order_query, opts)
926
-
927
- Retrieve orders by query
928
-
929
- Retrieves a group of orders from the account based on a query object. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
930
-
931
- ### Example
932
- ```ruby
933
- # load the gem
934
- require 'ultracart_api'
935
-
936
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
937
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
938
- api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
939
-
940
-
941
- order_query = UltracartClient::OrderQuery.new # OrderQuery | Order query
942
-
943
- opts = {
944
- _limit: 100, # Integer | The maximum number of records to return on this one API call. (Maximum 200)
945
- _offset: 0, # Integer | Pagination of the record set. Offset is a zero based index.
946
- _sort: '_sort_example', # String | The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
947
- _expand: '_expand_example' # String | The object expansion to perform on the result.
948
- }
949
-
950
- begin
951
- #Retrieve orders by query
952
- result = api_instance.get_orders_by_query(order_query, opts)
953
- p result
954
- rescue UltracartClient::ApiError => e
955
- puts "Exception when calling OrderApi->get_orders_by_query: #{e}"
956
- end
957
- ```
958
-
959
- ### Parameters
960
-
961
- Name | Type | Description | Notes
962
- ------------- | ------------- | ------------- | -------------
963
- **order_query** | [**OrderQuery**](OrderQuery.md)| Order query |
964
- **_limit** | **Integer**| The maximum number of records to return on this one API call. (Maximum 200) | [optional] [default to 100]
965
- **_offset** | **Integer**| Pagination of the record set. Offset is a zero based index. | [optional] [default to 0]
966
- **_sort** | **String**| The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional]
967
- **_expand** | **String**| The object expansion to perform on the result. | [optional]
968
-
969
- ### Return type
970
-
971
- [**OrdersResponse**](OrdersResponse.md)
972
-
973
- ### Authorization
974
-
975
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
976
-
977
- ### HTTP request headers
978
-
979
- - **Content-Type**: application/json
980
- - **Accept**: application/json
981
-
982
-
983
-
984
- # **insert_order**
985
- > OrderResponse insert_order(order, opts)
986
-
987
- Insert an order
988
-
989
- Inserts a new order on the UltraCart account. This is probably NOT the method you want. This is for channel orders. For regular orders the customer is entering, use the CheckoutApi. It has many, many more features, checks, and validations.
990
-
991
- ### Example
992
- ```ruby
993
- # load the gem
994
- require 'ultracart_api'
995
-
996
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
997
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
998
- api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
999
-
1000
-
1001
- order = UltracartClient::Order.new # Order | Order to insert
1002
-
1003
- opts = {
1004
- _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
1005
- }
1006
-
1007
- begin
1008
- #Insert an order
1009
- result = api_instance.insert_order(order, opts)
1010
- p result
1011
- rescue UltracartClient::ApiError => e
1012
- puts "Exception when calling OrderApi->insert_order: #{e}"
1013
- end
1014
- ```
1015
-
1016
- ### Parameters
1017
-
1018
- Name | Type | Description | Notes
1019
- ------------- | ------------- | ------------- | -------------
1020
- **order** | [**Order**](Order.md)| Order to insert |
1021
- **_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
1022
-
1023
- ### Return type
1024
-
1025
- [**OrderResponse**](OrderResponse.md)
1026
-
1027
- ### Authorization
1028
-
1029
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1030
-
1031
- ### HTTP request headers
1032
-
1033
- - **Content-Type**: application/json; charset=UTF-8
1034
- - **Accept**: application/json
1035
-
1036
-
1037
-
1038
- # **is_refundable_order**
1039
- > OrderRefundableResponse is_refundable_order(order_id)
1040
-
1041
- Determine if an order can be refunded
1042
-
1043
- Determine if an order can be refunded based upon payment method and age
1044
-
1045
- ### Example
1046
- ```ruby
1047
- # load the gem
1048
- require 'ultracart_api'
1049
-
1050
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1051
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1052
- api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
1053
-
1054
-
1055
- order_id = 'order_id_example' # String | The order id to check for refundable order.
1056
-
1057
-
1058
- begin
1059
- #Determine if an order can be refunded
1060
- result = api_instance.is_refundable_order(order_id)
1061
- p result
1062
- rescue UltracartClient::ApiError => e
1063
- puts "Exception when calling OrderApi->is_refundable_order: #{e}"
1064
- end
1065
- ```
1066
-
1067
- ### Parameters
1068
-
1069
- Name | Type | Description | Notes
1070
- ------------- | ------------- | ------------- | -------------
1071
- **order_id** | **String**| The order id to check for refundable order. |
1072
-
1073
- ### Return type
1074
-
1075
- [**OrderRefundableResponse**](OrderRefundableResponse.md)
1076
-
1077
- ### Authorization
1078
-
1079
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1080
-
1081
- ### HTTP request headers
1082
-
1083
- - **Content-Type**: application/json; charset=UTF-8
1084
- - **Accept**: application/json
1085
-
1086
-
1087
-
1088
- # **process_payment**
1089
- > OrderProcessPaymentResponse process_payment(order_id, process_payment_request)
1090
-
1091
- Process payment
1092
-
1093
- Process payment on order
1094
-
1095
- ### Example
1096
- ```ruby
1097
- # load the gem
1098
- require 'ultracart_api'
1099
-
1100
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1101
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1102
- api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
1103
-
1104
-
1105
- order_id = 'order_id_example' # String | The order id to process payment on
1106
-
1107
- process_payment_request = UltracartClient::OrderProcessPaymentRequest.new # OrderProcessPaymentRequest | Process payment parameters
1108
-
1109
-
1110
- begin
1111
- #Process payment
1112
- result = api_instance.process_payment(order_id, process_payment_request)
1113
- p result
1114
- rescue UltracartClient::ApiError => e
1115
- puts "Exception when calling OrderApi->process_payment: #{e}"
1116
- end
1117
- ```
1118
-
1119
- ### Parameters
1120
-
1121
- Name | Type | Description | Notes
1122
- ------------- | ------------- | ------------- | -------------
1123
- **order_id** | **String**| The order id to process payment on |
1124
- **process_payment_request** | [**OrderProcessPaymentRequest**](OrderProcessPaymentRequest.md)| Process payment parameters |
1125
-
1126
- ### Return type
1127
-
1128
- [**OrderProcessPaymentResponse**](OrderProcessPaymentResponse.md)
1129
-
1130
- ### Authorization
1131
-
1132
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1133
-
1134
- ### HTTP request headers
1135
-
1136
- - **Content-Type**: application/json
1137
- - **Accept**: application/json
1138
-
1139
-
1140
-
1141
- # **refund_order**
1142
- > OrderResponse refund_order(order, order_id, opts)
1143
-
1144
- Refund an order
1145
-
1146
- Perform a refund operation on an order and then update the order if successful
1147
-
1148
- ### Example
1149
- ```ruby
1150
- # load the gem
1151
- require 'ultracart_api'
1152
-
1153
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1154
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1155
- api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
1156
-
1157
-
1158
- order = UltracartClient::Order.new # Order | Order to refund
1159
-
1160
- order_id = 'order_id_example' # String | The order id to refund.
1161
-
1162
- opts = {
1163
- reject_after_refund: false, # BOOLEAN | Reject order after refund
1164
- skip_customer_notification: false, # BOOLEAN | Skip customer email notification
1165
- auto_order_cancel: false, # BOOLEAN | Cancel associated auto orders
1166
- manual_refund: false, # BOOLEAN | Consider a manual refund done externally
1167
- reverse_affiliate_transactions: true, # BOOLEAN | Reverse affiliate transactions
1168
- issue_store_credit: false, # BOOLEAN | Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
1169
- _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
1170
- }
1171
-
1172
- begin
1173
- #Refund an order
1174
- result = api_instance.refund_order(order, order_id, opts)
1175
- p result
1176
- rescue UltracartClient::ApiError => e
1177
- puts "Exception when calling OrderApi->refund_order: #{e}"
1178
- end
1179
- ```
1180
-
1181
- ### Parameters
1182
-
1183
- Name | Type | Description | Notes
1184
- ------------- | ------------- | ------------- | -------------
1185
- **order** | [**Order**](Order.md)| Order to refund |
1186
- **order_id** | **String**| The order id to refund. |
1187
- **reject_after_refund** | **BOOLEAN**| Reject order after refund | [optional] [default to false]
1188
- **skip_customer_notification** | **BOOLEAN**| Skip customer email notification | [optional] [default to false]
1189
- **auto_order_cancel** | **BOOLEAN**| Cancel associated auto orders | [optional] [default to false]
1190
- **manual_refund** | **BOOLEAN**| Consider a manual refund done externally | [optional] [default to false]
1191
- **reverse_affiliate_transactions** | **BOOLEAN**| Reverse affiliate transactions | [optional] [default to true]
1192
- **issue_store_credit** | **BOOLEAN**| Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account | [optional] [default to false]
1193
- **_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
1194
-
1195
- ### Return type
1196
-
1197
- [**OrderResponse**](OrderResponse.md)
1198
-
1199
- ### Authorization
1200
-
1201
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1202
-
1203
- ### HTTP request headers
1204
-
1205
- - **Content-Type**: application/json; charset=UTF-8
1206
- - **Accept**: application/json
1207
-
1208
-
1209
-
1210
- # **replacement**
1211
- > OrderReplacementResponse replacement(order_id, replacement)
1212
-
1213
- Replacement order
1214
-
1215
- Create a replacement order based upon a previous order
1216
-
1217
- ### Example
1218
- ```ruby
1219
- # load the gem
1220
- require 'ultracart_api'
1221
-
1222
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1223
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1224
- api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
1225
-
1226
-
1227
- order_id = 'order_id_example' # String | The order id to generate a replacement for.
1228
-
1229
- replacement = UltracartClient::OrderReplacement.new # OrderReplacement | Replacement order details
1230
-
1231
-
1232
- begin
1233
- #Replacement order
1234
- result = api_instance.replacement(order_id, replacement)
1235
- p result
1236
- rescue UltracartClient::ApiError => e
1237
- puts "Exception when calling OrderApi->replacement: #{e}"
1238
- end
1239
- ```
1240
-
1241
- ### Parameters
1242
-
1243
- Name | Type | Description | Notes
1244
- ------------- | ------------- | ------------- | -------------
1245
- **order_id** | **String**| The order id to generate a replacement for. |
1246
- **replacement** | [**OrderReplacement**](OrderReplacement.md)| Replacement order details |
1247
-
1248
- ### Return type
1249
-
1250
- [**OrderReplacementResponse**](OrderReplacementResponse.md)
1251
-
1252
- ### Authorization
1253
-
1254
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1255
-
1256
- ### HTTP request headers
1257
-
1258
- - **Content-Type**: application/json
1259
- - **Accept**: application/json
1260
-
1261
-
1262
-
1263
- # **resend_receipt**
1264
- > BaseResponse resend_receipt(order_id)
1265
-
1266
- Resend receipt
1267
-
1268
- Resend the receipt for an order on the UltraCart account.
1269
-
1270
- ### Example
1271
- ```ruby
1272
- # load the gem
1273
- require 'ultracart_api'
1274
-
1275
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1276
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1277
- api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
1278
-
1279
-
1280
- order_id = 'order_id_example' # String | The order id to resend the receipt for.
1281
-
1282
-
1283
- begin
1284
- #Resend receipt
1285
- result = api_instance.resend_receipt(order_id)
1286
- p result
1287
- rescue UltracartClient::ApiError => e
1288
- puts "Exception when calling OrderApi->resend_receipt: #{e}"
1289
- end
1290
- ```
1291
-
1292
- ### Parameters
1293
-
1294
- Name | Type | Description | Notes
1295
- ------------- | ------------- | ------------- | -------------
1296
- **order_id** | **String**| The order id to resend the receipt for. |
1297
-
1298
- ### Return type
1299
-
1300
- [**BaseResponse**](BaseResponse.md)
1301
-
1302
- ### Authorization
1303
-
1304
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1305
-
1306
- ### HTTP request headers
1307
-
1308
- - **Content-Type**: application/json
1309
- - **Accept**: application/json
1310
-
1311
-
1312
-
1313
- # **resend_shipment_confirmation**
1314
- > BaseResponse resend_shipment_confirmation(order_id)
1315
-
1316
- Resend shipment confirmation
1317
-
1318
- Resend shipment confirmation for an order on the UltraCart account.
1319
-
1320
- ### Example
1321
- ```ruby
1322
- # load the gem
1323
- require 'ultracart_api'
1324
-
1325
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1326
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1327
- api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
1328
-
1329
-
1330
- order_id = 'order_id_example' # String | The order id to resend the shipment notification for.
1331
-
1332
-
1333
- begin
1334
- #Resend shipment confirmation
1335
- result = api_instance.resend_shipment_confirmation(order_id)
1336
- p result
1337
- rescue UltracartClient::ApiError => e
1338
- puts "Exception when calling OrderApi->resend_shipment_confirmation: #{e}"
1339
- end
1340
- ```
1341
-
1342
- ### Parameters
1343
-
1344
- Name | Type | Description | Notes
1345
- ------------- | ------------- | ------------- | -------------
1346
- **order_id** | **String**| The order id to resend the shipment notification for. |
1347
-
1348
- ### Return type
1349
-
1350
- [**BaseResponse**](BaseResponse.md)
1351
-
1352
- ### Authorization
1353
-
1354
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1355
-
1356
- ### HTTP request headers
1357
-
1358
- - **Content-Type**: application/json
1359
- - **Accept**: application/json
1360
-
1361
-
1362
-
1363
- # **update_accounts_receivable_retry_config**
1364
- > BaseResponse update_accounts_receivable_retry_config(retry_config)
1365
-
1366
- Update A/R Retry Configuration
1367
-
1368
- Update A/R Retry Configuration. This is primarily an internal API call. It is doubtful you would ever need to use it.
1369
-
1370
- ### Example
1371
- ```ruby
1372
- # load the gem
1373
- require 'ultracart_api'
1374
-
1375
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1376
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1377
- api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
1378
-
1379
-
1380
- retry_config = UltracartClient::AccountsReceivableRetryConfig.new # AccountsReceivableRetryConfig | AccountsReceivableRetryConfig object
1381
-
1382
-
1383
- begin
1384
- #Update A/R Retry Configuration
1385
- result = api_instance.update_accounts_receivable_retry_config(retry_config)
1386
- p result
1387
- rescue UltracartClient::ApiError => e
1388
- puts "Exception when calling OrderApi->update_accounts_receivable_retry_config: #{e}"
1389
- end
1390
- ```
1391
-
1392
- ### Parameters
1393
-
1394
- Name | Type | Description | Notes
1395
- ------------- | ------------- | ------------- | -------------
1396
- **retry_config** | [**AccountsReceivableRetryConfig**](AccountsReceivableRetryConfig.md)| AccountsReceivableRetryConfig object |
1397
-
1398
- ### Return type
1399
-
1400
- [**BaseResponse**](BaseResponse.md)
1401
-
1402
- ### Authorization
1403
-
1404
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1405
-
1406
- ### HTTP request headers
1407
-
1408
- - **Content-Type**: application/json
1409
- - **Accept**: application/json
1410
-
1411
-
1412
-
1413
- # **update_order**
1414
- > OrderResponse update_order(order, order_id, opts)
1415
-
1416
- Update an order
1417
-
1418
- Update a new order on the UltraCart account. This is probably NOT the method you want. It is rare to update a completed order. This will not trigger charges, emails, or any other automation.
1419
-
1420
- ### Example
1421
- ```ruby
1422
- # load the gem
1423
- require 'ultracart_api'
1424
-
1425
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1426
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1427
- api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
1428
-
1429
-
1430
- order = UltracartClient::Order.new # Order | Order to update
1431
-
1432
- order_id = 'order_id_example' # String | The order id to update.
1433
-
1434
- opts = {
1435
- _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
1436
- }
1437
-
1438
- begin
1439
- #Update an order
1440
- result = api_instance.update_order(order, order_id, opts)
1441
- p result
1442
- rescue UltracartClient::ApiError => e
1443
- puts "Exception when calling OrderApi->update_order: #{e}"
1444
- end
1445
- ```
1446
-
1447
- ### Parameters
1448
-
1449
- Name | Type | Description | Notes
1450
- ------------- | ------------- | ------------- | -------------
1451
- **order** | [**Order**](Order.md)| Order to update |
1452
- **order_id** | **String**| The order id to update. |
1453
- **_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
1454
-
1455
- ### Return type
1456
-
1457
- [**OrderResponse**](OrderResponse.md)
1458
-
1459
- ### Authorization
1460
-
1461
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1462
-
1463
- ### HTTP request headers
1464
-
1465
- - **Content-Type**: application/json; charset=UTF-8
1466
- - **Accept**: application/json
1467
-
1468
-
1469
-
1
+ # UltracartClient::OrderApi
2
+
3
+ All URIs are relative to *https://secure.ultracart.com/rest/v2*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**adjust_order_total**](OrderApi.md#adjust_order_total) | **POST** /order/orders/{order_id}/adjust_order_total/{desired_total} | Adjusts an order total |
8
+ | [**cancel_order**](OrderApi.md#cancel_order) | **POST** /order/orders/{order_id}/cancel | Cancel an order |
9
+ | [**delete_order**](OrderApi.md#delete_order) | **DELETE** /order/orders/{order_id} | Delete an order |
10
+ | [**duplicate_order**](OrderApi.md#duplicate_order) | **POST** /order/orders/{order_id}/duplicate | Duplicate an order |
11
+ | [**format**](OrderApi.md#format) | **POST** /order/orders/{order_id}/format | Format order |
12
+ | [**generate_order_token**](OrderApi.md#generate_order_token) | **GET** /order/orders/token/{order_id} | Generate an order token for a given order id |
13
+ | [**generate_packing_slip_all_dc**](OrderApi.md#generate_packing_slip_all_dc) | **GET** /order/orders/{order_id}/packing_slip | Generate a packing slip for this order across all distribution centers. |
14
+ | [**generate_packing_slip_specific_dc**](OrderApi.md#generate_packing_slip_specific_dc) | **GET** /order/orders/{order_id}/packing_slip/{distribution_center_code} | Generate a packing slip for this order for the given distribution center. |
15
+ | [**get_accounts_receivable_retry_config**](OrderApi.md#get_accounts_receivable_retry_config) | **GET** /order/accountsReceivableRetryConfig | Retrieve A/R Retry Configuration |
16
+ | [**get_accounts_receivable_retry_stats**](OrderApi.md#get_accounts_receivable_retry_stats) | **GET** /order/accountsReceivableRetryConfig/stats | Retrieve A/R Retry Statistics |
17
+ | [**get_order**](OrderApi.md#get_order) | **GET** /order/orders/{order_id} | Retrieve an order |
18
+ | [**get_order_by_token**](OrderApi.md#get_order_by_token) | **POST** /order/orders/token | Retrieve an order using a token |
19
+ | [**get_orders**](OrderApi.md#get_orders) | **GET** /order/orders | Retrieve orders |
20
+ | [**get_orders_batch**](OrderApi.md#get_orders_batch) | **POST** /order/orders/batch | Retrieve order batch |
21
+ | [**get_orders_by_query**](OrderApi.md#get_orders_by_query) | **POST** /order/orders/query | Retrieve orders by query |
22
+ | [**insert_order**](OrderApi.md#insert_order) | **POST** /order/orders | Insert an order |
23
+ | [**process_payment**](OrderApi.md#process_payment) | **POST** /order/orders/{order_id}/process_payment | Process payment |
24
+ | [**refund_order**](OrderApi.md#refund_order) | **PUT** /order/orders/{order_id}/refund | Refund an order |
25
+ | [**replacement**](OrderApi.md#replacement) | **POST** /order/orders/{order_id}/replacement | Replacement order |
26
+ | [**resend_receipt**](OrderApi.md#resend_receipt) | **POST** /order/orders/{order_id}/resend_receipt | Resend receipt |
27
+ | [**resend_shipment_confirmation**](OrderApi.md#resend_shipment_confirmation) | **POST** /order/orders/{order_id}/resend_shipment_confirmation | Resend shipment confirmation |
28
+ | [**update_accounts_receivable_retry_config**](OrderApi.md#update_accounts_receivable_retry_config) | **POST** /order/accountsReceivableRetryConfig | Update A/R Retry Configuration |
29
+ | [**update_order**](OrderApi.md#update_order) | **PUT** /order/orders/{order_id} | Update an order |
30
+
31
+
32
+ ## adjust_order_total
33
+
34
+ > <BaseResponse> adjust_order_total(order_id, desired_total)
35
+
36
+ Adjusts an order total
37
+
38
+ Adjusts an order total. Adjusts individual items appropriately and considers taxes. Desired total should be provided in the same currency as the order and must be less than the current total and greater than zero. This call will change the order total. It returns true if the desired total is achieved. If the goal seeking algorithm falls short (usually by pennies), this method returns back false. View the merchant notes for the order for further details.
39
+
40
+ ### Examples
41
+
42
+ ```ruby
43
+ require 'time'
44
+ require 'ultracart_api'
45
+ # setup authorization
46
+ UltracartClient.configure do |config|
47
+ # Configure OAuth2 access token for authorization: ultraCartOauth
48
+ config.access_token = 'YOUR ACCESS TOKEN'
49
+
50
+ # Configure API key authorization: ultraCartSimpleApiKey
51
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
52
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
53
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
54
+ end
55
+
56
+ api_instance = UltracartClient::OrderApi.new
57
+ order_id = 'order_id_example' # String | The order id to cancel.
58
+ desired_total = 'desired_total_example' # String | The desired total with no formatting. example 123.45
59
+
60
+ begin
61
+ # Adjusts an order total
62
+ result = api_instance.adjust_order_total(order_id, desired_total)
63
+ p result
64
+ rescue UltracartClient::ApiError => e
65
+ puts "Error when calling OrderApi->adjust_order_total: #{e}"
66
+ end
67
+ ```
68
+
69
+ #### Using the adjust_order_total_with_http_info variant
70
+
71
+ This returns an Array which contains the response data, status code and headers.
72
+
73
+ > <Array(<BaseResponse>, Integer, Hash)> adjust_order_total_with_http_info(order_id, desired_total)
74
+
75
+ ```ruby
76
+ begin
77
+ # Adjusts an order total
78
+ data, status_code, headers = api_instance.adjust_order_total_with_http_info(order_id, desired_total)
79
+ p status_code # => 2xx
80
+ p headers # => { ... }
81
+ p data # => <BaseResponse>
82
+ rescue UltracartClient::ApiError => e
83
+ puts "Error when calling OrderApi->adjust_order_total_with_http_info: #{e}"
84
+ end
85
+ ```
86
+
87
+ ### Parameters
88
+
89
+ | Name | Type | Description | Notes |
90
+ | ---- | ---- | ----------- | ----- |
91
+ | **order_id** | **String** | The order id to cancel. | |
92
+ | **desired_total** | **String** | The desired total with no formatting. example 123.45 | |
93
+
94
+ ### Return type
95
+
96
+ [**BaseResponse**](BaseResponse.md)
97
+
98
+ ### Authorization
99
+
100
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
101
+
102
+ ### HTTP request headers
103
+
104
+ - **Content-Type**: Not defined
105
+ - **Accept**: application/json
106
+
107
+
108
+ ## cancel_order
109
+
110
+ > <BaseResponse> cancel_order(order_id)
111
+
112
+ Cancel an order
113
+
114
+ Cancel an order on the UltraCart account. If the success flag is false, then consult the error message for why it failed.
115
+
116
+ ### Examples
117
+
118
+ ```ruby
119
+ require 'time'
120
+ require 'ultracart_api'
121
+ # setup authorization
122
+ UltracartClient.configure do |config|
123
+ # Configure OAuth2 access token for authorization: ultraCartOauth
124
+ config.access_token = 'YOUR ACCESS TOKEN'
125
+
126
+ # Configure API key authorization: ultraCartSimpleApiKey
127
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
128
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
129
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
130
+ end
131
+
132
+ api_instance = UltracartClient::OrderApi.new
133
+ order_id = 'order_id_example' # String | The order id to cancel.
134
+
135
+ begin
136
+ # Cancel an order
137
+ result = api_instance.cancel_order(order_id)
138
+ p result
139
+ rescue UltracartClient::ApiError => e
140
+ puts "Error when calling OrderApi->cancel_order: #{e}"
141
+ end
142
+ ```
143
+
144
+ #### Using the cancel_order_with_http_info variant
145
+
146
+ This returns an Array which contains the response data, status code and headers.
147
+
148
+ > <Array(<BaseResponse>, Integer, Hash)> cancel_order_with_http_info(order_id)
149
+
150
+ ```ruby
151
+ begin
152
+ # Cancel an order
153
+ data, status_code, headers = api_instance.cancel_order_with_http_info(order_id)
154
+ p status_code # => 2xx
155
+ p headers # => { ... }
156
+ p data # => <BaseResponse>
157
+ rescue UltracartClient::ApiError => e
158
+ puts "Error when calling OrderApi->cancel_order_with_http_info: #{e}"
159
+ end
160
+ ```
161
+
162
+ ### Parameters
163
+
164
+ | Name | Type | Description | Notes |
165
+ | ---- | ---- | ----------- | ----- |
166
+ | **order_id** | **String** | The order id to cancel. | |
167
+
168
+ ### Return type
169
+
170
+ [**BaseResponse**](BaseResponse.md)
171
+
172
+ ### Authorization
173
+
174
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
175
+
176
+ ### HTTP request headers
177
+
178
+ - **Content-Type**: Not defined
179
+ - **Accept**: application/json
180
+
181
+
182
+ ## delete_order
183
+
184
+ > delete_order(order_id)
185
+
186
+ Delete an order
187
+
188
+ Delete an order on the UltraCart account.
189
+
190
+ ### Examples
191
+
192
+ ```ruby
193
+ require 'time'
194
+ require 'ultracart_api'
195
+ # setup authorization
196
+ UltracartClient.configure do |config|
197
+ # Configure OAuth2 access token for authorization: ultraCartOauth
198
+ config.access_token = 'YOUR ACCESS TOKEN'
199
+
200
+ # Configure API key authorization: ultraCartSimpleApiKey
201
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
202
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
203
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
204
+ end
205
+
206
+ api_instance = UltracartClient::OrderApi.new
207
+ order_id = 'order_id_example' # String | The order id to delete.
208
+
209
+ begin
210
+ # Delete an order
211
+ api_instance.delete_order(order_id)
212
+ rescue UltracartClient::ApiError => e
213
+ puts "Error when calling OrderApi->delete_order: #{e}"
214
+ end
215
+ ```
216
+
217
+ #### Using the delete_order_with_http_info variant
218
+
219
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
220
+
221
+ > <Array(nil, Integer, Hash)> delete_order_with_http_info(order_id)
222
+
223
+ ```ruby
224
+ begin
225
+ # Delete an order
226
+ data, status_code, headers = api_instance.delete_order_with_http_info(order_id)
227
+ p status_code # => 2xx
228
+ p headers # => { ... }
229
+ p data # => nil
230
+ rescue UltracartClient::ApiError => e
231
+ puts "Error when calling OrderApi->delete_order_with_http_info: #{e}"
232
+ end
233
+ ```
234
+
235
+ ### Parameters
236
+
237
+ | Name | Type | Description | Notes |
238
+ | ---- | ---- | ----------- | ----- |
239
+ | **order_id** | **String** | The order id to delete. | |
240
+
241
+ ### Return type
242
+
243
+ nil (empty response body)
244
+
245
+ ### Authorization
246
+
247
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
248
+
249
+ ### HTTP request headers
250
+
251
+ - **Content-Type**: Not defined
252
+ - **Accept**: application/json
253
+
254
+
255
+ ## duplicate_order
256
+
257
+ > <OrderResponse> duplicate_order(order_id, opts)
258
+
259
+ Duplicate an order
260
+
261
+ Perform a duplicate of the specified order_id and return a new order located in Accounts Receivable.
262
+
263
+ ### Examples
264
+
265
+ ```ruby
266
+ require 'time'
267
+ require 'ultracart_api'
268
+ # setup authorization
269
+ UltracartClient.configure do |config|
270
+ # Configure OAuth2 access token for authorization: ultraCartOauth
271
+ config.access_token = 'YOUR ACCESS TOKEN'
272
+
273
+ # Configure API key authorization: ultraCartSimpleApiKey
274
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
275
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
276
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
277
+ end
278
+
279
+ api_instance = UltracartClient::OrderApi.new
280
+ order_id = 'order_id_example' # String | The order id to duplicate.
281
+ opts = {
282
+ _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
283
+ }
284
+
285
+ begin
286
+ # Duplicate an order
287
+ result = api_instance.duplicate_order(order_id, opts)
288
+ p result
289
+ rescue UltracartClient::ApiError => e
290
+ puts "Error when calling OrderApi->duplicate_order: #{e}"
291
+ end
292
+ ```
293
+
294
+ #### Using the duplicate_order_with_http_info variant
295
+
296
+ This returns an Array which contains the response data, status code and headers.
297
+
298
+ > <Array(<OrderResponse>, Integer, Hash)> duplicate_order_with_http_info(order_id, opts)
299
+
300
+ ```ruby
301
+ begin
302
+ # Duplicate an order
303
+ data, status_code, headers = api_instance.duplicate_order_with_http_info(order_id, opts)
304
+ p status_code # => 2xx
305
+ p headers # => { ... }
306
+ p data # => <OrderResponse>
307
+ rescue UltracartClient::ApiError => e
308
+ puts "Error when calling OrderApi->duplicate_order_with_http_info: #{e}"
309
+ end
310
+ ```
311
+
312
+ ### Parameters
313
+
314
+ | Name | Type | Description | Notes |
315
+ | ---- | ---- | ----------- | ----- |
316
+ | **order_id** | **String** | The order id to duplicate. | |
317
+ | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
318
+
319
+ ### Return type
320
+
321
+ [**OrderResponse**](OrderResponse.md)
322
+
323
+ ### Authorization
324
+
325
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
326
+
327
+ ### HTTP request headers
328
+
329
+ - **Content-Type**: Not defined
330
+ - **Accept**: application/json
331
+
332
+
333
+ ## format
334
+
335
+ > <OrderFormatResponse> format(order_id, format_options)
336
+
337
+ Format order
338
+
339
+ Format the order for display at text or html
340
+
341
+ ### Examples
342
+
343
+ ```ruby
344
+ require 'time'
345
+ require 'ultracart_api'
346
+ # setup authorization
347
+ UltracartClient.configure do |config|
348
+ # Configure OAuth2 access token for authorization: ultraCartOauth
349
+ config.access_token = 'YOUR ACCESS TOKEN'
350
+
351
+ # Configure API key authorization: ultraCartSimpleApiKey
352
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
353
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
354
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
355
+ end
356
+
357
+ api_instance = UltracartClient::OrderApi.new
358
+ order_id = 'order_id_example' # String | The order id to format
359
+ format_options = UltracartClient::OrderFormat.new # OrderFormat | Format options
360
+
361
+ begin
362
+ # Format order
363
+ result = api_instance.format(order_id, format_options)
364
+ p result
365
+ rescue UltracartClient::ApiError => e
366
+ puts "Error when calling OrderApi->format: #{e}"
367
+ end
368
+ ```
369
+
370
+ #### Using the format_with_http_info variant
371
+
372
+ This returns an Array which contains the response data, status code and headers.
373
+
374
+ > <Array(<OrderFormatResponse>, Integer, Hash)> format_with_http_info(order_id, format_options)
375
+
376
+ ```ruby
377
+ begin
378
+ # Format order
379
+ data, status_code, headers = api_instance.format_with_http_info(order_id, format_options)
380
+ p status_code # => 2xx
381
+ p headers # => { ... }
382
+ p data # => <OrderFormatResponse>
383
+ rescue UltracartClient::ApiError => e
384
+ puts "Error when calling OrderApi->format_with_http_info: #{e}"
385
+ end
386
+ ```
387
+
388
+ ### Parameters
389
+
390
+ | Name | Type | Description | Notes |
391
+ | ---- | ---- | ----------- | ----- |
392
+ | **order_id** | **String** | The order id to format | |
393
+ | **format_options** | [**OrderFormat**](OrderFormat.md) | Format options | |
394
+
395
+ ### Return type
396
+
397
+ [**OrderFormatResponse**](OrderFormatResponse.md)
398
+
399
+ ### Authorization
400
+
401
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
402
+
403
+ ### HTTP request headers
404
+
405
+ - **Content-Type**: application/json
406
+ - **Accept**: application/json
407
+
408
+
409
+ ## generate_order_token
410
+
411
+ > <OrderTokenResponse> generate_order_token(order_id)
412
+
413
+ Generate an order token for a given order id
414
+
415
+ Retrieves a single order token for a given order id. The token can be used with the getOrderByToken API.
416
+
417
+ ### Examples
418
+
419
+ ```ruby
420
+ require 'time'
421
+ require 'ultracart_api'
422
+ # setup authorization
423
+ UltracartClient.configure do |config|
424
+ # Configure OAuth2 access token for authorization: ultraCartOauth
425
+ config.access_token = 'YOUR ACCESS TOKEN'
426
+
427
+ # Configure API key authorization: ultraCartSimpleApiKey
428
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
429
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
430
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
431
+ end
432
+
433
+ api_instance = UltracartClient::OrderApi.new
434
+ order_id = 'order_id_example' # String | The order id to generate a token for.
435
+
436
+ begin
437
+ # Generate an order token for a given order id
438
+ result = api_instance.generate_order_token(order_id)
439
+ p result
440
+ rescue UltracartClient::ApiError => e
441
+ puts "Error when calling OrderApi->generate_order_token: #{e}"
442
+ end
443
+ ```
444
+
445
+ #### Using the generate_order_token_with_http_info variant
446
+
447
+ This returns an Array which contains the response data, status code and headers.
448
+
449
+ > <Array(<OrderTokenResponse>, Integer, Hash)> generate_order_token_with_http_info(order_id)
450
+
451
+ ```ruby
452
+ begin
453
+ # Generate an order token for a given order id
454
+ data, status_code, headers = api_instance.generate_order_token_with_http_info(order_id)
455
+ p status_code # => 2xx
456
+ p headers # => { ... }
457
+ p data # => <OrderTokenResponse>
458
+ rescue UltracartClient::ApiError => e
459
+ puts "Error when calling OrderApi->generate_order_token_with_http_info: #{e}"
460
+ end
461
+ ```
462
+
463
+ ### Parameters
464
+
465
+ | Name | Type | Description | Notes |
466
+ | ---- | ---- | ----------- | ----- |
467
+ | **order_id** | **String** | The order id to generate a token for. | |
468
+
469
+ ### Return type
470
+
471
+ [**OrderTokenResponse**](OrderTokenResponse.md)
472
+
473
+ ### Authorization
474
+
475
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
476
+
477
+ ### HTTP request headers
478
+
479
+ - **Content-Type**: Not defined
480
+ - **Accept**: application/json
481
+
482
+
483
+ ## generate_packing_slip_all_dc
484
+
485
+ > <OrderPackingSlipResponse> generate_packing_slip_all_dc(order_id)
486
+
487
+ Generate a packing slip for this order across all distribution centers.
488
+
489
+ The packing slip PDF that is returned is base 64 encoded
490
+
491
+ ### Examples
492
+
493
+ ```ruby
494
+ require 'time'
495
+ require 'ultracart_api'
496
+ # setup authorization
497
+ UltracartClient.configure do |config|
498
+ # Configure OAuth2 access token for authorization: ultraCartOauth
499
+ config.access_token = 'YOUR ACCESS TOKEN'
500
+
501
+ # Configure API key authorization: ultraCartSimpleApiKey
502
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
503
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
504
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
505
+ end
506
+
507
+ api_instance = UltracartClient::OrderApi.new
508
+ order_id = 'order_id_example' # String | Order ID
509
+
510
+ begin
511
+ # Generate a packing slip for this order across all distribution centers.
512
+ result = api_instance.generate_packing_slip_all_dc(order_id)
513
+ p result
514
+ rescue UltracartClient::ApiError => e
515
+ puts "Error when calling OrderApi->generate_packing_slip_all_dc: #{e}"
516
+ end
517
+ ```
518
+
519
+ #### Using the generate_packing_slip_all_dc_with_http_info variant
520
+
521
+ This returns an Array which contains the response data, status code and headers.
522
+
523
+ > <Array(<OrderPackingSlipResponse>, Integer, Hash)> generate_packing_slip_all_dc_with_http_info(order_id)
524
+
525
+ ```ruby
526
+ begin
527
+ # Generate a packing slip for this order across all distribution centers.
528
+ data, status_code, headers = api_instance.generate_packing_slip_all_dc_with_http_info(order_id)
529
+ p status_code # => 2xx
530
+ p headers # => { ... }
531
+ p data # => <OrderPackingSlipResponse>
532
+ rescue UltracartClient::ApiError => e
533
+ puts "Error when calling OrderApi->generate_packing_slip_all_dc_with_http_info: #{e}"
534
+ end
535
+ ```
536
+
537
+ ### Parameters
538
+
539
+ | Name | Type | Description | Notes |
540
+ | ---- | ---- | ----------- | ----- |
541
+ | **order_id** | **String** | Order ID | |
542
+
543
+ ### Return type
544
+
545
+ [**OrderPackingSlipResponse**](OrderPackingSlipResponse.md)
546
+
547
+ ### Authorization
548
+
549
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
550
+
551
+ ### HTTP request headers
552
+
553
+ - **Content-Type**: Not defined
554
+ - **Accept**: application/json
555
+
556
+
557
+ ## generate_packing_slip_specific_dc
558
+
559
+ > <OrderPackingSlipResponse> generate_packing_slip_specific_dc(distribution_center_code, order_id)
560
+
561
+ Generate a packing slip for this order for the given distribution center.
562
+
563
+ The packing slip PDF that is returned is base 64 encoded
564
+
565
+ ### Examples
566
+
567
+ ```ruby
568
+ require 'time'
569
+ require 'ultracart_api'
570
+ # setup authorization
571
+ UltracartClient.configure do |config|
572
+ # Configure OAuth2 access token for authorization: ultraCartOauth
573
+ config.access_token = 'YOUR ACCESS TOKEN'
574
+
575
+ # Configure API key authorization: ultraCartSimpleApiKey
576
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
577
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
578
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
579
+ end
580
+
581
+ api_instance = UltracartClient::OrderApi.new
582
+ distribution_center_code = 'distribution_center_code_example' # String | Distribution center code
583
+ order_id = 'order_id_example' # String | Order ID
584
+
585
+ begin
586
+ # Generate a packing slip for this order for the given distribution center.
587
+ result = api_instance.generate_packing_slip_specific_dc(distribution_center_code, order_id)
588
+ p result
589
+ rescue UltracartClient::ApiError => e
590
+ puts "Error when calling OrderApi->generate_packing_slip_specific_dc: #{e}"
591
+ end
592
+ ```
593
+
594
+ #### Using the generate_packing_slip_specific_dc_with_http_info variant
595
+
596
+ This returns an Array which contains the response data, status code and headers.
597
+
598
+ > <Array(<OrderPackingSlipResponse>, Integer, Hash)> generate_packing_slip_specific_dc_with_http_info(distribution_center_code, order_id)
599
+
600
+ ```ruby
601
+ begin
602
+ # Generate a packing slip for this order for the given distribution center.
603
+ data, status_code, headers = api_instance.generate_packing_slip_specific_dc_with_http_info(distribution_center_code, order_id)
604
+ p status_code # => 2xx
605
+ p headers # => { ... }
606
+ p data # => <OrderPackingSlipResponse>
607
+ rescue UltracartClient::ApiError => e
608
+ puts "Error when calling OrderApi->generate_packing_slip_specific_dc_with_http_info: #{e}"
609
+ end
610
+ ```
611
+
612
+ ### Parameters
613
+
614
+ | Name | Type | Description | Notes |
615
+ | ---- | ---- | ----------- | ----- |
616
+ | **distribution_center_code** | **String** | Distribution center code | |
617
+ | **order_id** | **String** | Order ID | |
618
+
619
+ ### Return type
620
+
621
+ [**OrderPackingSlipResponse**](OrderPackingSlipResponse.md)
622
+
623
+ ### Authorization
624
+
625
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
626
+
627
+ ### HTTP request headers
628
+
629
+ - **Content-Type**: Not defined
630
+ - **Accept**: application/json
631
+
632
+
633
+ ## get_accounts_receivable_retry_config
634
+
635
+ > <AccountsReceivableRetryConfigResponse> get_accounts_receivable_retry_config
636
+
637
+ Retrieve A/R Retry Configuration
638
+
639
+ Retrieve A/R Retry Configuration. This is primarily an internal API call. It is doubtful you would ever need to use it.
640
+
641
+ ### Examples
642
+
643
+ ```ruby
644
+ require 'time'
645
+ require 'ultracart_api'
646
+ # setup authorization
647
+ UltracartClient.configure do |config|
648
+ # Configure OAuth2 access token for authorization: ultraCartOauth
649
+ config.access_token = 'YOUR ACCESS TOKEN'
650
+
651
+ # Configure API key authorization: ultraCartSimpleApiKey
652
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
653
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
654
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
655
+ end
656
+
657
+ api_instance = UltracartClient::OrderApi.new
658
+
659
+ begin
660
+ # Retrieve A/R Retry Configuration
661
+ result = api_instance.get_accounts_receivable_retry_config
662
+ p result
663
+ rescue UltracartClient::ApiError => e
664
+ puts "Error when calling OrderApi->get_accounts_receivable_retry_config: #{e}"
665
+ end
666
+ ```
667
+
668
+ #### Using the get_accounts_receivable_retry_config_with_http_info variant
669
+
670
+ This returns an Array which contains the response data, status code and headers.
671
+
672
+ > <Array(<AccountsReceivableRetryConfigResponse>, Integer, Hash)> get_accounts_receivable_retry_config_with_http_info
673
+
674
+ ```ruby
675
+ begin
676
+ # Retrieve A/R Retry Configuration
677
+ data, status_code, headers = api_instance.get_accounts_receivable_retry_config_with_http_info
678
+ p status_code # => 2xx
679
+ p headers # => { ... }
680
+ p data # => <AccountsReceivableRetryConfigResponse>
681
+ rescue UltracartClient::ApiError => e
682
+ puts "Error when calling OrderApi->get_accounts_receivable_retry_config_with_http_info: #{e}"
683
+ end
684
+ ```
685
+
686
+ ### Parameters
687
+
688
+ This endpoint does not need any parameter.
689
+
690
+ ### Return type
691
+
692
+ [**AccountsReceivableRetryConfigResponse**](AccountsReceivableRetryConfigResponse.md)
693
+
694
+ ### Authorization
695
+
696
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
697
+
698
+ ### HTTP request headers
699
+
700
+ - **Content-Type**: Not defined
701
+ - **Accept**: application/json
702
+
703
+
704
+ ## get_accounts_receivable_retry_stats
705
+
706
+ > <AccountsReceivableRetryStatsResponse> get_accounts_receivable_retry_stats(opts)
707
+
708
+ Retrieve A/R Retry Statistics
709
+
710
+ Retrieve A/R Retry Statistics. This is primarily an internal API call. It is doubtful you would ever need to use it.
711
+
712
+ ### Examples
713
+
714
+ ```ruby
715
+ require 'time'
716
+ require 'ultracart_api'
717
+ # setup authorization
718
+ UltracartClient.configure do |config|
719
+ # Configure OAuth2 access token for authorization: ultraCartOauth
720
+ config.access_token = 'YOUR ACCESS TOKEN'
721
+
722
+ # Configure API key authorization: ultraCartSimpleApiKey
723
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
724
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
725
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
726
+ end
727
+
728
+ api_instance = UltracartClient::OrderApi.new
729
+ opts = {
730
+ from: 'from_example', # String |
731
+ to: 'to_example' # String |
732
+ }
733
+
734
+ begin
735
+ # Retrieve A/R Retry Statistics
736
+ result = api_instance.get_accounts_receivable_retry_stats(opts)
737
+ p result
738
+ rescue UltracartClient::ApiError => e
739
+ puts "Error when calling OrderApi->get_accounts_receivable_retry_stats: #{e}"
740
+ end
741
+ ```
742
+
743
+ #### Using the get_accounts_receivable_retry_stats_with_http_info variant
744
+
745
+ This returns an Array which contains the response data, status code and headers.
746
+
747
+ > <Array(<AccountsReceivableRetryStatsResponse>, Integer, Hash)> get_accounts_receivable_retry_stats_with_http_info(opts)
748
+
749
+ ```ruby
750
+ begin
751
+ # Retrieve A/R Retry Statistics
752
+ data, status_code, headers = api_instance.get_accounts_receivable_retry_stats_with_http_info(opts)
753
+ p status_code # => 2xx
754
+ p headers # => { ... }
755
+ p data # => <AccountsReceivableRetryStatsResponse>
756
+ rescue UltracartClient::ApiError => e
757
+ puts "Error when calling OrderApi->get_accounts_receivable_retry_stats_with_http_info: #{e}"
758
+ end
759
+ ```
760
+
761
+ ### Parameters
762
+
763
+ | Name | Type | Description | Notes |
764
+ | ---- | ---- | ----------- | ----- |
765
+ | **from** | **String** | | [optional] |
766
+ | **to** | **String** | | [optional] |
767
+
768
+ ### Return type
769
+
770
+ [**AccountsReceivableRetryStatsResponse**](AccountsReceivableRetryStatsResponse.md)
771
+
772
+ ### Authorization
773
+
774
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
775
+
776
+ ### HTTP request headers
777
+
778
+ - **Content-Type**: Not defined
779
+ - **Accept**: application/json
780
+
781
+
782
+ ## get_order
783
+
784
+ > <OrderResponse> get_order(order_id, opts)
785
+
786
+ Retrieve an order
787
+
788
+ Retrieves a single order using the specified order id.
789
+
790
+ ### Examples
791
+
792
+ ```ruby
793
+ require 'time'
794
+ require 'ultracart_api'
795
+ # setup authorization
796
+ UltracartClient.configure do |config|
797
+ # Configure OAuth2 access token for authorization: ultraCartOauth
798
+ config.access_token = 'YOUR ACCESS TOKEN'
799
+
800
+ # Configure API key authorization: ultraCartSimpleApiKey
801
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
802
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
803
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
804
+ end
805
+
806
+ api_instance = UltracartClient::OrderApi.new
807
+ order_id = 'order_id_example' # String | The order id to retrieve.
808
+ opts = {
809
+ _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
810
+ }
811
+
812
+ begin
813
+ # Retrieve an order
814
+ result = api_instance.get_order(order_id, opts)
815
+ p result
816
+ rescue UltracartClient::ApiError => e
817
+ puts "Error when calling OrderApi->get_order: #{e}"
818
+ end
819
+ ```
820
+
821
+ #### Using the get_order_with_http_info variant
822
+
823
+ This returns an Array which contains the response data, status code and headers.
824
+
825
+ > <Array(<OrderResponse>, Integer, Hash)> get_order_with_http_info(order_id, opts)
826
+
827
+ ```ruby
828
+ begin
829
+ # Retrieve an order
830
+ data, status_code, headers = api_instance.get_order_with_http_info(order_id, opts)
831
+ p status_code # => 2xx
832
+ p headers # => { ... }
833
+ p data # => <OrderResponse>
834
+ rescue UltracartClient::ApiError => e
835
+ puts "Error when calling OrderApi->get_order_with_http_info: #{e}"
836
+ end
837
+ ```
838
+
839
+ ### Parameters
840
+
841
+ | Name | Type | Description | Notes |
842
+ | ---- | ---- | ----------- | ----- |
843
+ | **order_id** | **String** | The order id to retrieve. | |
844
+ | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
845
+
846
+ ### Return type
847
+
848
+ [**OrderResponse**](OrderResponse.md)
849
+
850
+ ### Authorization
851
+
852
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
853
+
854
+ ### HTTP request headers
855
+
856
+ - **Content-Type**: Not defined
857
+ - **Accept**: application/json
858
+
859
+
860
+ ## get_order_by_token
861
+
862
+ > <OrderResponse> get_order_by_token(order_by_token_query, opts)
863
+
864
+ Retrieve an order using a token
865
+
866
+ Retrieves a single order using the specified order token.
867
+
868
+ ### Examples
869
+
870
+ ```ruby
871
+ require 'time'
872
+ require 'ultracart_api'
873
+ # setup authorization
874
+ UltracartClient.configure do |config|
875
+ # Configure OAuth2 access token for authorization: ultraCartOauth
876
+ config.access_token = 'YOUR ACCESS TOKEN'
877
+
878
+ # Configure API key authorization: ultraCartSimpleApiKey
879
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
880
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
881
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
882
+ end
883
+
884
+ api_instance = UltracartClient::OrderApi.new
885
+ order_by_token_query = UltracartClient::OrderByTokenQuery.new # OrderByTokenQuery | Order by token query
886
+ opts = {
887
+ _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
888
+ }
889
+
890
+ begin
891
+ # Retrieve an order using a token
892
+ result = api_instance.get_order_by_token(order_by_token_query, opts)
893
+ p result
894
+ rescue UltracartClient::ApiError => e
895
+ puts "Error when calling OrderApi->get_order_by_token: #{e}"
896
+ end
897
+ ```
898
+
899
+ #### Using the get_order_by_token_with_http_info variant
900
+
901
+ This returns an Array which contains the response data, status code and headers.
902
+
903
+ > <Array(<OrderResponse>, Integer, Hash)> get_order_by_token_with_http_info(order_by_token_query, opts)
904
+
905
+ ```ruby
906
+ begin
907
+ # Retrieve an order using a token
908
+ data, status_code, headers = api_instance.get_order_by_token_with_http_info(order_by_token_query, opts)
909
+ p status_code # => 2xx
910
+ p headers # => { ... }
911
+ p data # => <OrderResponse>
912
+ rescue UltracartClient::ApiError => e
913
+ puts "Error when calling OrderApi->get_order_by_token_with_http_info: #{e}"
914
+ end
915
+ ```
916
+
917
+ ### Parameters
918
+
919
+ | Name | Type | Description | Notes |
920
+ | ---- | ---- | ----------- | ----- |
921
+ | **order_by_token_query** | [**OrderByTokenQuery**](OrderByTokenQuery.md) | Order by token query | |
922
+ | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
923
+
924
+ ### Return type
925
+
926
+ [**OrderResponse**](OrderResponse.md)
927
+
928
+ ### Authorization
929
+
930
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
931
+
932
+ ### HTTP request headers
933
+
934
+ - **Content-Type**: application/json
935
+ - **Accept**: application/json
936
+
937
+
938
+ ## get_orders
939
+
940
+ > <OrdersResponse> get_orders(opts)
941
+
942
+ Retrieve orders
943
+
944
+ Retrieves a group of orders from the account. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
945
+
946
+ ### Examples
947
+
948
+ ```ruby
949
+ require 'time'
950
+ require 'ultracart_api'
951
+ # setup authorization
952
+ UltracartClient.configure do |config|
953
+ # Configure OAuth2 access token for authorization: ultraCartOauth
954
+ config.access_token = 'YOUR ACCESS TOKEN'
955
+
956
+ # Configure API key authorization: ultraCartSimpleApiKey
957
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
958
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
959
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
960
+ end
961
+
962
+ api_instance = UltracartClient::OrderApi.new
963
+ opts = {
964
+ order_id: 'order_id_example', # String | Order Id
965
+ payment_method: 'payment_method_example', # String | Payment Method
966
+ company: 'company_example', # String | Company
967
+ first_name: 'first_name_example', # String | First Name
968
+ last_name: 'last_name_example', # String | Last Name
969
+ city: 'city_example', # String | City
970
+ state_region: 'state_region_example', # String | State/Region
971
+ postal_code: 'postal_code_example', # String | Postal Code
972
+ country_code: 'country_code_example', # String | Country Code (ISO-3166 two letter)
973
+ phone: 'phone_example', # String | Phone
974
+ email: 'email_example', # String | Email
975
+ cc_email: 'cc_email_example', # String | CC Email
976
+ total: 8.14, # Float | Total
977
+ screen_branding_theme_code: 'screen_branding_theme_code_example', # String | Screen Branding Theme Code
978
+ storefront_host_name: 'storefront_host_name_example', # String | StoreFront Host Name
979
+ creation_date_begin: 'creation_date_begin_example', # String | Creation Date Begin
980
+ creation_date_end: 'creation_date_end_example', # String | Creation Date End
981
+ payment_date_begin: 'payment_date_begin_example', # String | Payment Date Begin
982
+ payment_date_end: 'payment_date_end_example', # String | Payment Date End
983
+ shipment_date_begin: 'shipment_date_begin_example', # String | Shipment Date Begin
984
+ shipment_date_end: 'shipment_date_end_example', # String | Shipment Date End
985
+ rma: 'rma_example', # String | RMA
986
+ purchase_order_number: 'purchase_order_number_example', # String | Purchase Order Number
987
+ item_id: 'item_id_example', # String | Item Id
988
+ current_stage: 'current_stage_example', # String | Current Stage
989
+ channel_partner_code: 'channel_partner_code_example', # String | Channel Partner Code
990
+ channel_partner_order_id: 'channel_partner_order_id_example', # String | Channel Partner Order ID
991
+ _limit: 56, # Integer | The maximum number of records to return on this one API call. (Maximum 200)
992
+ _offset: 56, # Integer | Pagination of the record set. Offset is a zero based index.
993
+ _sort: '_sort_example', # String | The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
994
+ _expand: '_expand_example' # String | The object expansion to perform on the result.
995
+ }
996
+
997
+ begin
998
+ # Retrieve orders
999
+ result = api_instance.get_orders(opts)
1000
+ p result
1001
+ rescue UltracartClient::ApiError => e
1002
+ puts "Error when calling OrderApi->get_orders: #{e}"
1003
+ end
1004
+ ```
1005
+
1006
+ #### Using the get_orders_with_http_info variant
1007
+
1008
+ This returns an Array which contains the response data, status code and headers.
1009
+
1010
+ > <Array(<OrdersResponse>, Integer, Hash)> get_orders_with_http_info(opts)
1011
+
1012
+ ```ruby
1013
+ begin
1014
+ # Retrieve orders
1015
+ data, status_code, headers = api_instance.get_orders_with_http_info(opts)
1016
+ p status_code # => 2xx
1017
+ p headers # => { ... }
1018
+ p data # => <OrdersResponse>
1019
+ rescue UltracartClient::ApiError => e
1020
+ puts "Error when calling OrderApi->get_orders_with_http_info: #{e}"
1021
+ end
1022
+ ```
1023
+
1024
+ ### Parameters
1025
+
1026
+ | Name | Type | Description | Notes |
1027
+ | ---- | ---- | ----------- | ----- |
1028
+ | **order_id** | **String** | Order Id | [optional] |
1029
+ | **payment_method** | **String** | Payment Method | [optional] |
1030
+ | **company** | **String** | Company | [optional] |
1031
+ | **first_name** | **String** | First Name | [optional] |
1032
+ | **last_name** | **String** | Last Name | [optional] |
1033
+ | **city** | **String** | City | [optional] |
1034
+ | **state_region** | **String** | State/Region | [optional] |
1035
+ | **postal_code** | **String** | Postal Code | [optional] |
1036
+ | **country_code** | **String** | Country Code (ISO-3166 two letter) | [optional] |
1037
+ | **phone** | **String** | Phone | [optional] |
1038
+ | **email** | **String** | Email | [optional] |
1039
+ | **cc_email** | **String** | CC Email | [optional] |
1040
+ | **total** | **Float** | Total | [optional] |
1041
+ | **screen_branding_theme_code** | **String** | Screen Branding Theme Code | [optional] |
1042
+ | **storefront_host_name** | **String** | StoreFront Host Name | [optional] |
1043
+ | **creation_date_begin** | **String** | Creation Date Begin | [optional] |
1044
+ | **creation_date_end** | **String** | Creation Date End | [optional] |
1045
+ | **payment_date_begin** | **String** | Payment Date Begin | [optional] |
1046
+ | **payment_date_end** | **String** | Payment Date End | [optional] |
1047
+ | **shipment_date_begin** | **String** | Shipment Date Begin | [optional] |
1048
+ | **shipment_date_end** | **String** | Shipment Date End | [optional] |
1049
+ | **rma** | **String** | RMA | [optional] |
1050
+ | **purchase_order_number** | **String** | Purchase Order Number | [optional] |
1051
+ | **item_id** | **String** | Item Id | [optional] |
1052
+ | **current_stage** | **String** | Current Stage | [optional] |
1053
+ | **channel_partner_code** | **String** | Channel Partner Code | [optional] |
1054
+ | **channel_partner_order_id** | **String** | Channel Partner Order ID | [optional] |
1055
+ | **_limit** | **Integer** | The maximum number of records to return on this one API call. (Maximum 200) | [optional][default to 100] |
1056
+ | **_offset** | **Integer** | Pagination of the record set. Offset is a zero based index. | [optional][default to 0] |
1057
+ | **_sort** | **String** | The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional] |
1058
+ | **_expand** | **String** | The object expansion to perform on the result. | [optional] |
1059
+
1060
+ ### Return type
1061
+
1062
+ [**OrdersResponse**](OrdersResponse.md)
1063
+
1064
+ ### Authorization
1065
+
1066
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1067
+
1068
+ ### HTTP request headers
1069
+
1070
+ - **Content-Type**: Not defined
1071
+ - **Accept**: application/json
1072
+
1073
+
1074
+ ## get_orders_batch
1075
+
1076
+ > <OrdersResponse> get_orders_batch(order_batch, opts)
1077
+
1078
+ Retrieve order batch
1079
+
1080
+ Retrieves a group of orders from the account based on an array of order ids. If more than 500 order ids are specified, the API call will fail with a bad request error.
1081
+
1082
+ ### Examples
1083
+
1084
+ ```ruby
1085
+ require 'time'
1086
+ require 'ultracart_api'
1087
+ # setup authorization
1088
+ UltracartClient.configure do |config|
1089
+ # Configure OAuth2 access token for authorization: ultraCartOauth
1090
+ config.access_token = 'YOUR ACCESS TOKEN'
1091
+
1092
+ # Configure API key authorization: ultraCartSimpleApiKey
1093
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1094
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1095
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1096
+ end
1097
+
1098
+ api_instance = UltracartClient::OrderApi.new
1099
+ order_batch = UltracartClient::OrderQueryBatch.new # OrderQueryBatch | Order batch
1100
+ opts = {
1101
+ _expand: '_expand_example' # String | The object expansion to perform on the result.
1102
+ }
1103
+
1104
+ begin
1105
+ # Retrieve order batch
1106
+ result = api_instance.get_orders_batch(order_batch, opts)
1107
+ p result
1108
+ rescue UltracartClient::ApiError => e
1109
+ puts "Error when calling OrderApi->get_orders_batch: #{e}"
1110
+ end
1111
+ ```
1112
+
1113
+ #### Using the get_orders_batch_with_http_info variant
1114
+
1115
+ This returns an Array which contains the response data, status code and headers.
1116
+
1117
+ > <Array(<OrdersResponse>, Integer, Hash)> get_orders_batch_with_http_info(order_batch, opts)
1118
+
1119
+ ```ruby
1120
+ begin
1121
+ # Retrieve order batch
1122
+ data, status_code, headers = api_instance.get_orders_batch_with_http_info(order_batch, opts)
1123
+ p status_code # => 2xx
1124
+ p headers # => { ... }
1125
+ p data # => <OrdersResponse>
1126
+ rescue UltracartClient::ApiError => e
1127
+ puts "Error when calling OrderApi->get_orders_batch_with_http_info: #{e}"
1128
+ end
1129
+ ```
1130
+
1131
+ ### Parameters
1132
+
1133
+ | Name | Type | Description | Notes |
1134
+ | ---- | ---- | ----------- | ----- |
1135
+ | **order_batch** | [**OrderQueryBatch**](OrderQueryBatch.md) | Order batch | |
1136
+ | **_expand** | **String** | The object expansion to perform on the result. | [optional] |
1137
+
1138
+ ### Return type
1139
+
1140
+ [**OrdersResponse**](OrdersResponse.md)
1141
+
1142
+ ### Authorization
1143
+
1144
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1145
+
1146
+ ### HTTP request headers
1147
+
1148
+ - **Content-Type**: application/json
1149
+ - **Accept**: application/json
1150
+
1151
+
1152
+ ## get_orders_by_query
1153
+
1154
+ > <OrdersResponse> get_orders_by_query(order_query, opts)
1155
+
1156
+ Retrieve orders by query
1157
+
1158
+ Retrieves a group of orders from the account based on a query object. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
1159
+
1160
+ ### Examples
1161
+
1162
+ ```ruby
1163
+ require 'time'
1164
+ require 'ultracart_api'
1165
+ # setup authorization
1166
+ UltracartClient.configure do |config|
1167
+ # Configure OAuth2 access token for authorization: ultraCartOauth
1168
+ config.access_token = 'YOUR ACCESS TOKEN'
1169
+
1170
+ # Configure API key authorization: ultraCartSimpleApiKey
1171
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1172
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1173
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1174
+ end
1175
+
1176
+ api_instance = UltracartClient::OrderApi.new
1177
+ order_query = UltracartClient::OrderQuery.new # OrderQuery | Order query
1178
+ opts = {
1179
+ _limit: 56, # Integer | The maximum number of records to return on this one API call. (Maximum 200)
1180
+ _offset: 56, # Integer | Pagination of the record set. Offset is a zero based index.
1181
+ _sort: '_sort_example', # String | The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
1182
+ _expand: '_expand_example' # String | The object expansion to perform on the result.
1183
+ }
1184
+
1185
+ begin
1186
+ # Retrieve orders by query
1187
+ result = api_instance.get_orders_by_query(order_query, opts)
1188
+ p result
1189
+ rescue UltracartClient::ApiError => e
1190
+ puts "Error when calling OrderApi->get_orders_by_query: #{e}"
1191
+ end
1192
+ ```
1193
+
1194
+ #### Using the get_orders_by_query_with_http_info variant
1195
+
1196
+ This returns an Array which contains the response data, status code and headers.
1197
+
1198
+ > <Array(<OrdersResponse>, Integer, Hash)> get_orders_by_query_with_http_info(order_query, opts)
1199
+
1200
+ ```ruby
1201
+ begin
1202
+ # Retrieve orders by query
1203
+ data, status_code, headers = api_instance.get_orders_by_query_with_http_info(order_query, opts)
1204
+ p status_code # => 2xx
1205
+ p headers # => { ... }
1206
+ p data # => <OrdersResponse>
1207
+ rescue UltracartClient::ApiError => e
1208
+ puts "Error when calling OrderApi->get_orders_by_query_with_http_info: #{e}"
1209
+ end
1210
+ ```
1211
+
1212
+ ### Parameters
1213
+
1214
+ | Name | Type | Description | Notes |
1215
+ | ---- | ---- | ----------- | ----- |
1216
+ | **order_query** | [**OrderQuery**](OrderQuery.md) | Order query | |
1217
+ | **_limit** | **Integer** | The maximum number of records to return on this one API call. (Maximum 200) | [optional][default to 100] |
1218
+ | **_offset** | **Integer** | Pagination of the record set. Offset is a zero based index. | [optional][default to 0] |
1219
+ | **_sort** | **String** | The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional] |
1220
+ | **_expand** | **String** | The object expansion to perform on the result. | [optional] |
1221
+
1222
+ ### Return type
1223
+
1224
+ [**OrdersResponse**](OrdersResponse.md)
1225
+
1226
+ ### Authorization
1227
+
1228
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1229
+
1230
+ ### HTTP request headers
1231
+
1232
+ - **Content-Type**: application/json
1233
+ - **Accept**: application/json
1234
+
1235
+
1236
+ ## insert_order
1237
+
1238
+ > <OrderResponse> insert_order(order, opts)
1239
+
1240
+ Insert an order
1241
+
1242
+ Inserts a new order on the UltraCart account. This is probably NOT the method you want. This is for channel orders. For regular orders the customer is entering, use the CheckoutApi. It has many, many more features, checks, and validations.
1243
+
1244
+ ### Examples
1245
+
1246
+ ```ruby
1247
+ require 'time'
1248
+ require 'ultracart_api'
1249
+ # setup authorization
1250
+ UltracartClient.configure do |config|
1251
+ # Configure OAuth2 access token for authorization: ultraCartOauth
1252
+ config.access_token = 'YOUR ACCESS TOKEN'
1253
+
1254
+ # Configure API key authorization: ultraCartSimpleApiKey
1255
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1256
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1257
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1258
+ end
1259
+
1260
+ api_instance = UltracartClient::OrderApi.new
1261
+ order = UltracartClient::Order.new # Order | Order to insert
1262
+ opts = {
1263
+ _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
1264
+ }
1265
+
1266
+ begin
1267
+ # Insert an order
1268
+ result = api_instance.insert_order(order, opts)
1269
+ p result
1270
+ rescue UltracartClient::ApiError => e
1271
+ puts "Error when calling OrderApi->insert_order: #{e}"
1272
+ end
1273
+ ```
1274
+
1275
+ #### Using the insert_order_with_http_info variant
1276
+
1277
+ This returns an Array which contains the response data, status code and headers.
1278
+
1279
+ > <Array(<OrderResponse>, Integer, Hash)> insert_order_with_http_info(order, opts)
1280
+
1281
+ ```ruby
1282
+ begin
1283
+ # Insert an order
1284
+ data, status_code, headers = api_instance.insert_order_with_http_info(order, opts)
1285
+ p status_code # => 2xx
1286
+ p headers # => { ... }
1287
+ p data # => <OrderResponse>
1288
+ rescue UltracartClient::ApiError => e
1289
+ puts "Error when calling OrderApi->insert_order_with_http_info: #{e}"
1290
+ end
1291
+ ```
1292
+
1293
+ ### Parameters
1294
+
1295
+ | Name | Type | Description | Notes |
1296
+ | ---- | ---- | ----------- | ----- |
1297
+ | **order** | [**Order**](Order.md) | Order to insert | |
1298
+ | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
1299
+
1300
+ ### Return type
1301
+
1302
+ [**OrderResponse**](OrderResponse.md)
1303
+
1304
+ ### Authorization
1305
+
1306
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1307
+
1308
+ ### HTTP request headers
1309
+
1310
+ - **Content-Type**: application/json; charset=UTF-8
1311
+ - **Accept**: application/json
1312
+
1313
+
1314
+ ## process_payment
1315
+
1316
+ > <OrderProcessPaymentResponse> process_payment(order_id, process_payment_request)
1317
+
1318
+ Process payment
1319
+
1320
+ Process payment on order
1321
+
1322
+ ### Examples
1323
+
1324
+ ```ruby
1325
+ require 'time'
1326
+ require 'ultracart_api'
1327
+ # setup authorization
1328
+ UltracartClient.configure do |config|
1329
+ # Configure OAuth2 access token for authorization: ultraCartOauth
1330
+ config.access_token = 'YOUR ACCESS TOKEN'
1331
+
1332
+ # Configure API key authorization: ultraCartSimpleApiKey
1333
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1334
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1335
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1336
+ end
1337
+
1338
+ api_instance = UltracartClient::OrderApi.new
1339
+ order_id = 'order_id_example' # String | The order id to process payment on
1340
+ process_payment_request = UltracartClient::OrderProcessPaymentRequest.new # OrderProcessPaymentRequest | Process payment parameters
1341
+
1342
+ begin
1343
+ # Process payment
1344
+ result = api_instance.process_payment(order_id, process_payment_request)
1345
+ p result
1346
+ rescue UltracartClient::ApiError => e
1347
+ puts "Error when calling OrderApi->process_payment: #{e}"
1348
+ end
1349
+ ```
1350
+
1351
+ #### Using the process_payment_with_http_info variant
1352
+
1353
+ This returns an Array which contains the response data, status code and headers.
1354
+
1355
+ > <Array(<OrderProcessPaymentResponse>, Integer, Hash)> process_payment_with_http_info(order_id, process_payment_request)
1356
+
1357
+ ```ruby
1358
+ begin
1359
+ # Process payment
1360
+ data, status_code, headers = api_instance.process_payment_with_http_info(order_id, process_payment_request)
1361
+ p status_code # => 2xx
1362
+ p headers # => { ... }
1363
+ p data # => <OrderProcessPaymentResponse>
1364
+ rescue UltracartClient::ApiError => e
1365
+ puts "Error when calling OrderApi->process_payment_with_http_info: #{e}"
1366
+ end
1367
+ ```
1368
+
1369
+ ### Parameters
1370
+
1371
+ | Name | Type | Description | Notes |
1372
+ | ---- | ---- | ----------- | ----- |
1373
+ | **order_id** | **String** | The order id to process payment on | |
1374
+ | **process_payment_request** | [**OrderProcessPaymentRequest**](OrderProcessPaymentRequest.md) | Process payment parameters | |
1375
+
1376
+ ### Return type
1377
+
1378
+ [**OrderProcessPaymentResponse**](OrderProcessPaymentResponse.md)
1379
+
1380
+ ### Authorization
1381
+
1382
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1383
+
1384
+ ### HTTP request headers
1385
+
1386
+ - **Content-Type**: application/json
1387
+ - **Accept**: application/json
1388
+
1389
+
1390
+ ## refund_order
1391
+
1392
+ > <OrderResponse> refund_order(order_id, order, opts)
1393
+
1394
+ Refund an order
1395
+
1396
+ Perform a refund operation on an order and then update the order if successful
1397
+
1398
+ ### Examples
1399
+
1400
+ ```ruby
1401
+ require 'time'
1402
+ require 'ultracart_api'
1403
+ # setup authorization
1404
+ UltracartClient.configure do |config|
1405
+ # Configure OAuth2 access token for authorization: ultraCartOauth
1406
+ config.access_token = 'YOUR ACCESS TOKEN'
1407
+
1408
+ # Configure API key authorization: ultraCartSimpleApiKey
1409
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1410
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1411
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1412
+ end
1413
+
1414
+ api_instance = UltracartClient::OrderApi.new
1415
+ order_id = 'order_id_example' # String | The order id to refund.
1416
+ order = UltracartClient::Order.new # Order | Order to refund
1417
+ opts = {
1418
+ reject_after_refund: true, # Boolean | Reject order after refund
1419
+ skip_customer_notification: true, # Boolean | Skip customer email notification
1420
+ auto_order_cancel: true, # Boolean | Cancel associated auto orders
1421
+ manual_refund: true, # Boolean | Consider a manual refund done externally
1422
+ reverse_affiliate_transactions: true, # Boolean | Reverse affiliate transactions
1423
+ _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
1424
+ }
1425
+
1426
+ begin
1427
+ # Refund an order
1428
+ result = api_instance.refund_order(order_id, order, opts)
1429
+ p result
1430
+ rescue UltracartClient::ApiError => e
1431
+ puts "Error when calling OrderApi->refund_order: #{e}"
1432
+ end
1433
+ ```
1434
+
1435
+ #### Using the refund_order_with_http_info variant
1436
+
1437
+ This returns an Array which contains the response data, status code and headers.
1438
+
1439
+ > <Array(<OrderResponse>, Integer, Hash)> refund_order_with_http_info(order_id, order, opts)
1440
+
1441
+ ```ruby
1442
+ begin
1443
+ # Refund an order
1444
+ data, status_code, headers = api_instance.refund_order_with_http_info(order_id, order, opts)
1445
+ p status_code # => 2xx
1446
+ p headers # => { ... }
1447
+ p data # => <OrderResponse>
1448
+ rescue UltracartClient::ApiError => e
1449
+ puts "Error when calling OrderApi->refund_order_with_http_info: #{e}"
1450
+ end
1451
+ ```
1452
+
1453
+ ### Parameters
1454
+
1455
+ | Name | Type | Description | Notes |
1456
+ | ---- | ---- | ----------- | ----- |
1457
+ | **order_id** | **String** | The order id to refund. | |
1458
+ | **order** | [**Order**](Order.md) | Order to refund | |
1459
+ | **reject_after_refund** | **Boolean** | Reject order after refund | [optional][default to false] |
1460
+ | **skip_customer_notification** | **Boolean** | Skip customer email notification | [optional][default to false] |
1461
+ | **auto_order_cancel** | **Boolean** | Cancel associated auto orders | [optional][default to false] |
1462
+ | **manual_refund** | **Boolean** | Consider a manual refund done externally | [optional][default to false] |
1463
+ | **reverse_affiliate_transactions** | **Boolean** | Reverse affiliate transactions | [optional][default to true] |
1464
+ | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
1465
+
1466
+ ### Return type
1467
+
1468
+ [**OrderResponse**](OrderResponse.md)
1469
+
1470
+ ### Authorization
1471
+
1472
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1473
+
1474
+ ### HTTP request headers
1475
+
1476
+ - **Content-Type**: application/json; charset=UTF-8
1477
+ - **Accept**: application/json
1478
+
1479
+
1480
+ ## replacement
1481
+
1482
+ > <OrderReplacementResponse> replacement(order_id, replacement)
1483
+
1484
+ Replacement order
1485
+
1486
+ Create a replacement order based upon a previous order
1487
+
1488
+ ### Examples
1489
+
1490
+ ```ruby
1491
+ require 'time'
1492
+ require 'ultracart_api'
1493
+ # setup authorization
1494
+ UltracartClient.configure do |config|
1495
+ # Configure OAuth2 access token for authorization: ultraCartOauth
1496
+ config.access_token = 'YOUR ACCESS TOKEN'
1497
+
1498
+ # Configure API key authorization: ultraCartSimpleApiKey
1499
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1500
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1501
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1502
+ end
1503
+
1504
+ api_instance = UltracartClient::OrderApi.new
1505
+ order_id = 'order_id_example' # String | The order id to generate a replacement for.
1506
+ replacement = UltracartClient::OrderReplacement.new # OrderReplacement | Replacement order details
1507
+
1508
+ begin
1509
+ # Replacement order
1510
+ result = api_instance.replacement(order_id, replacement)
1511
+ p result
1512
+ rescue UltracartClient::ApiError => e
1513
+ puts "Error when calling OrderApi->replacement: #{e}"
1514
+ end
1515
+ ```
1516
+
1517
+ #### Using the replacement_with_http_info variant
1518
+
1519
+ This returns an Array which contains the response data, status code and headers.
1520
+
1521
+ > <Array(<OrderReplacementResponse>, Integer, Hash)> replacement_with_http_info(order_id, replacement)
1522
+
1523
+ ```ruby
1524
+ begin
1525
+ # Replacement order
1526
+ data, status_code, headers = api_instance.replacement_with_http_info(order_id, replacement)
1527
+ p status_code # => 2xx
1528
+ p headers # => { ... }
1529
+ p data # => <OrderReplacementResponse>
1530
+ rescue UltracartClient::ApiError => e
1531
+ puts "Error when calling OrderApi->replacement_with_http_info: #{e}"
1532
+ end
1533
+ ```
1534
+
1535
+ ### Parameters
1536
+
1537
+ | Name | Type | Description | Notes |
1538
+ | ---- | ---- | ----------- | ----- |
1539
+ | **order_id** | **String** | The order id to generate a replacement for. | |
1540
+ | **replacement** | [**OrderReplacement**](OrderReplacement.md) | Replacement order details | |
1541
+
1542
+ ### Return type
1543
+
1544
+ [**OrderReplacementResponse**](OrderReplacementResponse.md)
1545
+
1546
+ ### Authorization
1547
+
1548
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1549
+
1550
+ ### HTTP request headers
1551
+
1552
+ - **Content-Type**: application/json
1553
+ - **Accept**: application/json
1554
+
1555
+
1556
+ ## resend_receipt
1557
+
1558
+ > <BaseResponse> resend_receipt(order_id)
1559
+
1560
+ Resend receipt
1561
+
1562
+ Resend the receipt for an order on the UltraCart account.
1563
+
1564
+ ### Examples
1565
+
1566
+ ```ruby
1567
+ require 'time'
1568
+ require 'ultracart_api'
1569
+ # setup authorization
1570
+ UltracartClient.configure do |config|
1571
+ # Configure OAuth2 access token for authorization: ultraCartOauth
1572
+ config.access_token = 'YOUR ACCESS TOKEN'
1573
+
1574
+ # Configure API key authorization: ultraCartSimpleApiKey
1575
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1576
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1577
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1578
+ end
1579
+
1580
+ api_instance = UltracartClient::OrderApi.new
1581
+ order_id = 'order_id_example' # String | The order id to resend the receipt for.
1582
+
1583
+ begin
1584
+ # Resend receipt
1585
+ result = api_instance.resend_receipt(order_id)
1586
+ p result
1587
+ rescue UltracartClient::ApiError => e
1588
+ puts "Error when calling OrderApi->resend_receipt: #{e}"
1589
+ end
1590
+ ```
1591
+
1592
+ #### Using the resend_receipt_with_http_info variant
1593
+
1594
+ This returns an Array which contains the response data, status code and headers.
1595
+
1596
+ > <Array(<BaseResponse>, Integer, Hash)> resend_receipt_with_http_info(order_id)
1597
+
1598
+ ```ruby
1599
+ begin
1600
+ # Resend receipt
1601
+ data, status_code, headers = api_instance.resend_receipt_with_http_info(order_id)
1602
+ p status_code # => 2xx
1603
+ p headers # => { ... }
1604
+ p data # => <BaseResponse>
1605
+ rescue UltracartClient::ApiError => e
1606
+ puts "Error when calling OrderApi->resend_receipt_with_http_info: #{e}"
1607
+ end
1608
+ ```
1609
+
1610
+ ### Parameters
1611
+
1612
+ | Name | Type | Description | Notes |
1613
+ | ---- | ---- | ----------- | ----- |
1614
+ | **order_id** | **String** | The order id to resend the receipt for. | |
1615
+
1616
+ ### Return type
1617
+
1618
+ [**BaseResponse**](BaseResponse.md)
1619
+
1620
+ ### Authorization
1621
+
1622
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1623
+
1624
+ ### HTTP request headers
1625
+
1626
+ - **Content-Type**: Not defined
1627
+ - **Accept**: application/json
1628
+
1629
+
1630
+ ## resend_shipment_confirmation
1631
+
1632
+ > <BaseResponse> resend_shipment_confirmation(order_id)
1633
+
1634
+ Resend shipment confirmation
1635
+
1636
+ Resend shipment confirmation for an order on the UltraCart account.
1637
+
1638
+ ### Examples
1639
+
1640
+ ```ruby
1641
+ require 'time'
1642
+ require 'ultracart_api'
1643
+ # setup authorization
1644
+ UltracartClient.configure do |config|
1645
+ # Configure OAuth2 access token for authorization: ultraCartOauth
1646
+ config.access_token = 'YOUR ACCESS TOKEN'
1647
+
1648
+ # Configure API key authorization: ultraCartSimpleApiKey
1649
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1650
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1651
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1652
+ end
1653
+
1654
+ api_instance = UltracartClient::OrderApi.new
1655
+ order_id = 'order_id_example' # String | The order id to resend the shipment notification for.
1656
+
1657
+ begin
1658
+ # Resend shipment confirmation
1659
+ result = api_instance.resend_shipment_confirmation(order_id)
1660
+ p result
1661
+ rescue UltracartClient::ApiError => e
1662
+ puts "Error when calling OrderApi->resend_shipment_confirmation: #{e}"
1663
+ end
1664
+ ```
1665
+
1666
+ #### Using the resend_shipment_confirmation_with_http_info variant
1667
+
1668
+ This returns an Array which contains the response data, status code and headers.
1669
+
1670
+ > <Array(<BaseResponse>, Integer, Hash)> resend_shipment_confirmation_with_http_info(order_id)
1671
+
1672
+ ```ruby
1673
+ begin
1674
+ # Resend shipment confirmation
1675
+ data, status_code, headers = api_instance.resend_shipment_confirmation_with_http_info(order_id)
1676
+ p status_code # => 2xx
1677
+ p headers # => { ... }
1678
+ p data # => <BaseResponse>
1679
+ rescue UltracartClient::ApiError => e
1680
+ puts "Error when calling OrderApi->resend_shipment_confirmation_with_http_info: #{e}"
1681
+ end
1682
+ ```
1683
+
1684
+ ### Parameters
1685
+
1686
+ | Name | Type | Description | Notes |
1687
+ | ---- | ---- | ----------- | ----- |
1688
+ | **order_id** | **String** | The order id to resend the shipment notification for. | |
1689
+
1690
+ ### Return type
1691
+
1692
+ [**BaseResponse**](BaseResponse.md)
1693
+
1694
+ ### Authorization
1695
+
1696
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1697
+
1698
+ ### HTTP request headers
1699
+
1700
+ - **Content-Type**: Not defined
1701
+ - **Accept**: application/json
1702
+
1703
+
1704
+ ## update_accounts_receivable_retry_config
1705
+
1706
+ > <BaseResponse> update_accounts_receivable_retry_config(retry_config)
1707
+
1708
+ Update A/R Retry Configuration
1709
+
1710
+ Update A/R Retry Configuration. This is primarily an internal API call. It is doubtful you would ever need to use it.
1711
+
1712
+ ### Examples
1713
+
1714
+ ```ruby
1715
+ require 'time'
1716
+ require 'ultracart_api'
1717
+ # setup authorization
1718
+ UltracartClient.configure do |config|
1719
+ # Configure OAuth2 access token for authorization: ultraCartOauth
1720
+ config.access_token = 'YOUR ACCESS TOKEN'
1721
+
1722
+ # Configure API key authorization: ultraCartSimpleApiKey
1723
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1724
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1725
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1726
+ end
1727
+
1728
+ api_instance = UltracartClient::OrderApi.new
1729
+ retry_config = UltracartClient::AccountsReceivableRetryConfig.new # AccountsReceivableRetryConfig | AccountsReceivableRetryConfig object
1730
+
1731
+ begin
1732
+ # Update A/R Retry Configuration
1733
+ result = api_instance.update_accounts_receivable_retry_config(retry_config)
1734
+ p result
1735
+ rescue UltracartClient::ApiError => e
1736
+ puts "Error when calling OrderApi->update_accounts_receivable_retry_config: #{e}"
1737
+ end
1738
+ ```
1739
+
1740
+ #### Using the update_accounts_receivable_retry_config_with_http_info variant
1741
+
1742
+ This returns an Array which contains the response data, status code and headers.
1743
+
1744
+ > <Array(<BaseResponse>, Integer, Hash)> update_accounts_receivable_retry_config_with_http_info(retry_config)
1745
+
1746
+ ```ruby
1747
+ begin
1748
+ # Update A/R Retry Configuration
1749
+ data, status_code, headers = api_instance.update_accounts_receivable_retry_config_with_http_info(retry_config)
1750
+ p status_code # => 2xx
1751
+ p headers # => { ... }
1752
+ p data # => <BaseResponse>
1753
+ rescue UltracartClient::ApiError => e
1754
+ puts "Error when calling OrderApi->update_accounts_receivable_retry_config_with_http_info: #{e}"
1755
+ end
1756
+ ```
1757
+
1758
+ ### Parameters
1759
+
1760
+ | Name | Type | Description | Notes |
1761
+ | ---- | ---- | ----------- | ----- |
1762
+ | **retry_config** | [**AccountsReceivableRetryConfig**](AccountsReceivableRetryConfig.md) | AccountsReceivableRetryConfig object | |
1763
+
1764
+ ### Return type
1765
+
1766
+ [**BaseResponse**](BaseResponse.md)
1767
+
1768
+ ### Authorization
1769
+
1770
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1771
+
1772
+ ### HTTP request headers
1773
+
1774
+ - **Content-Type**: application/json
1775
+ - **Accept**: application/json
1776
+
1777
+
1778
+ ## update_order
1779
+
1780
+ > <OrderResponse> update_order(order_id, order, opts)
1781
+
1782
+ Update an order
1783
+
1784
+ Update a new order on the UltraCart account. This is probably NOT the method you want. It is rare to update a completed order. This will not trigger charges, emails, or any other automation.
1785
+
1786
+ ### Examples
1787
+
1788
+ ```ruby
1789
+ require 'time'
1790
+ require 'ultracart_api'
1791
+ # setup authorization
1792
+ UltracartClient.configure do |config|
1793
+ # Configure OAuth2 access token for authorization: ultraCartOauth
1794
+ config.access_token = 'YOUR ACCESS TOKEN'
1795
+
1796
+ # Configure API key authorization: ultraCartSimpleApiKey
1797
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1798
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1799
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1800
+ end
1801
+
1802
+ api_instance = UltracartClient::OrderApi.new
1803
+ order_id = 'order_id_example' # String | The order id to update.
1804
+ order = UltracartClient::Order.new # Order | Order to update
1805
+ opts = {
1806
+ _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
1807
+ }
1808
+
1809
+ begin
1810
+ # Update an order
1811
+ result = api_instance.update_order(order_id, order, opts)
1812
+ p result
1813
+ rescue UltracartClient::ApiError => e
1814
+ puts "Error when calling OrderApi->update_order: #{e}"
1815
+ end
1816
+ ```
1817
+
1818
+ #### Using the update_order_with_http_info variant
1819
+
1820
+ This returns an Array which contains the response data, status code and headers.
1821
+
1822
+ > <Array(<OrderResponse>, Integer, Hash)> update_order_with_http_info(order_id, order, opts)
1823
+
1824
+ ```ruby
1825
+ begin
1826
+ # Update an order
1827
+ data, status_code, headers = api_instance.update_order_with_http_info(order_id, order, opts)
1828
+ p status_code # => 2xx
1829
+ p headers # => { ... }
1830
+ p data # => <OrderResponse>
1831
+ rescue UltracartClient::ApiError => e
1832
+ puts "Error when calling OrderApi->update_order_with_http_info: #{e}"
1833
+ end
1834
+ ```
1835
+
1836
+ ### Parameters
1837
+
1838
+ | Name | Type | Description | Notes |
1839
+ | ---- | ---- | ----------- | ----- |
1840
+ | **order_id** | **String** | The order id to update. | |
1841
+ | **order** | [**Order**](Order.md) | Order to update | |
1842
+ | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
1843
+
1844
+ ### Return type
1845
+
1846
+ [**OrderResponse**](OrderResponse.md)
1847
+
1848
+ ### Authorization
1849
+
1850
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1851
+
1852
+ ### HTTP request headers
1853
+
1854
+ - **Content-Type**: application/json; charset=UTF-8
1855
+ - **Accept**: application/json
1856
+