ultracart_api 3.0.74
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +7 -0
- data/LICENSE +201 -0
- data/README.md +1055 -0
- data/Rakefile +8 -0
- data/docs/AccountsReceivableRetryConfig.md +21 -0
- data/docs/AccountsReceivableRetryConfigResponse.md +15 -0
- data/docs/AccountsReceivableRetryDayActivity.md +10 -0
- data/docs/AccountsReceivableRetryStatAccount.md +11 -0
- data/docs/AccountsReceivableRetryStatMetrics.md +18 -0
- data/docs/AccountsReceivableRetryStatRevenue.md +9 -0
- data/docs/AccountsReceivableRetryStatsResponse.md +13 -0
- data/docs/Activity.md +13 -0
- data/docs/AddLibraryItemRequest.md +18 -0
- data/docs/AffiliateApi.md +140 -0
- data/docs/AffiliateClick.md +18 -0
- data/docs/AffiliateClickQuery.md +13 -0
- data/docs/AffiliateClicksResponse.md +12 -0
- data/docs/AffiliateLedger.md +25 -0
- data/docs/AffiliateLedgerQuery.md +13 -0
- data/docs/AffiliateLedgersResponse.md +12 -0
- data/docs/AffiliateLink.md +21 -0
- data/docs/ApiUserApplicationProfile.md +12 -0
- data/docs/ApplyLibraryItemRequest.md +10 -0
- data/docs/ApplyLibraryItemResponse.md +18 -0
- data/docs/AutoOrder.md +27 -0
- data/docs/AutoOrderApi.md +558 -0
- data/docs/AutoOrderItem.md +31 -0
- data/docs/AutoOrderItemFutureSchedule.md +11 -0
- data/docs/AutoOrderItemOption.md +9 -0
- data/docs/AutoOrderItemSimpleSchedule.md +10 -0
- data/docs/AutoOrderQuery.md +26 -0
- data/docs/AutoOrderQueryBatch.md +8 -0
- data/docs/AutoOrderResponse.md +12 -0
- data/docs/AutoOrdersRequest.md +8 -0
- data/docs/AutoOrdersResponse.md +12 -0
- data/docs/AvalaraConfig.md +20 -0
- data/docs/BaseResponse.md +11 -0
- data/docs/Cart.md +32 -0
- data/docs/CartAffiliate.md +9 -0
- data/docs/CartAffirmCheckoutResponse.md +9 -0
- data/docs/CartBilling.md +22 -0
- data/docs/CartBuysafe.md +13 -0
- data/docs/CartCheckout.md +21 -0
- data/docs/CartCoupon.md +8 -0
- data/docs/CartCurrencyConversion.md +9 -0
- data/docs/CartCustomerProfile.md +29 -0
- data/docs/CartCustomerProfileAddress.md +21 -0
- data/docs/CartCustomerProfileCreditCard.md +13 -0
- data/docs/CartFinalizeOrderRequest.md +9 -0
- data/docs/CartFinalizeOrderRequestOptions.md +20 -0
- data/docs/CartFinalizeOrderResponse.md +12 -0
- data/docs/CartGift.md +13 -0
- data/docs/CartGiftCertificate.md +10 -0
- data/docs/CartItem.md +36 -0
- data/docs/CartItemAttribute.md +10 -0
- data/docs/CartItemMultimedia.md +16 -0
- data/docs/CartItemMultimediaThumbnail.md +12 -0
- data/docs/CartItemOption.md +19 -0
- data/docs/CartItemOptionValue.md +12 -0
- data/docs/CartItemPhysical.md +11 -0
- data/docs/CartItemVariationSelection.md +9 -0
- data/docs/CartKitComponentOption.md +21 -0
- data/docs/CartMarketing.md +9 -0
- data/docs/CartPayment.md +14 -0
- data/docs/CartPaymentAffirm.md +8 -0
- data/docs/CartPaymentAmazon.md +8 -0
- data/docs/CartPaymentCheck.md +8 -0
- data/docs/CartPaymentCreditCard.md +16 -0
- data/docs/CartPaymentPurchaseOrder.md +8 -0
- data/docs/CartProfileLoginRequest.md +10 -0
- data/docs/CartProfileLoginResponse.md +9 -0
- data/docs/CartProfileRegisterRequest.md +9 -0
- data/docs/CartProfileRegisterResponse.md +9 -0
- data/docs/CartProperty.md +11 -0
- data/docs/CartResponse.md +9 -0
- data/docs/CartSettings.md +13 -0
- data/docs/CartSettingsBilling.md +8 -0
- data/docs/CartSettingsGift.md +11 -0
- data/docs/CartSettingsGiftWrap.md +10 -0
- data/docs/CartSettingsPayment.md +20 -0
- data/docs/CartSettingsPaymentAmazon.md +10 -0
- data/docs/CartSettingsPaymentCreditCard.md +10 -0
- data/docs/CartSettingsPaymentPayPal.md +12 -0
- data/docs/CartSettingsProvince.md +9 -0
- data/docs/CartSettingsShipping.md +12 -0
- data/docs/CartSettingsShippingCalendar.md +12 -0
- data/docs/CartSettingsShippingEstimate.md +20 -0
- data/docs/CartSettingsTaxes.md +8 -0
- data/docs/CartSettingsTerms.md +9 -0
- data/docs/CartShipping.md +26 -0
- data/docs/CartSummary.md +23 -0
- data/docs/CartTaxes.md +10 -0
- data/docs/CartUpsellAfter.md +10 -0
- data/docs/CartValidationRequest.md +9 -0
- data/docs/CartValidationResponse.md +9 -0
- data/docs/ChargebackApi.md +336 -0
- data/docs/ChargebackDispute.md +30 -0
- data/docs/ChargebackDisputeResponse.md +12 -0
- data/docs/ChargebackDisputesResponse.md +12 -0
- data/docs/CheckoutAllowedCountriesResponse.md +8 -0
- data/docs/CheckoutApi.md +1240 -0
- data/docs/CheckoutHandoffRequest.md +15 -0
- data/docs/CheckoutHandoffResponse.md +10 -0
- data/docs/CheckoutSetupBrowserKeyRequest.md +8 -0
- data/docs/CheckoutSetupBrowserKeyResponse.md +8 -0
- data/docs/CheckoutStateProvinceResponse.md +8 -0
- data/docs/CityStateZip.md +12 -0
- data/docs/CountriesResponse.md +8 -0
- data/docs/Country.md +9 -0
- data/docs/Coupon.md +63 -0
- data/docs/CouponAmountOffItems.md +11 -0
- data/docs/CouponAmountOffShipping.md +10 -0
- data/docs/CouponAmountOffShippingWithItemsPurchase.md +11 -0
- data/docs/CouponAmountOffSubtotal.md +9 -0
- data/docs/CouponAmountOffSubtotalAndShipping.md +9 -0
- data/docs/CouponAmountOffSubtotalFreeShippingWithPurchase.md +11 -0
- data/docs/CouponAmountOffSubtotalWithBlockPurchase.md +11 -0
- data/docs/CouponAmountOffSubtotalWithItemsPurchase.md +11 -0
- data/docs/CouponApi.md +1174 -0
- data/docs/CouponAutoApplyCondition.md +10 -0
- data/docs/CouponAutoApplyConditions.md +13 -0
- data/docs/CouponAutomaticallyApplyCouponCodes.md +8 -0
- data/docs/CouponBuyOneGetOneLimit.md +9 -0
- data/docs/CouponCodesRequest.md +14 -0
- data/docs/CouponCodesResponse.md +13 -0
- data/docs/CouponDeletesRequest.md +9 -0
- data/docs/CouponDiscountItemWithItemPurchase.md +12 -0
- data/docs/CouponDiscountItems.md +11 -0
- data/docs/CouponEditorValues.md +17 -0
- data/docs/CouponExistsResponse.md +13 -0
- data/docs/CouponFreeItemAndShippingWithSubtotal.md +12 -0
- data/docs/CouponFreeItemWithItemPurchase.md +11 -0
- data/docs/CouponFreeItemWithSubtotal.md +11 -0
- data/docs/CouponFreeItemsWithItemPurchase.md +12 -0
- data/docs/CouponFreeItemsWithMixMatchPurchase.md +12 -0
- data/docs/CouponFreeShipping.md +8 -0
- data/docs/CouponFreeShippingSpecificItems.md +8 -0
- data/docs/CouponFreeShippingWithItemsPurchase.md +9 -0
- data/docs/CouponFreeShippingWithSubtotal.md +10 -0
- data/docs/CouponItemSearchResult.md +15 -0
- data/docs/CouponItemSearchResultsResponse.md +12 -0
- data/docs/CouponMultipleAmountsOffItems.md +9 -0
- data/docs/CouponNoDiscount.md +7 -0
- data/docs/CouponPercentOffItemWithItemsQuantityPurchase.md +12 -0
- data/docs/CouponPercentOffItems.md +11 -0
- data/docs/CouponPercentOffItemsAndFreeShipping.md +10 -0
- data/docs/CouponPercentOffItemsWithItemsPurchase.md +11 -0
- data/docs/CouponPercentOffRetailPriceItems.md +11 -0
- data/docs/CouponPercentOffShipping.md +9 -0
- data/docs/CouponPercentOffSubtotal.md +8 -0
- data/docs/CouponPercentOffSubtotalAndFreeShipping.md +9 -0
- data/docs/CouponPercentOffSubtotalLimit.md +10 -0
- data/docs/CouponPercentOffSubtotalWithItemsPurchase.md +9 -0
- data/docs/CouponPercentOffSubtotalWithSubtotal.md +10 -0
- data/docs/CouponQuery.md +16 -0
- data/docs/CouponResponse.md +12 -0
- data/docs/CouponRestriction.md +11 -0
- data/docs/CouponTierAmount.md +9 -0
- data/docs/CouponTierItemDiscount.md +9 -0
- data/docs/CouponTierPercent.md +9 -0
- data/docs/CouponTierQuantityAmount.md +9 -0
- data/docs/CouponTierQuantityPercent.md +9 -0
- data/docs/CouponTieredAmountOffItem.md +10 -0
- data/docs/CouponTieredAmountOffSubtotal.md +9 -0
- data/docs/CouponTieredPercentOffItems.md +10 -0
- data/docs/CouponTieredPercentOffShipping.md +9 -0
- data/docs/CouponTieredPercentOffSubtotal.md +9 -0
- data/docs/CouponType.md +9 -0
- data/docs/CouponsRequest.md +8 -0
- data/docs/CouponsResponse.md +12 -0
- data/docs/Currency.md +12 -0
- data/docs/Customer.md +65 -0
- data/docs/CustomerActivity.md +11 -0
- data/docs/CustomerAffiliate.md +9 -0
- data/docs/CustomerApi.md +670 -0
- data/docs/CustomerAttachment.md +12 -0
- data/docs/CustomerBilling.md +24 -0
- data/docs/CustomerCard.md +15 -0
- data/docs/CustomerEditorValues.md +15 -0
- data/docs/CustomerEmail.md +13 -0
- data/docs/CustomerEmailListChanges.md +9 -0
- data/docs/CustomerLoyalty.md +10 -0
- data/docs/CustomerLoyaltyLedger.md +22 -0
- data/docs/CustomerLoyaltyRedemption.md +20 -0
- data/docs/CustomerOrdersSummary.md +11 -0
- data/docs/CustomerPricingTier.md +9 -0
- data/docs/CustomerPrivacy.md +11 -0
- data/docs/CustomerQuery.md +36 -0
- data/docs/CustomerQuotesSummary.md +11 -0
- data/docs/CustomerResponse.md +12 -0
- data/docs/CustomerReviewer.md +17 -0
- data/docs/CustomerShipping.md +24 -0
- data/docs/CustomerSoftwareEntitlement.md +15 -0
- data/docs/CustomerTag.md +8 -0
- data/docs/CustomerTaxCodes.md +12 -0
- data/docs/CustomersResponse.md +12 -0
- data/docs/DataTablesServerSideResponse.md +11 -0
- data/docs/Distance.md +9 -0
- data/docs/DistributionCenter.md +41 -0
- data/docs/DistributionCentersResponse.md +12 -0
- data/docs/EmailBaseTemplateListResponse.md +8 -0
- data/docs/EmailCampaign.md +30 -0
- data/docs/EmailCampaignFolder.md +12 -0
- data/docs/EmailCampaignFolderResponse.md +12 -0
- data/docs/EmailCampaignFoldersResponse.md +12 -0
- data/docs/EmailCampaignResponse.md +12 -0
- data/docs/EmailCampaignsResponse.md +12 -0
- data/docs/EmailClick.md +9 -0
- data/docs/EmailClicksResponse.md +12 -0
- data/docs/EmailCommseq.md +11 -0
- data/docs/EmailCommseqEmail.md +31 -0
- data/docs/EmailCommseqEmailResponse.md +12 -0
- data/docs/EmailCommseqEmailSendTestRequest.md +17 -0
- data/docs/EmailCommseqEmailSendTestResponse.md +11 -0
- data/docs/EmailCommseqEmailsRequest.md +12 -0
- data/docs/EmailCommseqEmailsResponse.md +12 -0
- data/docs/EmailCommseqPostcard.md +18 -0
- data/docs/EmailCommseqPostcardResponse.md +12 -0
- data/docs/EmailCommseqPostcardSendTestRequest.md +19 -0
- data/docs/EmailCommseqPostcardSendTestResponse.md +14 -0
- data/docs/EmailCommseqPostcardsRequest.md +8 -0
- data/docs/EmailCommseqPostcardsResponse.md +12 -0
- data/docs/EmailCommseqResponse.md +12 -0
- data/docs/EmailCommseqStat.md +44 -0
- data/docs/EmailCommseqStatResponse.md +12 -0
- data/docs/EmailCommseqStep.md +17 -0
- data/docs/EmailCommseqsResponse.md +12 -0
- data/docs/EmailCustomer.md +15 -0
- data/docs/EmailCustomerEditorUrlResponse.md +12 -0
- data/docs/EmailCustomersResponse.md +12 -0
- data/docs/EmailDashboardActivity.md +14 -0
- data/docs/EmailDashboardActivityResponse.md +12 -0
- data/docs/EmailDashboardStatsResponse.md +12 -0
- data/docs/EmailDomain.md +18 -0
- data/docs/EmailEditorTokenResponse.md +12 -0
- data/docs/EmailFlow.md +34 -0
- data/docs/EmailFlowBackPopulateRequest.md +9 -0
- data/docs/EmailFlowBackPopulateResponse.md +11 -0
- data/docs/EmailFlowFolder.md +12 -0
- data/docs/EmailFlowFolderResponse.md +12 -0
- data/docs/EmailFlowFoldersResponse.md +12 -0
- data/docs/EmailFlowResponse.md +12 -0
- data/docs/EmailFlowsResponse.md +12 -0
- data/docs/EmailGlobalSettings.md +8 -0
- data/docs/EmailGlobalSettingsResponse.md +12 -0
- data/docs/EmailGlobalUnsubscribeRequest.md +8 -0
- data/docs/EmailGlobalUnsubscribeResponse.md +8 -0
- data/docs/EmailHistogramPropertyNamesResponse.md +8 -0
- data/docs/EmailHistogramPropertyValuesResponse.md +8 -0
- data/docs/EmailList.md +18 -0
- data/docs/EmailListArchiveResponse.md +12 -0
- data/docs/EmailListCustomer.md +11 -0
- data/docs/EmailListCustomersResponse.md +12 -0
- data/docs/EmailListResponse.md +12 -0
- data/docs/EmailListSegmentMembership.md +11 -0
- data/docs/EmailListSegmentUsedBy.md +10 -0
- data/docs/EmailListSubscribeResponse.md +9 -0
- data/docs/EmailListsResponse.md +12 -0
- data/docs/EmailOrder.md +11 -0
- data/docs/EmailOrdersResponse.md +12 -0
- data/docs/EmailPerformance.md +29 -0
- data/docs/EmailPerformanceCustomerHistogram.md +8 -0
- data/docs/EmailPerformanceCustomerHistogramPeriod.md +12 -0
- data/docs/EmailPerformanceDaily.md +14 -0
- data/docs/EmailPerformanceResponse.md +12 -0
- data/docs/EmailPlan.md +23 -0
- data/docs/EmailPlanAdditional.md +13 -0
- data/docs/EmailPlanResponse.md +12 -0
- data/docs/EmailPostcardStat.md +39 -0
- data/docs/EmailSegment.md +21 -0
- data/docs/EmailSegmentArchiveResponse.md +12 -0
- data/docs/EmailSegmentCustomer.md +11 -0
- data/docs/EmailSegmentCustomersResponse.md +12 -0
- data/docs/EmailSegmentDownloadPrepareResponse.md +15 -0
- data/docs/EmailSegmentResponse.md +12 -0
- data/docs/EmailSegmentsResponse.md +12 -0
- data/docs/EmailSendingDomainResponse.md +12 -0
- data/docs/EmailSendingDomainsResponse.md +12 -0
- data/docs/EmailSettings.md +19 -0
- data/docs/EmailSettingsResponse.md +12 -0
- data/docs/EmailStat.md +45 -0
- data/docs/EmailStatPostcardSummaryRequest.md +9 -0
- data/docs/EmailStatPostcardSummaryResponse.md +12 -0
- data/docs/EmailStatSummaryRequest.md +10 -0
- data/docs/EmailStatSummaryResponse.md +12 -0
- data/docs/EmailStepStat.md +27 -0
- data/docs/EmailStepStatRequest.md +9 -0
- data/docs/EmailStepStatResponse.md +12 -0
- data/docs/EmailStepWaitingRequest.md +8 -0
- data/docs/EmailStepWaitingResponse.md +8 -0
- data/docs/EmailTemplate.md +18 -0
- data/docs/EmailTemplatesResponse.md +12 -0
- data/docs/EmailThirdPartyList.md +9 -0
- data/docs/EmailThirdPartyListImportRequest.md +8 -0
- data/docs/EmailThirdPartyProvider.md +16 -0
- data/docs/EmailThirdPartyProvidersResponse.md +12 -0
- data/docs/Error.md +11 -0
- data/docs/ErrorResponse.md +11 -0
- data/docs/Experiment.md +25 -0
- data/docs/ExperimentResponse.md +12 -0
- data/docs/ExperimentVariation.md +26 -0
- data/docs/ExperimentsResponse.md +12 -0
- data/docs/FulfillmentApi.md +298 -0
- data/docs/FulfillmentInventory.md +9 -0
- data/docs/FulfillmentShipment.md +12 -0
- data/docs/GeoPoint.md +9 -0
- data/docs/GeocodeRequest.md +12 -0
- data/docs/GeocodeResponse.md +13 -0
- data/docs/Group.md +12 -0
- data/docs/GroupResponse.md +12 -0
- data/docs/GroupUserMembership.md +12 -0
- data/docs/GroupsResponse.md +12 -0
- data/docs/HTTPHeader.md +9 -0
- data/docs/Item.md +57 -0
- data/docs/ItemAccounting.md +9 -0
- data/docs/ItemAmember.md +9 -0
- data/docs/ItemApi.md +580 -0
- data/docs/ItemAutoOrder.md +23 -0
- data/docs/ItemAutoOrderStep.md +22 -0
- data/docs/ItemAutoOrderStepArbitraryUnitCostSchedule.md +9 -0
- data/docs/ItemAutoOrderStepGrandfatherPricing.md +9 -0
- data/docs/ItemCCBill.md +13 -0
- data/docs/ItemChannelPartnerMapping.md +25 -0
- data/docs/ItemChargeback.md +9 -0
- data/docs/ItemChargebackAddendum.md +11 -0
- data/docs/ItemChargebackAdjustmentRequest.md +10 -0
- data/docs/ItemCheckout.md +10 -0
- data/docs/ItemContent.md +19 -0
- data/docs/ItemContentAssignment.md +12 -0
- data/docs/ItemContentAttribute.md +11 -0
- data/docs/ItemContentMultimedia.md +22 -0
- data/docs/ItemContentMultimediaThumbnail.md +13 -0
- data/docs/ItemDigitalDelivery.md +13 -0
- data/docs/ItemDigitalItem.md +12 -0
- data/docs/ItemEbay.md +76 -0
- data/docs/ItemEbayCategorySpecific.md +9 -0
- data/docs/ItemEbayMarketListing.md +12 -0
- data/docs/ItemEbayMarketPlaceAnalysis.md +17 -0
- data/docs/ItemEmailNotifications.md +9 -0
- data/docs/ItemEnrollment123.md +8 -0
- data/docs/ItemGiftCertificate.md +9 -0
- data/docs/ItemGoogleProductSearch.md +55 -0
- data/docs/ItemIdentifiers.md +11 -0
- data/docs/ItemInstantPaymentNotification.md +10 -0
- data/docs/ItemInstantPaymentNotifications.md +8 -0
- data/docs/ItemInternal.md +8 -0
- data/docs/ItemKitComponent.md +12 -0
- data/docs/ItemKitDefinition.md +8 -0
- data/docs/ItemOption.md +21 -0
- data/docs/ItemOptionValue.md +22 -0
- data/docs/ItemOptionValueAdditionalItem.md +9 -0
- data/docs/ItemOptionValueDigitalItem.md +9 -0
- data/docs/ItemPaymentProcessing.md +12 -0
- data/docs/ItemPhysical.md +11 -0
- data/docs/ItemPricing.md +25 -0
- data/docs/ItemPricingTier.md +12 -0
- data/docs/ItemPricingTierDiscount.md +9 -0
- data/docs/ItemPricingTierLimit.md +10 -0
- data/docs/ItemProperty.md +10 -0
- data/docs/ItemRealtimePricing.md +10 -0
- data/docs/ItemRelated.md +10 -0
- data/docs/ItemRelatedItem.md +10 -0
- data/docs/ItemReporting.md +9 -0
- data/docs/ItemResponse.md +12 -0
- data/docs/ItemRestriction.md +15 -0
- data/docs/ItemRestrictionItem.md +10 -0
- data/docs/ItemRevguard.md +14 -0
- data/docs/ItemReviews.md +14 -0
- data/docs/ItemSalesforce.md +9 -0
- data/docs/ItemShipping.md +55 -0
- data/docs/ItemShippingCase.md +11 -0
- data/docs/ItemShippingDestinationMarkup.md +13 -0
- data/docs/ItemShippingDestinationRestriction.md +10 -0
- data/docs/ItemShippingDistributionCenter.md +20 -0
- data/docs/ItemShippingMethod.md +22 -0
- data/docs/ItemShippingPackageRequirement.md +9 -0
- data/docs/ItemTag.md +9 -0
- data/docs/ItemTags.md +8 -0
- data/docs/ItemTax.md +10 -0
- data/docs/ItemTaxExemption.md +12 -0
- data/docs/ItemThirdPartyEmailMarketing.md +12 -0
- data/docs/ItemVariantItem.md +13 -0
- data/docs/ItemVariation.md +12 -0
- data/docs/ItemVariationOption.md +11 -0
- data/docs/ItemWishlistMember.md +10 -0
- data/docs/ItemsRequest.md +8 -0
- data/docs/ItemsResponse.md +12 -0
- data/docs/KeyValue.md +10 -0
- data/docs/LibraryFilterValues.md +11 -0
- data/docs/LibraryFilterValuesResponse.md +12 -0
- data/docs/LibraryItem.md +47 -0
- data/docs/LibraryItemAccount.md +10 -0
- data/docs/LibraryItemAsset.md +9 -0
- data/docs/LibraryItemAttribute.md +10 -0
- data/docs/LibraryItemEmail.md +10 -0
- data/docs/LibraryItemPublishedMeta.md +15 -0
- data/docs/LibraryItemPurchasedMeta.md +10 -0
- data/docs/LibraryItemQuery.md +19 -0
- data/docs/LibraryItemResponse.md +12 -0
- data/docs/LibraryItemScreenshot.md +9 -0
- data/docs/LibraryItemsResponse.md +12 -0
- data/docs/LinkedAccount.md +10 -0
- data/docs/ListSegmentMembership.md +10 -0
- data/docs/LookupRequest.md +12 -0
- data/docs/LookupResponse.md +12 -0
- data/docs/Metric.md +15 -0
- data/docs/Notification.md +18 -0
- data/docs/OauthApi.md +148 -0
- data/docs/OauthRevokeSuccessResponse.md +9 -0
- data/docs/OauthTokenResponse.md +15 -0
- data/docs/Order.md +41 -0
- data/docs/OrderAffiliate.md +10 -0
- data/docs/OrderAffiliateLedger.md +16 -0
- data/docs/OrderApi.md +1293 -0
- data/docs/OrderAutoOrder.md +26 -0
- data/docs/OrderBilling.md +22 -0
- data/docs/OrderBuysafe.md +13 -0
- data/docs/OrderByTokenQuery.md +8 -0
- data/docs/OrderChannelPartner.md +17 -0
- data/docs/OrderCheckout.md +19 -0
- data/docs/OrderCoupon.md +11 -0
- data/docs/OrderDigitalItem.md +15 -0
- data/docs/OrderDigitalOrder.md +12 -0
- data/docs/OrderEdi.md +11 -0
- data/docs/OrderFormat.md +23 -0
- data/docs/OrderFormatResponse.md +9 -0
- data/docs/OrderFraudScore.md +27 -0
- data/docs/OrderGift.md +17 -0
- data/docs/OrderGiftCertificate.md +10 -0
- data/docs/OrderInternal.md +12 -0
- data/docs/OrderItem.md +61 -0
- data/docs/OrderItemEdi.md +9 -0
- data/docs/OrderItemEdiIdentification.md +9 -0
- data/docs/OrderItemEdiLot.md +10 -0
- data/docs/OrderItemOption.md +18 -0
- data/docs/OrderItemOptionFileAttachment.md +11 -0
- data/docs/OrderItemProperty.md +11 -0
- data/docs/OrderItemTag.md +8 -0
- data/docs/OrderLinkedShipment.md +12 -0
- data/docs/OrderMarketing.md +10 -0
- data/docs/OrderPayment.md +24 -0
- data/docs/OrderPaymentCheck.md +8 -0
- data/docs/OrderPaymentCreditCard.md +18 -0
- data/docs/OrderPaymentECheck.md +17 -0
- data/docs/OrderPaymentPurchaseOrder.md +8 -0
- data/docs/OrderPaymentTransaction.md +11 -0
- data/docs/OrderPaymentTransactionDetail.md +10 -0
- data/docs/OrderProcessPaymentRequest.md +8 -0
- data/docs/OrderProcessPaymentResponse.md +12 -0
- data/docs/OrderProperty.md +11 -0
- data/docs/OrderQuery.md +37 -0
- data/docs/OrderQueryBatch.md +8 -0
- data/docs/OrderQuote.md +10 -0
- data/docs/OrderReplacement.md +22 -0
- data/docs/OrderReplacementItem.md +10 -0
- data/docs/OrderReplacementResponse.md +13 -0
- data/docs/OrderResponse.md +12 -0
- data/docs/OrderSalesforce.md +8 -0
- data/docs/OrderShipping.md +36 -0
- data/docs/OrderSummary.md +24 -0
- data/docs/OrderTag.md +8 -0
- data/docs/OrderTaxes.md +24 -0
- data/docs/OrderTokenResponse.md +12 -0
- data/docs/OrderTrackingNumberDetail.md +17 -0
- data/docs/OrderTrackingNumberDetails.md +24 -0
- data/docs/OrdersResponse.md +12 -0
- data/docs/Permission.md +10 -0
- data/docs/PricingTier.md +38 -0
- data/docs/PricingTierNotification.md +10 -0
- data/docs/PricingTiersResponse.md +12 -0
- data/docs/Property.md +9 -0
- data/docs/PublishLibraryItemRequest.md +8 -0
- data/docs/RegisterAffiliateClickRequest.md +13 -0
- data/docs/RegisterAffiliateClickResponse.md +11 -0
- data/docs/ResponseMetadata.md +9 -0
- data/docs/ResultSet.md +13 -0
- data/docs/ScreenRecording.md +39 -0
- data/docs/ScreenRecordingFilter.md +34 -0
- data/docs/ScreenRecordingFilterGeoDistance.md +12 -0
- data/docs/ScreenRecordingFilterIpSearch.md +11 -0
- data/docs/ScreenRecordingFilterPageView.md +14 -0
- data/docs/ScreenRecordingFilterPageViewEvent.md +9 -0
- data/docs/ScreenRecordingFilterPageViewEventParam.md +12 -0
- data/docs/ScreenRecordingFilterPageViewParam.md +9 -0
- data/docs/ScreenRecordingFilterPageViewReferrerParam.md +9 -0
- data/docs/ScreenRecordingFilterRangeBigDecimal.md +12 -0
- data/docs/ScreenRecordingFilterRangeDate.md +9 -0
- data/docs/ScreenRecordingFilterRangeInteger.md +12 -0
- data/docs/ScreenRecordingFilterStringSearch.md +12 -0
- data/docs/ScreenRecordingFilterValues.md +17 -0
- data/docs/ScreenRecordingFilterValuesEvent.md +9 -0
- data/docs/ScreenRecordingFilterValuesEventParams.md +12 -0
- data/docs/ScreenRecordingMultifield.md +12 -0
- data/docs/ScreenRecordingPageView.md +22 -0
- data/docs/ScreenRecordingPageViewEvent.md +11 -0
- data/docs/ScreenRecordingPageViewEventParameter.md +9 -0
- data/docs/ScreenRecordingPageViewParameter.md +9 -0
- data/docs/ScreenRecordingQueryRequest.md +8 -0
- data/docs/ScreenRecordingQueryResponse.md +14 -0
- data/docs/ScreenRecordingResponse.md +12 -0
- data/docs/ScreenRecordingSegment.md +14 -0
- data/docs/ScreenRecordingSegmentResponse.md +12 -0
- data/docs/ScreenRecordingSegmentsResponse.md +12 -0
- data/docs/ScreenRecordingSettings.md +8 -0
- data/docs/ScreenRecordingSettingsResponse.md +12 -0
- data/docs/ScreenRecordingStoreFront.md +9 -0
- data/docs/ScreenRecordingTagsRequest.md +8 -0
- data/docs/ScreenRecordingTagsResponse.md +12 -0
- data/docs/ScreenRecordingUserAgent.md +12 -0
- data/docs/ScreenRecordingUserAgentDevice.md +8 -0
- data/docs/ScreenRecordingUserAgentOS.md +10 -0
- data/docs/ScreenRecordingUserProperty.md +9 -0
- data/docs/ScreenshotsResponse.md +12 -0
- data/docs/SelfConfig.md +8 -0
- data/docs/SimpleValue.md +9 -0
- data/docs/SovosConfig.md +14 -0
- data/docs/StateProvince.md +9 -0
- data/docs/StepWaiting.md +9 -0
- data/docs/StorefrontApi.md +9186 -0
- data/docs/TaxApi.md +1608 -0
- data/docs/TaxCity.md +16 -0
- data/docs/TaxCountry.md +16 -0
- data/docs/TaxCountryCode.md +12 -0
- data/docs/TaxCounty.md +17 -0
- data/docs/TaxJarConfig.md +13 -0
- data/docs/TaxPostalCode.md +14 -0
- data/docs/TaxProviderActivateResult.md +9 -0
- data/docs/TaxProviderAvalara.md +11 -0
- data/docs/TaxProviderAvalaraCompaniesResult.md +8 -0
- data/docs/TaxProviderAvalaraCompany.md +12 -0
- data/docs/TaxProviderSelf.md +12 -0
- data/docs/TaxProviderSelfCountriesResponse.md +8 -0
- data/docs/TaxProviderSelfRegionsResponse.md +8 -0
- data/docs/TaxProviderSovos.md +11 -0
- data/docs/TaxProviderTaxJar.md +11 -0
- data/docs/TaxProviderTestResult.md +9 -0
- data/docs/TaxProviderUltraCart.md +12 -0
- data/docs/TaxProviderUltraCartState.md +14 -0
- data/docs/TaxProvidersResponse.md +16 -0
- data/docs/TaxState.md +22 -0
- data/docs/TaxStateCode.md +12 -0
- data/docs/TempMultimedia.md +14 -0
- data/docs/TempMultimediaResponse.md +12 -0
- data/docs/ThumbnailParametersRequest.md +12 -0
- data/docs/ThumbnailParametersResponse.md +12 -0
- data/docs/TransactionEmail.md +27 -0
- data/docs/TransactionEmailListResponse.md +12 -0
- data/docs/TransactionEmailOption.md +15 -0
- data/docs/TransactionEmailResponse.md +12 -0
- data/docs/UltraCartConfig.md +8 -0
- data/docs/UploadCouponCodesRequest.md +12 -0
- data/docs/UploadCouponCodesResponse.md +14 -0
- data/docs/User.md +21 -0
- data/docs/UserApi.md +633 -0
- data/docs/UserGroupMembership.md +10 -0
- data/docs/UserLogin.md +11 -0
- data/docs/UserLoginsResponse.md +12 -0
- data/docs/UserResponse.md +12 -0
- data/docs/UsersResponse.md +12 -0
- data/docs/VerificationRecord.md +10 -0
- data/docs/Warning.md +9 -0
- data/docs/Webhook.md +25 -0
- data/docs/WebhookApi.md +503 -0
- data/docs/WebhookEventCategory.md +12 -0
- data/docs/WebhookEventSubscription.md +16 -0
- data/docs/WebhookLog.md +17 -0
- data/docs/WebhookLogResponse.md +12 -0
- data/docs/WebhookLogSummariesResponse.md +12 -0
- data/docs/WebhookLogSummary.md +10 -0
- data/docs/WebhookResponse.md +12 -0
- data/docs/WebhookSampleRequest.md +11 -0
- data/docs/WebhookSampleRequestResponse.md +12 -0
- data/docs/WebhooksResponse.md +12 -0
- data/docs/Weight.md +9 -0
- data/git_push.sh +55 -0
- data/lib/ultracart_api.rb +609 -0
- data/lib/ultracart_api/api/affiliate_api.rb +151 -0
- data/lib/ultracart_api/api/auto_order_api.rb +568 -0
- data/lib/ultracart_api/api/chargeback_api.rb +343 -0
- data/lib/ultracart_api/api/checkout_api.rb +1098 -0
- data/lib/ultracart_api/api/coupon_api.rb +1148 -0
- data/lib/ultracart_api/api/customer_api.rb +684 -0
- data/lib/ultracart_api/api/fulfillment_api.rb +307 -0
- data/lib/ultracart_api/api/item_api.rb +572 -0
- data/lib/ultracart_api/api/oauth_api.rb +158 -0
- data/lib/ultracart_api/api/order_api.rb +1293 -0
- data/lib/ultracart_api/api/storefront_api.rb +8493 -0
- data/lib/ultracart_api/api/tax_api.rb +1567 -0
- data/lib/ultracart_api/api/user_api.rb +621 -0
- data/lib/ultracart_api/api/webhook_api.rb +501 -0
- data/lib/ultracart_api/api_client.rb +400 -0
- data/lib/ultracart_api/api_error.rb +38 -0
- data/lib/ultracart_api/configuration.rb +229 -0
- data/lib/ultracart_api/models/accounts_receivable_retry_config.rb +319 -0
- data/lib/ultracart_api/models/accounts_receivable_retry_config_response.rb +252 -0
- data/lib/ultracart_api/models/accounts_receivable_retry_day_activity.rb +205 -0
- data/lib/ultracart_api/models/accounts_receivable_retry_stat_account.rb +215 -0
- data/lib/ultracart_api/models/accounts_receivable_retry_stat_metrics.rb +274 -0
- data/lib/ultracart_api/models/accounts_receivable_retry_stat_revenue.rb +193 -0
- data/lib/ultracart_api/models/accounts_receivable_retry_stats_response.rb +232 -0
- data/lib/ultracart_api/models/activity.rb +229 -0
- data/lib/ultracart_api/models/add_library_item_request.rb +289 -0
- data/lib/ultracart_api/models/affiliate_click.rb +284 -0
- data/lib/ultracart_api/models/affiliate_click_query.rb +235 -0
- data/lib/ultracart_api/models/affiliate_clicks_response.rb +224 -0
- data/lib/ultracart_api/models/affiliate_ledger.rb +386 -0
- data/lib/ultracart_api/models/affiliate_ledger_query.rb +235 -0
- data/lib/ultracart_api/models/affiliate_ledgers_response.rb +224 -0
- data/lib/ultracart_api/models/affiliate_link.rb +373 -0
- data/lib/ultracart_api/models/api_user_application_profile.rb +225 -0
- data/lib/ultracart_api/models/apply_library_item_request.rb +205 -0
- data/lib/ultracart_api/models/apply_library_item_response.rb +284 -0
- data/lib/ultracart_api/models/auto_order.rb +412 -0
- data/lib/ultracart_api/models/auto_order_item.rb +452 -0
- data/lib/ultracart_api/models/auto_order_item_future_schedule.rb +215 -0
- data/lib/ultracart_api/models/auto_order_item_option.rb +225 -0
- data/lib/ultracart_api/models/auto_order_item_simple_schedule.rb +239 -0
- data/lib/ultracart_api/models/auto_order_query.rb +425 -0
- data/lib/ultracart_api/models/auto_order_query_batch.rb +187 -0
- data/lib/ultracart_api/models/auto_order_response.rb +221 -0
- data/lib/ultracart_api/models/auto_orders_request.rb +187 -0
- data/lib/ultracart_api/models/auto_orders_response.rb +223 -0
- data/lib/ultracart_api/models/avalara_config.rb +305 -0
- data/lib/ultracart_api/models/base_response.rb +212 -0
- data/lib/ultracart_api/models/cart.rb +461 -0
- data/lib/ultracart_api/models/cart_affiliate.rb +210 -0
- data/lib/ultracart_api/models/cart_affirm_checkout_response.rb +197 -0
- data/lib/ultracart_api/models/cart_billing.rb +537 -0
- data/lib/ultracart_api/models/cart_buysafe.rb +234 -0
- data/lib/ultracart_api/models/cart_checkout.rb +465 -0
- data/lib/ultracart_api/models/cart_coupon.rb +185 -0
- data/lib/ultracart_api/models/cart_currency_conversion.rb +197 -0
- data/lib/ultracart_api/models/cart_customer_profile.rb +403 -0
- data/lib/ultracart_api/models/cart_customer_profile_address.rb +315 -0
- data/lib/ultracart_api/models/cart_customer_profile_credit_card.rb +269 -0
- data/lib/ultracart_api/models/cart_finalize_order_request.rb +193 -0
- data/lib/ultracart_api/models/cart_finalize_order_request_options.rb +320 -0
- data/lib/ultracart_api/models/cart_finalize_order_response.rb +225 -0
- data/lib/ultracart_api/models/cart_gift.rb +278 -0
- data/lib/ultracart_api/models/cart_gift_certificate.rb +203 -0
- data/lib/ultracart_api/models/cart_item.rb +469 -0
- data/lib/ultracart_api/models/cart_item_attribute.rb +205 -0
- data/lib/ultracart_api/models/cart_item_multimedia.rb +301 -0
- data/lib/ultracart_api/models/cart_item_multimedia_thumbnail.rb +225 -0
- data/lib/ultracart_api/models/cart_item_option.rb +343 -0
- data/lib/ultracart_api/models/cart_item_option_value.rb +223 -0
- data/lib/ultracart_api/models/cart_item_physical.rb +211 -0
- data/lib/ultracart_api/models/cart_item_variation_selection.rb +195 -0
- data/lib/ultracart_api/models/cart_kit_component_option.rb +363 -0
- data/lib/ultracart_api/models/cart_marketing.rb +195 -0
- data/lib/ultracart_api/models/cart_payment.rb +240 -0
- data/lib/ultracart_api/models/cart_payment_affirm.rb +185 -0
- data/lib/ultracart_api/models/cart_payment_amazon.rb +185 -0
- data/lib/ultracart_api/models/cart_payment_check.rb +185 -0
- data/lib/ultracart_api/models/cart_payment_credit_card.rb +265 -0
- data/lib/ultracart_api/models/cart_payment_purchase_order.rb +185 -0
- data/lib/ultracart_api/models/cart_profile_login_request.rb +204 -0
- data/lib/ultracart_api/models/cart_profile_login_response.rb +196 -0
- data/lib/ultracart_api/models/cart_profile_register_request.rb +194 -0
- data/lib/ultracart_api/models/cart_profile_register_response.rb +196 -0
- data/lib/ultracart_api/models/cart_property.rb +245 -0
- data/lib/ultracart_api/models/cart_response.rb +196 -0
- data/lib/ultracart_api/models/cart_settings.rb +229 -0
- data/lib/ultracart_api/models/cart_settings_billing.rb +187 -0
- data/lib/ultracart_api/models/cart_settings_gift.rb +216 -0
- data/lib/ultracart_api/models/cart_settings_gift_wrap.rb +204 -0
- data/lib/ultracart_api/models/cart_settings_payment.rb +302 -0
- data/lib/ultracart_api/models/cart_settings_payment_amazon.rb +205 -0
- data/lib/ultracart_api/models/cart_settings_payment_credit_card.rb +207 -0
- data/lib/ultracart_api/models/cart_settings_payment_pay_pal.rb +225 -0
- data/lib/ultracart_api/models/cart_settings_province.rb +193 -0
- data/lib/ultracart_api/models/cart_settings_shipping.rb +227 -0
- data/lib/ultracart_api/models/cart_settings_shipping_calendar.rb +229 -0
- data/lib/ultracart_api/models/cart_settings_shipping_estimate.rb +300 -0
- data/lib/ultracart_api/models/cart_settings_taxes.rb +186 -0
- data/lib/ultracart_api/models/cart_settings_terms.rb +195 -0
- data/lib/ultracart_api/models/cart_shipping.rb +590 -0
- data/lib/ultracart_api/models/cart_summary.rb +319 -0
- data/lib/ultracart_api/models/cart_taxes.rb +220 -0
- data/lib/ultracart_api/models/cart_upsell_after.rb +220 -0
- data/lib/ultracart_api/models/cart_validation_request.rb +196 -0
- data/lib/ultracart_api/models/cart_validation_response.rb +196 -0
- data/lib/ultracart_api/models/chargeback_dispute.rb +614 -0
- data/lib/ultracart_api/models/chargeback_dispute_response.rb +221 -0
- data/lib/ultracart_api/models/chargeback_disputes_response.rb +223 -0
- data/lib/ultracart_api/models/checkout_allowed_countries_response.rb +186 -0
- data/lib/ultracart_api/models/checkout_handoff_request.rb +288 -0
- data/lib/ultracart_api/models/checkout_handoff_response.rb +206 -0
- data/lib/ultracart_api/models/checkout_setup_browser_key_request.rb +187 -0
- data/lib/ultracart_api/models/checkout_setup_browser_key_response.rb +185 -0
- data/lib/ultracart_api/models/checkout_state_province_response.rb +186 -0
- data/lib/ultracart_api/models/city_state_zip.rb +220 -0
- data/lib/ultracart_api/models/countries_response.rb +186 -0
- data/lib/ultracart_api/models/country.rb +225 -0
- data/lib/ultracart_api/models/coupon.rb +792 -0
- data/lib/ultracart_api/models/coupon_amount_off_items.rb +232 -0
- data/lib/ultracart_api/models/coupon_amount_off_shipping.rb +222 -0
- data/lib/ultracart_api/models/coupon_amount_off_shipping_with_items_purchase.rb +234 -0
- data/lib/ultracart_api/models/coupon_amount_off_subtotal.rb +210 -0
- data/lib/ultracart_api/models/coupon_amount_off_subtotal_and_shipping.rb +210 -0
- data/lib/ultracart_api/models/coupon_amount_off_subtotal_free_shipping_with_purchase.rb +232 -0
- data/lib/ultracart_api/models/coupon_amount_off_subtotal_with_block_purchase.rb +230 -0
- data/lib/ultracart_api/models/coupon_amount_off_subtotal_with_items_purchase.rb +232 -0
- data/lib/ultracart_api/models/coupon_auto_apply_condition.rb +204 -0
- data/lib/ultracart_api/models/coupon_auto_apply_conditions.rb +234 -0
- data/lib/ultracart_api/models/coupon_automatically_apply_coupon_codes.rb +187 -0
- data/lib/ultracart_api/models/coupon_buy_one_get_one_limit.rb +197 -0
- data/lib/ultracart_api/models/coupon_codes_request.rb +242 -0
- data/lib/ultracart_api/models/coupon_codes_response.rb +234 -0
- data/lib/ultracart_api/models/coupon_deletes_request.rb +199 -0
- data/lib/ultracart_api/models/coupon_discount_item_with_item_purchase.rb +240 -0
- data/lib/ultracart_api/models/coupon_discount_items.rb +232 -0
- data/lib/ultracart_api/models/coupon_editor_values.rb +295 -0
- data/lib/ultracart_api/models/coupon_exists_response.rb +232 -0
- data/lib/ultracart_api/models/coupon_free_item_and_shipping_with_subtotal.rb +244 -0
- data/lib/ultracart_api/models/coupon_free_item_with_item_purchase.rb +219 -0
- data/lib/ultracart_api/models/coupon_free_item_with_subtotal.rb +232 -0
- data/lib/ultracart_api/models/coupon_free_items_with_item_purchase.rb +225 -0
- data/lib/ultracart_api/models/coupon_free_items_with_mix_match_purchase.rb +225 -0
- data/lib/ultracart_api/models/coupon_free_shipping.rb +187 -0
- data/lib/ultracart_api/models/coupon_free_shipping_specific_items.rb +187 -0
- data/lib/ultracart_api/models/coupon_free_shipping_with_items_purchase.rb +199 -0
- data/lib/ultracart_api/models/coupon_free_shipping_with_subtotal.rb +222 -0
- data/lib/ultracart_api/models/coupon_item_search_result.rb +255 -0
- data/lib/ultracart_api/models/coupon_item_search_results_response.rb +224 -0
- data/lib/ultracart_api/models/coupon_multiple_amounts_off_items.rb +197 -0
- data/lib/ultracart_api/models/coupon_no_discount.rb +175 -0
- data/lib/ultracart_api/models/coupon_percent_off_item_with_items_quantity_purchase.rb +229 -0
- data/lib/ultracart_api/models/coupon_percent_off_items.rb +219 -0
- data/lib/ultracart_api/models/coupon_percent_off_items_and_free_shipping.rb +209 -0
- data/lib/ultracart_api/models/coupon_percent_off_items_with_items_purchase.rb +219 -0
- data/lib/ultracart_api/models/coupon_percent_off_retail_price_items.rb +219 -0
- data/lib/ultracart_api/models/coupon_percent_off_shipping.rb +197 -0
- data/lib/ultracart_api/models/coupon_percent_off_subtotal.rb +185 -0
- data/lib/ultracart_api/models/coupon_percent_off_subtotal_and_free_shipping.rb +197 -0
- data/lib/ultracart_api/models/coupon_percent_off_subtotal_limit.rb +220 -0
- data/lib/ultracart_api/models/coupon_percent_off_subtotal_with_items_purchase.rb +197 -0
- data/lib/ultracart_api/models/coupon_percent_off_subtotal_with_subtotal.rb +220 -0
- data/lib/ultracart_api/models/coupon_query.rb +265 -0
- data/lib/ultracart_api/models/coupon_response.rb +221 -0
- data/lib/ultracart_api/models/coupon_restriction.rb +211 -0
- data/lib/ultracart_api/models/coupon_tier_amount.rb +195 -0
- data/lib/ultracart_api/models/coupon_tier_item_discount.rb +197 -0
- data/lib/ultracart_api/models/coupon_tier_percent.rb +195 -0
- data/lib/ultracart_api/models/coupon_tier_quantity_amount.rb +195 -0
- data/lib/ultracart_api/models/coupon_tier_quantity_percent.rb +195 -0
- data/lib/ultracart_api/models/coupon_tiered_amount_off_item.rb +207 -0
- data/lib/ultracart_api/models/coupon_tiered_amount_off_subtotal.rb +199 -0
- data/lib/ultracart_api/models/coupon_tiered_percent_off_items.rb +209 -0
- data/lib/ultracart_api/models/coupon_tiered_percent_off_shipping.rb +199 -0
- data/lib/ultracart_api/models/coupon_tiered_percent_off_subtotal.rb +199 -0
- data/lib/ultracart_api/models/coupon_type.rb +195 -0
- data/lib/ultracart_api/models/coupons_request.rb +187 -0
- data/lib/ultracart_api/models/coupons_response.rb +223 -0
- data/lib/ultracart_api/models/currency.rb +225 -0
- data/lib/ultracart_api/models/customer.rb +933 -0
- data/lib/ultracart_api/models/customer_activity.rb +219 -0
- data/lib/ultracart_api/models/customer_affiliate.rb +195 -0
- data/lib/ultracart_api/models/customer_attachment.rb +225 -0
- data/lib/ultracart_api/models/customer_billing.rb +540 -0
- data/lib/ultracart_api/models/customer_card.rb +255 -0
- data/lib/ultracart_api/models/customer_editor_values.rb +271 -0
- data/lib/ultracart_api/models/customer_email.rb +265 -0
- data/lib/ultracart_api/models/customer_email_list_changes.rb +199 -0
- data/lib/ultracart_api/models/customer_loyalty.rb +209 -0
- data/lib/ultracart_api/models/customer_loyalty_ledger.rb +325 -0
- data/lib/ultracart_api/models/customer_loyalty_redemption.rb +305 -0
- data/lib/ultracart_api/models/customer_orders_summary.rb +215 -0
- data/lib/ultracart_api/models/customer_pricing_tier.rb +210 -0
- data/lib/ultracart_api/models/customer_privacy.rb +215 -0
- data/lib/ultracart_api/models/customer_query.rb +754 -0
- data/lib/ultracart_api/models/customer_quotes_summary.rb +215 -0
- data/lib/ultracart_api/models/customer_response.rb +221 -0
- data/lib/ultracart_api/models/customer_reviewer.rb +275 -0
- data/lib/ultracart_api/models/customer_shipping.rb +540 -0
- data/lib/ultracart_api/models/customer_software_entitlement.rb +330 -0
- data/lib/ultracart_api/models/customer_tag.rb +200 -0
- data/lib/ultracart_api/models/customer_tax_codes.rb +225 -0
- data/lib/ultracart_api/models/customers_response.rb +223 -0
- data/lib/ultracart_api/models/data_tables_server_side_response.rb +213 -0
- data/lib/ultracart_api/models/distance.rb +229 -0
- data/lib/ultracart_api/models/distribution_center.rb +514 -0
- data/lib/ultracart_api/models/distribution_centers_response.rb +223 -0
- data/lib/ultracart_api/models/email_base_template_list_response.rb +186 -0
- data/lib/ultracart_api/models/email_campaign.rb +422 -0
- data/lib/ultracart_api/models/email_campaign_folder.rb +240 -0
- data/lib/ultracart_api/models/email_campaign_folder_response.rb +221 -0
- data/lib/ultracart_api/models/email_campaign_folders_response.rb +223 -0
- data/lib/ultracart_api/models/email_campaign_response.rb +221 -0
- data/lib/ultracart_api/models/email_campaigns_response.rb +223 -0
- data/lib/ultracart_api/models/email_click.rb +195 -0
- data/lib/ultracart_api/models/email_clicks_response.rb +223 -0
- data/lib/ultracart_api/models/email_commseq.rb +217 -0
- data/lib/ultracart_api/models/email_commseq_email.rb +415 -0
- data/lib/ultracart_api/models/email_commseq_email_response.rb +221 -0
- data/lib/ultracart_api/models/email_commseq_email_send_test_request.rb +269 -0
- data/lib/ultracart_api/models/email_commseq_email_send_test_response.rb +212 -0
- data/lib/ultracart_api/models/email_commseq_emails_request.rb +223 -0
- data/lib/ultracart_api/models/email_commseq_emails_response.rb +223 -0
- data/lib/ultracart_api/models/email_commseq_postcard.rb +285 -0
- data/lib/ultracart_api/models/email_commseq_postcard_response.rb +221 -0
- data/lib/ultracart_api/models/email_commseq_postcard_send_test_request.rb +285 -0
- data/lib/ultracart_api/models/email_commseq_postcard_send_test_response.rb +239 -0
- data/lib/ultracart_api/models/email_commseq_postcards_request.rb +186 -0
- data/lib/ultracart_api/models/email_commseq_postcards_response.rb +223 -0
- data/lib/ultracart_api/models/email_commseq_response.rb +221 -0
- data/lib/ultracart_api/models/email_commseq_stat.rb +545 -0
- data/lib/ultracart_api/models/email_commseq_stat_response.rb +221 -0
- data/lib/ultracart_api/models/email_commseq_step.rb +313 -0
- data/lib/ultracart_api/models/email_commseqs_response.rb +223 -0
- data/lib/ultracart_api/models/email_customer.rb +257 -0
- data/lib/ultracart_api/models/email_customer_editor_url_response.rb +221 -0
- data/lib/ultracart_api/models/email_customers_response.rb +227 -0
- data/lib/ultracart_api/models/email_dashboard_activity.rb +245 -0
- data/lib/ultracart_api/models/email_dashboard_activity_response.rb +223 -0
- data/lib/ultracart_api/models/email_dashboard_stats_response.rb +223 -0
- data/lib/ultracart_api/models/email_domain.rb +276 -0
- data/lib/ultracart_api/models/email_editor_token_response.rb +221 -0
- data/lib/ultracart_api/models/email_flow.rb +460 -0
- data/lib/ultracart_api/models/email_flow_back_populate_request.rb +195 -0
- data/lib/ultracart_api/models/email_flow_back_populate_response.rb +212 -0
- data/lib/ultracart_api/models/email_flow_folder.rb +240 -0
- data/lib/ultracart_api/models/email_flow_folder_response.rb +221 -0
- data/lib/ultracart_api/models/email_flow_folders_response.rb +223 -0
- data/lib/ultracart_api/models/email_flow_response.rb +221 -0
- data/lib/ultracart_api/models/email_flows_response.rb +223 -0
- data/lib/ultracart_api/models/email_global_settings.rb +184 -0
- data/lib/ultracart_api/models/email_global_settings_response.rb +221 -0
- data/lib/ultracart_api/models/email_global_unsubscribe_request.rb +184 -0
- data/lib/ultracart_api/models/email_global_unsubscribe_response.rb +184 -0
- data/lib/ultracart_api/models/email_histogram_property_names_response.rb +186 -0
- data/lib/ultracart_api/models/email_histogram_property_values_response.rb +186 -0
- data/lib/ultracart_api/models/email_list.rb +302 -0
- data/lib/ultracart_api/models/email_list_archive_response.rb +221 -0
- data/lib/ultracart_api/models/email_list_customer.rb +215 -0
- data/lib/ultracart_api/models/email_list_customers_response.rb +227 -0
- data/lib/ultracart_api/models/email_list_response.rb +221 -0
- data/lib/ultracart_api/models/email_list_segment_membership.rb +215 -0
- data/lib/ultracart_api/models/email_list_segment_used_by.rb +205 -0
- data/lib/ultracart_api/models/email_list_subscribe_response.rb +193 -0
- data/lib/ultracart_api/models/email_lists_response.rb +223 -0
- data/lib/ultracart_api/models/email_order.rb +214 -0
- data/lib/ultracart_api/models/email_orders_response.rb +223 -0
- data/lib/ultracart_api/models/email_performance.rb +396 -0
- data/lib/ultracart_api/models/email_performance_customer_histogram.rb +187 -0
- data/lib/ultracart_api/models/email_performance_customer_histogram_period.rb +225 -0
- data/lib/ultracart_api/models/email_performance_daily.rb +245 -0
- data/lib/ultracart_api/models/email_performance_response.rb +221 -0
- data/lib/ultracart_api/models/email_plan.rb +321 -0
- data/lib/ultracart_api/models/email_plan_additional.rb +229 -0
- data/lib/ultracart_api/models/email_plan_response.rb +221 -0
- data/lib/ultracart_api/models/email_postcard_stat.rb +496 -0
- data/lib/ultracart_api/models/email_segment.rb +332 -0
- data/lib/ultracart_api/models/email_segment_archive_response.rb +221 -0
- data/lib/ultracart_api/models/email_segment_customer.rb +215 -0
- data/lib/ultracart_api/models/email_segment_customers_response.rb +227 -0
- data/lib/ultracart_api/models/email_segment_download_prepare_response.rb +248 -0
- data/lib/ultracart_api/models/email_segment_response.rb +221 -0
- data/lib/ultracart_api/models/email_segments_response.rb +223 -0
- data/lib/ultracart_api/models/email_sending_domain_response.rb +221 -0
- data/lib/ultracart_api/models/email_sending_domains_response.rb +223 -0
- data/lib/ultracart_api/models/email_settings.rb +283 -0
- data/lib/ultracart_api/models/email_settings_response.rb +221 -0
- data/lib/ultracart_api/models/email_stat.rb +556 -0
- data/lib/ultracart_api/models/email_stat_postcard_summary_request.rb +195 -0
- data/lib/ultracart_api/models/email_stat_postcard_summary_response.rb +223 -0
- data/lib/ultracart_api/models/email_stat_summary_request.rb +206 -0
- data/lib/ultracart_api/models/email_stat_summary_response.rb +223 -0
- data/lib/ultracart_api/models/email_step_stat.rb +375 -0
- data/lib/ultracart_api/models/email_step_stat_request.rb +195 -0
- data/lib/ultracart_api/models/email_step_stat_response.rb +223 -0
- data/lib/ultracart_api/models/email_step_waiting_request.rb +186 -0
- data/lib/ultracart_api/models/email_step_waiting_response.rb +186 -0
- data/lib/ultracart_api/models/email_template.rb +330 -0
- data/lib/ultracart_api/models/email_templates_response.rb +223 -0
- data/lib/ultracart_api/models/email_third_party_list.rb +195 -0
- data/lib/ultracart_api/models/email_third_party_list_import_request.rb +187 -0
- data/lib/ultracart_api/models/email_third_party_provider.rb +267 -0
- data/lib/ultracart_api/models/email_third_party_providers_response.rb +223 -0
- data/lib/ultracart_api/models/error.rb +215 -0
- data/lib/ultracart_api/models/error_response.rb +212 -0
- data/lib/ultracart_api/models/experiment.rb +391 -0
- data/lib/ultracart_api/models/experiment_response.rb +221 -0
- data/lib/ultracart_api/models/experiment_variation.rb +365 -0
- data/lib/ultracart_api/models/experiments_response.rb +223 -0
- data/lib/ultracart_api/models/fulfillment_inventory.rb +193 -0
- data/lib/ultracart_api/models/fulfillment_shipment.rb +227 -0
- data/lib/ultracart_api/models/geo_point.rb +193 -0
- data/lib/ultracart_api/models/geocode_request.rb +225 -0
- data/lib/ultracart_api/models/geocode_response.rb +230 -0
- data/lib/ultracart_api/models/group.rb +231 -0
- data/lib/ultracart_api/models/group_response.rb +221 -0
- data/lib/ultracart_api/models/group_user_membership.rb +225 -0
- data/lib/ultracart_api/models/groups_response.rb +223 -0
- data/lib/ultracart_api/models/http_header.rb +195 -0
- data/lib/ultracart_api/models/item.rb +701 -0
- data/lib/ultracart_api/models/item_accounting.rb +225 -0
- data/lib/ultracart_api/models/item_amember.rb +210 -0
- data/lib/ultracart_api/models/item_auto_order.rb +358 -0
- data/lib/ultracart_api/models/item_auto_order_step.rb +378 -0
- data/lib/ultracart_api/models/item_auto_order_step_arbitrary_unit_cost_schedule.rb +195 -0
- data/lib/ultracart_api/models/item_auto_order_step_grandfather_pricing.rb +195 -0
- data/lib/ultracart_api/models/item_cc_bill.rb +235 -0
- data/lib/ultracart_api/models/item_channel_partner_mapping.rb +400 -0
- data/lib/ultracart_api/models/item_chargeback.rb +199 -0
- data/lib/ultracart_api/models/item_chargeback_addendum.rb +215 -0
- data/lib/ultracart_api/models/item_chargeback_adjustment_request.rb +205 -0
- data/lib/ultracart_api/models/item_checkout.rb +220 -0
- data/lib/ultracart_api/models/item_content.rb +316 -0
- data/lib/ultracart_api/models/item_content_assignment.rb +240 -0
- data/lib/ultracart_api/models/item_content_attribute.rb +245 -0
- data/lib/ultracart_api/models/item_content_multimedia.rb +406 -0
- data/lib/ultracart_api/models/item_content_multimedia_thumbnail.rb +235 -0
- data/lib/ultracart_api/models/item_digital_delivery.rb +282 -0
- data/lib/ultracart_api/models/item_digital_item.rb +270 -0
- data/lib/ultracart_api/models/item_ebay.rb +866 -0
- data/lib/ultracart_api/models/item_ebay_category_specific.rb +195 -0
- data/lib/ultracart_api/models/item_ebay_market_listing.rb +225 -0
- data/lib/ultracart_api/models/item_ebay_market_place_analysis.rb +276 -0
- data/lib/ultracart_api/models/item_email_notifications.rb +195 -0
- data/lib/ultracart_api/models/item_enrollment123.rb +185 -0
- data/lib/ultracart_api/models/item_gift_certificate.rb +195 -0
- data/lib/ultracart_api/models/item_google_product_search.rb +1254 -0
- data/lib/ultracart_api/models/item_identifiers.rb +275 -0
- data/lib/ultracart_api/models/item_instant_payment_notification.rb +235 -0
- data/lib/ultracart_api/models/item_instant_payment_notifications.rb +187 -0
- data/lib/ultracart_api/models/item_internal.rb +200 -0
- data/lib/ultracart_api/models/item_kit_component.rb +225 -0
- data/lib/ultracart_api/models/item_kit_definition.rb +187 -0
- data/lib/ultracart_api/models/item_option.rb +381 -0
- data/lib/ultracart_api/models/item_option_value.rb +374 -0
- data/lib/ultracart_api/models/item_option_value_additional_item.rb +195 -0
- data/lib/ultracart_api/models/item_option_value_digital_item.rb +195 -0
- data/lib/ultracart_api/models/item_payment_processing.rb +229 -0
- data/lib/ultracart_api/models/item_physical.rb +211 -0
- data/lib/ultracart_api/models/item_pricing.rb +387 -0
- data/lib/ultracart_api/models/item_pricing_tier.rb +226 -0
- data/lib/ultracart_api/models/item_pricing_tier_discount.rb +195 -0
- data/lib/ultracart_api/models/item_pricing_tier_limit.rb +205 -0
- data/lib/ultracart_api/models/item_property.rb +235 -0
- data/lib/ultracart_api/models/item_realtime_pricing.rb +205 -0
- data/lib/ultracart_api/models/item_related.rb +207 -0
- data/lib/ultracart_api/models/item_related_item.rb +239 -0
- data/lib/ultracart_api/models/item_reporting.rb +197 -0
- data/lib/ultracart_api/models/item_response.rb +221 -0
- data/lib/ultracart_api/models/item_restriction.rb +257 -0
- data/lib/ultracart_api/models/item_restriction_item.rb +239 -0
- data/lib/ultracart_api/models/item_revguard.rb +245 -0
- data/lib/ultracart_api/models/item_reviews.rb +245 -0
- data/lib/ultracart_api/models/item_salesforce.rb +195 -0
- data/lib/ultracart_api/models/item_shipping.rb +678 -0
- data/lib/ultracart_api/models/item_shipping_case.rb +230 -0
- data/lib/ultracart_api/models/item_shipping_destination_markup.rb +280 -0
- data/lib/ultracart_api/models/item_shipping_destination_restriction.rb +269 -0
- data/lib/ultracart_api/models/item_shipping_distribution_center.rb +335 -0
- data/lib/ultracart_api/models/item_shipping_method.rb +359 -0
- data/lib/ultracart_api/models/item_shipping_package_requirement.rb +195 -0
- data/lib/ultracart_api/models/item_tag.rb +244 -0
- data/lib/ultracart_api/models/item_tags.rb +187 -0
- data/lib/ultracart_api/models/item_tax.rb +207 -0
- data/lib/ultracart_api/models/item_tax_exemption.rb +300 -0
- data/lib/ultracart_api/models/item_third_party_email_marketing.rb +267 -0
- data/lib/ultracart_api/models/item_variant_item.rb +254 -0
- data/lib/ultracart_api/models/item_variation.rb +257 -0
- data/lib/ultracart_api/models/item_variation_option.rb +230 -0
- data/lib/ultracart_api/models/item_wishlist_member.rb +220 -0
- data/lib/ultracart_api/models/items_request.rb +187 -0
- data/lib/ultracart_api/models/items_response.rb +224 -0
- data/lib/ultracart_api/models/key_value.rb +205 -0
- data/lib/ultracart_api/models/library_filter_values.rb +219 -0
- data/lib/ultracart_api/models/library_filter_values_response.rb +221 -0
- data/lib/ultracart_api/models/library_item.rb +571 -0
- data/lib/ultracart_api/models/library_item_account.rb +202 -0
- data/lib/ultracart_api/models/library_item_asset.rb +193 -0
- data/lib/ultracart_api/models/library_item_attribute.rb +202 -0
- data/lib/ultracart_api/models/library_item_email.rb +202 -0
- data/lib/ultracart_api/models/library_item_published_meta.rb +255 -0
- data/lib/ultracart_api/models/library_item_purchased_meta.rb +205 -0
- data/lib/ultracart_api/models/library_item_query.rb +295 -0
- data/lib/ultracart_api/models/library_item_response.rb +221 -0
- data/lib/ultracart_api/models/library_item_screenshot.rb +193 -0
- data/lib/ultracart_api/models/library_items_response.rb +224 -0
- data/lib/ultracart_api/models/linked_account.rb +205 -0
- data/lib/ultracart_api/models/list_segment_membership.rb +202 -0
- data/lib/ultracart_api/models/lookup_request.rb +220 -0
- data/lib/ultracart_api/models/lookup_response.rb +223 -0
- data/lib/ultracart_api/models/metric.rb +247 -0
- data/lib/ultracart_api/models/notification.rb +287 -0
- data/lib/ultracart_api/models/oauth_revoke_success_response.rb +195 -0
- data/lib/ultracart_api/models/oauth_token_response.rb +286 -0
- data/lib/ultracart_api/models/order.rb +569 -0
- data/lib/ultracart_api/models/order_affiliate.rb +207 -0
- data/lib/ultracart_api/models/order_affiliate_ledger.rb +299 -0
- data/lib/ultracart_api/models/order_auto_order.rb +403 -0
- data/lib/ultracart_api/models/order_billing.rb +537 -0
- data/lib/ultracart_api/models/order_buysafe.rb +233 -0
- data/lib/ultracart_api/models/order_by_token_query.rb +185 -0
- data/lib/ultracart_api/models/order_channel_partner.rb +275 -0
- data/lib/ultracart_api/models/order_checkout.rb +415 -0
- data/lib/ultracart_api/models/order_coupon.rb +245 -0
- data/lib/ultracart_api/models/order_digital_item.rb +255 -0
- data/lib/ultracart_api/models/order_digital_order.rb +227 -0
- data/lib/ultracart_api/models/order_edi.rb +230 -0
- data/lib/ultracart_api/models/order_format.rb +369 -0
- data/lib/ultracart_api/models/order_format_response.rb +197 -0
- data/lib/ultracart_api/models/order_fraud_score.rb +409 -0
- data/lib/ultracart_api/models/order_gift.rb +316 -0
- data/lib/ultracart_api/models/order_gift_certificate.rb +204 -0
- data/lib/ultracart_api/models/order_internal.rb +240 -0
- data/lib/ultracart_api/models/order_item.rb +800 -0
- data/lib/ultracart_api/models/order_item_edi.rb +199 -0
- data/lib/ultracart_api/models/order_item_edi_identification.rb +195 -0
- data/lib/ultracart_api/models/order_item_edi_lot.rb +205 -0
- data/lib/ultracart_api/models/order_item_option.rb +343 -0
- data/lib/ultracart_api/models/order_item_option_file_attachment.rb +215 -0
- data/lib/ultracart_api/models/order_item_property.rb +245 -0
- data/lib/ultracart_api/models/order_item_tag.rb +200 -0
- data/lib/ultracart_api/models/order_linked_shipment.rb +229 -0
- data/lib/ultracart_api/models/order_marketing.rb +235 -0
- data/lib/ultracart_api/models/order_payment.rb +388 -0
- data/lib/ultracart_api/models/order_payment_check.rb +185 -0
- data/lib/ultracart_api/models/order_payment_credit_card.rb +319 -0
- data/lib/ultracart_api/models/order_payment_e_check.rb +441 -0
- data/lib/ultracart_api/models/order_payment_purchase_order.rb +185 -0
- data/lib/ultracart_api/models/order_payment_transaction.rb +217 -0
- data/lib/ultracart_api/models/order_payment_transaction_detail.rb +205 -0
- data/lib/ultracart_api/models/order_process_payment_request.rb +185 -0
- data/lib/ultracart_api/models/order_process_payment_response.rb +221 -0
- data/lib/ultracart_api/models/order_property.rb +245 -0
- data/lib/ultracart_api/models/order_query.rb +701 -0
- data/lib/ultracart_api/models/order_query_batch.rb +187 -0
- data/lib/ultracart_api/models/order_quote.rb +205 -0
- data/lib/ultracart_api/models/order_replacement.rb +432 -0
- data/lib/ultracart_api/models/order_replacement_item.rb +220 -0
- data/lib/ultracart_api/models/order_replacement_response.rb +229 -0
- data/lib/ultracart_api/models/order_response.rb +221 -0
- data/lib/ultracart_api/models/order_salesforce.rb +185 -0
- data/lib/ultracart_api/models/order_shipping.rb +710 -0
- data/lib/ultracart_api/models/order_summary.rb +328 -0
- data/lib/ultracart_api/models/order_tag.rb +200 -0
- data/lib/ultracart_api/models/order_taxes.rb +360 -0
- data/lib/ultracart_api/models/order_token_response.rb +222 -0
- data/lib/ultracart_api/models/order_tracking_number_detail.rb +265 -0
- data/lib/ultracart_api/models/order_tracking_number_details.rb +330 -0
- data/lib/ultracart_api/models/orders_response.rb +224 -0
- data/lib/ultracart_api/models/permission.rb +205 -0
- data/lib/ultracart_api/models/pricing_tier.rb +498 -0
- data/lib/ultracart_api/models/pricing_tier_notification.rb +235 -0
- data/lib/ultracart_api/models/pricing_tiers_response.rb +224 -0
- data/lib/ultracart_api/models/property.rb +193 -0
- data/lib/ultracart_api/models/publish_library_item_request.rb +185 -0
- data/lib/ultracart_api/models/register_affiliate_click_request.rb +235 -0
- data/lib/ultracart_api/models/register_affiliate_click_response.rb +219 -0
- data/lib/ultracart_api/models/response_metadata.rb +194 -0
- data/lib/ultracart_api/models/result_set.rb +235 -0
- data/lib/ultracart_api/models/screen_recording.rb +477 -0
- data/lib/ultracart_api/models/screen_recording_filter.rb +426 -0
- data/lib/ultracart_api/models/screen_recording_filter_geo_distance.rb +220 -0
- data/lib/ultracart_api/models/screen_recording_filter_ip_search.rb +211 -0
- data/lib/ultracart_api/models/screen_recording_filter_page_view.rb +244 -0
- data/lib/ultracart_api/models/screen_recording_filter_page_view_event.rb +195 -0
- data/lib/ultracart_api/models/screen_recording_filter_page_view_event_param.rb +220 -0
- data/lib/ultracart_api/models/screen_recording_filter_page_view_param.rb +193 -0
- data/lib/ultracart_api/models/screen_recording_filter_page_view_referrer_param.rb +193 -0
- data/lib/ultracart_api/models/screen_recording_filter_range_big_decimal.rb +220 -0
- data/lib/ultracart_api/models/screen_recording_filter_range_date.rb +195 -0
- data/lib/ultracart_api/models/screen_recording_filter_range_integer.rb +220 -0
- data/lib/ultracart_api/models/screen_recording_filter_string_search.rb +220 -0
- data/lib/ultracart_api/models/screen_recording_filter_values.rb +283 -0
- data/lib/ultracart_api/models/screen_recording_filter_values_event.rb +195 -0
- data/lib/ultracart_api/models/screen_recording_filter_values_event_params.rb +228 -0
- data/lib/ultracart_api/models/screen_recording_multifield.rb +220 -0
- data/lib/ultracart_api/models/screen_recording_page_view.rb +318 -0
- data/lib/ultracart_api/models/screen_recording_page_view_event.rb +214 -0
- data/lib/ultracart_api/models/screen_recording_page_view_event_parameter.rb +193 -0
- data/lib/ultracart_api/models/screen_recording_page_view_parameter.rb +193 -0
- data/lib/ultracart_api/models/screen_recording_query_request.rb +184 -0
- data/lib/ultracart_api/models/screen_recording_query_response.rb +241 -0
- data/lib/ultracart_api/models/screen_recording_response.rb +221 -0
- data/lib/ultracart_api/models/screen_recording_segment.rb +238 -0
- data/lib/ultracart_api/models/screen_recording_segment_response.rb +221 -0
- data/lib/ultracart_api/models/screen_recording_segments_response.rb +223 -0
- data/lib/ultracart_api/models/screen_recording_settings.rb +184 -0
- data/lib/ultracart_api/models/screen_recording_settings_response.rb +221 -0
- data/lib/ultracart_api/models/screen_recording_store_front.rb +193 -0
- data/lib/ultracart_api/models/screen_recording_tags_request.rb +186 -0
- data/lib/ultracart_api/models/screen_recording_tags_response.rb +223 -0
- data/lib/ultracart_api/models/screen_recording_user_agent.rb +220 -0
- data/lib/ultracart_api/models/screen_recording_user_agent_device.rb +184 -0
- data/lib/ultracart_api/models/screen_recording_user_agent_os.rb +202 -0
- data/lib/ultracart_api/models/screen_recording_user_property.rb +193 -0
- data/lib/ultracart_api/models/screenshots_response.rb +224 -0
- data/lib/ultracart_api/models/self_config.rb +185 -0
- data/lib/ultracart_api/models/simple_value.rb +195 -0
- data/lib/ultracart_api/models/sovos_config.rb +245 -0
- data/lib/ultracart_api/models/state_province.rb +210 -0
- data/lib/ultracart_api/models/step_waiting.rb +193 -0
- data/lib/ultracart_api/models/tax_city.rb +267 -0
- data/lib/ultracart_api/models/tax_country.rb +267 -0
- data/lib/ultracart_api/models/tax_country_code.rb +225 -0
- data/lib/ultracart_api/models/tax_county.rb +277 -0
- data/lib/ultracart_api/models/tax_jar_config.rb +235 -0
- data/lib/ultracart_api/models/tax_postal_code.rb +245 -0
- data/lib/ultracart_api/models/tax_provider_activate_result.rb +194 -0
- data/lib/ultracart_api/models/tax_provider_avalara.rb +214 -0
- data/lib/ultracart_api/models/tax_provider_avalara_companies_result.rb +187 -0
- data/lib/ultracart_api/models/tax_provider_avalara_company.rb +225 -0
- data/lib/ultracart_api/models/tax_provider_self.rb +226 -0
- data/lib/ultracart_api/models/tax_provider_self_countries_response.rb +187 -0
- data/lib/ultracart_api/models/tax_provider_self_regions_response.rb +187 -0
- data/lib/ultracart_api/models/tax_provider_sovos.rb +214 -0
- data/lib/ultracart_api/models/tax_provider_tax_jar.rb +214 -0
- data/lib/ultracart_api/models/tax_provider_test_result.rb +194 -0
- data/lib/ultracart_api/models/tax_provider_ultra_cart.rb +226 -0
- data/lib/ultracart_api/models/tax_provider_ultra_cart_state.rb +245 -0
- data/lib/ultracart_api/models/tax_providers_response.rb +257 -0
- data/lib/ultracart_api/models/tax_state.rb +327 -0
- data/lib/ultracart_api/models/tax_state_code.rb +225 -0
- data/lib/ultracart_api/models/temp_multimedia.rb +294 -0
- data/lib/ultracart_api/models/temp_multimedia_response.rb +221 -0
- data/lib/ultracart_api/models/thumbnail_parameters_request.rb +220 -0
- data/lib/ultracart_api/models/thumbnail_parameters_response.rb +222 -0
- data/lib/ultracart_api/models/transaction_email.rb +379 -0
- data/lib/ultracart_api/models/transaction_email_list_response.rb +223 -0
- data/lib/ultracart_api/models/transaction_email_option.rb +247 -0
- data/lib/ultracart_api/models/transaction_email_response.rb +221 -0
- data/lib/ultracart_api/models/ultra_cart_config.rb +185 -0
- data/lib/ultracart_api/models/upload_coupon_codes_request.rb +224 -0
- data/lib/ultracart_api/models/upload_coupon_codes_response.rb +248 -0
- data/lib/ultracart_api/models/user.rb +327 -0
- data/lib/ultracart_api/models/user_group_membership.rb +205 -0
- data/lib/ultracart_api/models/user_login.rb +215 -0
- data/lib/ultracart_api/models/user_logins_response.rb +224 -0
- data/lib/ultracart_api/models/user_response.rb +221 -0
- data/lib/ultracart_api/models/users_response.rb +223 -0
- data/lib/ultracart_api/models/verification_record.rb +202 -0
- data/lib/ultracart_api/models/warning.rb +195 -0
- data/lib/ultracart_api/models/webhook.rb +402 -0
- data/lib/ultracart_api/models/webhook_event_category.rb +229 -0
- data/lib/ultracart_api/models/webhook_event_subscription.rb +265 -0
- data/lib/ultracart_api/models/webhook_log.rb +279 -0
- data/lib/ultracart_api/models/webhook_log_response.rb +221 -0
- data/lib/ultracart_api/models/webhook_log_summaries_response.rb +224 -0
- data/lib/ultracart_api/models/webhook_log_summary.rb +205 -0
- data/lib/ultracart_api/models/webhook_response.rb +221 -0
- data/lib/ultracart_api/models/webhook_sample_request.rb +217 -0
- data/lib/ultracart_api/models/webhook_sample_request_response.rb +221 -0
- data/lib/ultracart_api/models/webhooks_response.rb +223 -0
- data/lib/ultracart_api/models/weight.rb +229 -0
- data/lib/ultracart_api/version.rb +15 -0
- data/spec/api_client_spec.rb +243 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/spec_helper.rb +111 -0
- data/ultracart_api.gemspec +45 -0
- metadata +1380 -0
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# UltracartClient::LinkedAccount
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**company** | **String** | The company name of this linked account. | [optional]
|
|
7
|
+
**merchant_id** | **String** | A merchant id that is linked to this account. | [optional]
|
|
8
|
+
**selected** | **BOOLEAN** | If true, this user configuration (permissions, notifications, everything) is cascaded to this linked account. | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# UltracartClient::ListSegmentMembership
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**name** | **String** | | [optional]
|
|
7
|
+
**type** | **String** | | [optional]
|
|
8
|
+
**uuid** | **String** | | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# UltracartClient::LookupRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**category** | **String** | | [optional]
|
|
7
|
+
**matches** | **String** | | [optional]
|
|
8
|
+
**max_hits** | **Integer** | | [optional]
|
|
9
|
+
**storefront_oid** | **Integer** | | [optional]
|
|
10
|
+
**subcategory** | **String** | | [optional]
|
|
11
|
+
|
|
12
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# UltracartClient::LookupResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
|
7
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
|
8
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
|
9
|
+
**values** | [**Array<KeyValue>**](KeyValue.md) | | [optional]
|
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
|
11
|
+
|
|
12
|
+
|
data/docs/Metric.md
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# UltracartClient::Metric
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**all_time** | **Float** | | [optional]
|
|
7
|
+
**all_time_formatted** | **String** | | [optional]
|
|
8
|
+
**last_30** | **Float** | | [optional]
|
|
9
|
+
**last_30_formatted** | **String** | | [optional]
|
|
10
|
+
**name** | **String** | | [optional]
|
|
11
|
+
**prior_30** | **Float** | | [optional]
|
|
12
|
+
**prior_30_formatted** | **String** | | [optional]
|
|
13
|
+
**type** | **String** | | [optional]
|
|
14
|
+
|
|
15
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# UltracartClient::Notification
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**can_filter_by_distribution_centers** | **BOOLEAN** | True if this notification can be filtered to only send for one or more distribution centers. | [optional]
|
|
7
|
+
**can_include_affiliate** | **BOOLEAN** | True if this notification can include an affiliate information. | [optional]
|
|
8
|
+
**can_include_order** | **BOOLEAN** | True if this notification can include an order attachment. | [optional]
|
|
9
|
+
**can_include_order_plain_text** | **BOOLEAN** | True if this notification can include a plain text rendering of an order directly within an email. Some desire this over an attachment | [optional]
|
|
10
|
+
**distribution_center_filters** | **Array<String>** | If this notification supports it, this list of distribution center CODES will filter the notification to just those distribution centers. | [optional]
|
|
11
|
+
**include_affiliate** | **BOOLEAN** | If true, and this notification supports it, affiliate information will be attached to all notifications of this type | [optional]
|
|
12
|
+
**include_order** | **BOOLEAN** | If true, and this notification supports it, the order will be attached to all notifications of this type | [optional]
|
|
13
|
+
**include_order_plain_text** | **BOOLEAN** | If true, and this notification supports it, a plain text order will be directly inserted into all notifications of this type | [optional]
|
|
14
|
+
**name** | **String** | The name of this notification. | [optional]
|
|
15
|
+
**notification_group** | **String** | A group for this notification. This name is only used for visual grouping within interfaces. | [optional]
|
|
16
|
+
**selected** | **BOOLEAN** | True if this user wishes to receive this email notification. | [optional]
|
|
17
|
+
|
|
18
|
+
|
data/docs/OauthApi.md
ADDED
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
# UltracartClient::OauthApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**oauth_access_token**](OauthApi.md#oauth_access_token) | **POST** /oauth/token | Exchange authorization code for access token.
|
|
8
|
+
[**oauth_revoke**](OauthApi.md#oauth_revoke) | **POST** /oauth/revoke | Revoke this OAuth application.
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
# **oauth_access_token**
|
|
12
|
+
> OauthTokenResponse oauth_access_token(client_id, grant_type, opts)
|
|
13
|
+
|
|
14
|
+
Exchange authorization code for access token.
|
|
15
|
+
|
|
16
|
+
The final leg in the OAuth process which exchanges the specified access token for the access code needed to make API calls.
|
|
17
|
+
|
|
18
|
+
### Example
|
|
19
|
+
```ruby
|
|
20
|
+
# load the gem
|
|
21
|
+
require 'ultracart_api'
|
|
22
|
+
# setup authorization
|
|
23
|
+
UltracartClient.configure do |config|
|
|
24
|
+
# Configure API key authorization: ultraCartBrowserApiKey
|
|
25
|
+
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
|
26
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
27
|
+
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
|
28
|
+
|
|
29
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
30
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
31
|
+
|
|
32
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
33
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
34
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
35
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
36
|
+
end
|
|
37
|
+
|
|
38
|
+
api_instance = UltracartClient::OauthApi.new
|
|
39
|
+
|
|
40
|
+
client_id = 'client_id_example' # String | The OAuth application client_id.
|
|
41
|
+
|
|
42
|
+
grant_type = 'grant_type_example' # String | Type of grant
|
|
43
|
+
|
|
44
|
+
opts = {
|
|
45
|
+
code: 'code_example', # String | Authorization code received back from the browser redirect
|
|
46
|
+
redirect_uri: 'redirect_uri_example', # String | The URI that you redirect the browser to to start the authorization process
|
|
47
|
+
refresh_token: 'refresh_token_example' # String | The refresh token received during the original grant_type=authorization_code that can be used to return a new access token
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
begin
|
|
51
|
+
#Exchange authorization code for access token.
|
|
52
|
+
result = api_instance.oauth_access_token(client_id, grant_type, opts)
|
|
53
|
+
p result
|
|
54
|
+
rescue UltracartClient::ApiError => e
|
|
55
|
+
puts "Exception when calling OauthApi->oauth_access_token: #{e}"
|
|
56
|
+
end
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### Parameters
|
|
60
|
+
|
|
61
|
+
Name | Type | Description | Notes
|
|
62
|
+
------------- | ------------- | ------------- | -------------
|
|
63
|
+
**client_id** | **String**| The OAuth application client_id. |
|
|
64
|
+
**grant_type** | **String**| Type of grant |
|
|
65
|
+
**code** | **String**| Authorization code received back from the browser redirect | [optional]
|
|
66
|
+
**redirect_uri** | **String**| The URI that you redirect the browser to to start the authorization process | [optional]
|
|
67
|
+
**refresh_token** | **String**| The refresh token received during the original grant_type=authorization_code that can be used to return a new access token | [optional]
|
|
68
|
+
|
|
69
|
+
### Return type
|
|
70
|
+
|
|
71
|
+
[**OauthTokenResponse**](OauthTokenResponse.md)
|
|
72
|
+
|
|
73
|
+
### Authorization
|
|
74
|
+
|
|
75
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
76
|
+
|
|
77
|
+
### HTTP request headers
|
|
78
|
+
|
|
79
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
|
80
|
+
- **Accept**: application/json
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
# **oauth_revoke**
|
|
85
|
+
> OauthRevokeSuccessResponse oauth_revoke(client_id, token)
|
|
86
|
+
|
|
87
|
+
Revoke this OAuth application.
|
|
88
|
+
|
|
89
|
+
Revokes the OAuth application associated with the specified client_id and token.
|
|
90
|
+
|
|
91
|
+
### Example
|
|
92
|
+
```ruby
|
|
93
|
+
# load the gem
|
|
94
|
+
require 'ultracart_api'
|
|
95
|
+
# setup authorization
|
|
96
|
+
UltracartClient.configure do |config|
|
|
97
|
+
# Configure API key authorization: ultraCartBrowserApiKey
|
|
98
|
+
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
|
99
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
100
|
+
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
|
101
|
+
|
|
102
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
103
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
104
|
+
|
|
105
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
106
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
107
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
108
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
109
|
+
end
|
|
110
|
+
|
|
111
|
+
api_instance = UltracartClient::OauthApi.new
|
|
112
|
+
|
|
113
|
+
client_id = 'client_id_example' # String | The OAuth application client_id.
|
|
114
|
+
|
|
115
|
+
token = 'token_example' # String | The OAuth access token that is to be revoked..
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
begin
|
|
119
|
+
#Revoke this OAuth application.
|
|
120
|
+
result = api_instance.oauth_revoke(client_id, token)
|
|
121
|
+
p result
|
|
122
|
+
rescue UltracartClient::ApiError => e
|
|
123
|
+
puts "Exception when calling OauthApi->oauth_revoke: #{e}"
|
|
124
|
+
end
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
### Parameters
|
|
128
|
+
|
|
129
|
+
Name | Type | Description | Notes
|
|
130
|
+
------------- | ------------- | ------------- | -------------
|
|
131
|
+
**client_id** | **String**| The OAuth application client_id. |
|
|
132
|
+
**token** | **String**| The OAuth access token that is to be revoked.. |
|
|
133
|
+
|
|
134
|
+
### Return type
|
|
135
|
+
|
|
136
|
+
[**OauthRevokeSuccessResponse**](OauthRevokeSuccessResponse.md)
|
|
137
|
+
|
|
138
|
+
### Authorization
|
|
139
|
+
|
|
140
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
141
|
+
|
|
142
|
+
### HTTP request headers
|
|
143
|
+
|
|
144
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
|
145
|
+
- **Accept**: application/json
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# UltracartClient::OauthRevokeSuccessResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**message** | **String** | Message confirming revocation of credentials | [optional]
|
|
7
|
+
**successful** | **BOOLEAN** | True if revoke was successful | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# UltracartClient::OauthTokenResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**access_token** | **String** | Access token to use in OAuth authenticated API call | [optional]
|
|
7
|
+
**error** | **String** | | [optional]
|
|
8
|
+
**error_description** | **String** | | [optional]
|
|
9
|
+
**error_uri** | **String** | | [optional]
|
|
10
|
+
**expires_in** | **String** | The number of seconds since issuance when the access token will expire and need to be refreshed using the refresh token | [optional]
|
|
11
|
+
**refresh_token** | **String** | The refresh token that should be used to fetch a new access token when the expiration occurs | [optional]
|
|
12
|
+
**scope** | **String** | The scope of permissions associated with teh access token | [optional]
|
|
13
|
+
**token_type** | **String** | Type of token | [optional]
|
|
14
|
+
|
|
15
|
+
|
data/docs/Order.md
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# UltracartClient::Order
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**affiliates** | [**Array<OrderAffiliate>**](OrderAffiliate.md) | Affiliates if any were associated with the order. The first one in the array sent the order and each subsequent affiliate is the recruiter that earns a downline commission. | [optional]
|
|
7
|
+
**auto_order** | [**OrderAutoOrder**](OrderAutoOrder.md) | | [optional]
|
|
8
|
+
**billing** | [**OrderBilling**](OrderBilling.md) | | [optional]
|
|
9
|
+
**buysafe** | [**OrderBuysafe**](OrderBuysafe.md) | | [optional]
|
|
10
|
+
**channel_partner** | [**OrderChannelPartner**](OrderChannelPartner.md) | | [optional]
|
|
11
|
+
**checkout** | [**OrderCheckout**](OrderCheckout.md) | | [optional]
|
|
12
|
+
**coupons** | [**Array<OrderCoupon>**](OrderCoupon.md) | Coupons | [optional]
|
|
13
|
+
**creation_dts** | **String** | Date/time that the order was created | [optional]
|
|
14
|
+
**currency_code** | **String** | Currency code that the customer used if different than the merchant's base currency code | [optional]
|
|
15
|
+
**current_stage** | **String** | Current stage that the order is in. | [optional]
|
|
16
|
+
**customer_profile** | [**Customer**](Customer.md) | | [optional]
|
|
17
|
+
**digital_order** | [**OrderDigitalOrder**](OrderDigitalOrder.md) | | [optional]
|
|
18
|
+
**edi** | [**OrderEdi**](OrderEdi.md) | | [optional]
|
|
19
|
+
**exchange_rate** | **Float** | Exchange rate at the time the order was placed if currency code is different than the base currency | [optional]
|
|
20
|
+
**fraud_score** | [**OrderFraudScore**](OrderFraudScore.md) | | [optional]
|
|
21
|
+
**gift** | [**OrderGift**](OrderGift.md) | | [optional]
|
|
22
|
+
**gift_certificate** | [**OrderGiftCertificate**](OrderGiftCertificate.md) | | [optional]
|
|
23
|
+
**internal** | [**OrderInternal**](OrderInternal.md) | | [optional]
|
|
24
|
+
**items** | [**Array<OrderItem>**](OrderItem.md) | Items | [optional]
|
|
25
|
+
**language_iso_code** | **String** | Three letter ISO-639 language code used by the customer during the checkout if different than the default language | [optional]
|
|
26
|
+
**linked_shipment** | [**OrderLinkedShipment**](OrderLinkedShipment.md) | | [optional]
|
|
27
|
+
**marketing** | [**OrderMarketing**](OrderMarketing.md) | | [optional]
|
|
28
|
+
**merchant_id** | **String** | UltraCart merchant ID owning this order | [optional]
|
|
29
|
+
**order_id** | **String** | Order ID | [optional]
|
|
30
|
+
**payment** | [**OrderPayment**](OrderPayment.md) | | [optional]
|
|
31
|
+
**properties** | [**Array<OrderProperty>**](OrderProperty.md) | Properties, available only through update, not through insert due to the nature of how properties are handled internally | [optional]
|
|
32
|
+
**quote** | [**OrderQuote**](OrderQuote.md) | | [optional]
|
|
33
|
+
**refund_dts** | **String** | If the order was refunded, the date/time that the last refund occurred | [optional]
|
|
34
|
+
**reject_dts** | **String** | If the order was rejected, the date/time that the rejection occurred | [optional]
|
|
35
|
+
**salesforce** | [**OrderSalesforce**](OrderSalesforce.md) | | [optional]
|
|
36
|
+
**shipping** | [**OrderShipping**](OrderShipping.md) | | [optional]
|
|
37
|
+
**summary** | [**OrderSummary**](OrderSummary.md) | | [optional]
|
|
38
|
+
**tags** | [**Array<OrderTag>**](OrderTag.md) | tags, available only through update, not through insert due to the nature of how tags are handled internally | [optional]
|
|
39
|
+
**taxes** | [**OrderTaxes**](OrderTaxes.md) | | [optional]
|
|
40
|
+
|
|
41
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# UltracartClient::OrderAffiliate
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**affiliate_oid** | **Integer** | Affiliate ID | [optional]
|
|
7
|
+
**ledger_entries** | [**Array<OrderAffiliateLedger>**](OrderAffiliateLedger.md) | Ledger entries associated with all the commissions earned on this order | [optional]
|
|
8
|
+
**sub_id** | **String** | Sub identifier provided by the affiliate on the click that generated this order | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# UltracartClient::OrderAffiliateLedger
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**assigned_by_user** | **String** | UltraCart user name that assigned this commission if manually assigned | [optional]
|
|
7
|
+
**item_id** | **String** | Item ID that this ledger record is associated with | [optional]
|
|
8
|
+
**tier_number** | **Integer** | Tier number of this affiliate in the commission calculation | [optional]
|
|
9
|
+
**transaction_amount** | **Float** | Amount of the transaction | [optional]
|
|
10
|
+
**transaction_amount_paid** | **Float** | The amount that has been paid so far on the transaction | [optional]
|
|
11
|
+
**transaction_dts** | **String** | The date/time that the affiliate ledger was generated for the transaction | [optional]
|
|
12
|
+
**transaction_memo** | **String** | Details of the transaction suitable for display to the affiliate | [optional]
|
|
13
|
+
**transaction_percentage** | **Float** | The percentage earned on the transaction | [optional]
|
|
14
|
+
**transaction_state** | **String** | The state of the transaction | [optional]
|
|
15
|
+
|
|
16
|
+
|
data/docs/OrderApi.md
ADDED
|
@@ -0,0 +1,1293 @@
|
|
|
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
|
+
[**format**](OrderApi.md#format) | **POST** /order/orders/{order_id}/format | Format order
|
|
11
|
+
[**generate_order_token**](OrderApi.md#generate_order_token) | **GET** /order/orders/token/{order_id} | Generate an order token for a given order id
|
|
12
|
+
[**get_accounts_receivable_retry_config**](OrderApi.md#get_accounts_receivable_retry_config) | **GET** /order/accountsReceivableRetryConfig | Retrieve A/R Retry Configuration
|
|
13
|
+
[**get_accounts_receivable_retry_stats**](OrderApi.md#get_accounts_receivable_retry_stats) | **GET** /order/accountsReceivableRetryConfig/stats | Retrieve A/R Retry Statistics
|
|
14
|
+
[**get_order**](OrderApi.md#get_order) | **GET** /order/orders/{order_id} | Retrieve an order
|
|
15
|
+
[**get_order_by_token**](OrderApi.md#get_order_by_token) | **POST** /order/orders/token | Retrieve an order using a token
|
|
16
|
+
[**get_orders**](OrderApi.md#get_orders) | **GET** /order/orders | Retrieve orders
|
|
17
|
+
[**get_orders_batch**](OrderApi.md#get_orders_batch) | **POST** /order/orders/batch | Retrieve order batch
|
|
18
|
+
[**get_orders_by_query**](OrderApi.md#get_orders_by_query) | **POST** /order/orders/query | Retrieve orders
|
|
19
|
+
[**insert_order**](OrderApi.md#insert_order) | **POST** /order/orders | Insert an order
|
|
20
|
+
[**process_payment**](OrderApi.md#process_payment) | **POST** /order/orders/{order_id}/process_payment | Process payment
|
|
21
|
+
[**refund_order**](OrderApi.md#refund_order) | **PUT** /order/orders/{order_id}/refund | Refund an order
|
|
22
|
+
[**replacement**](OrderApi.md#replacement) | **POST** /order/orders/{order_id}/replacement | Replacement order
|
|
23
|
+
[**resend_receipt**](OrderApi.md#resend_receipt) | **POST** /order/orders/{order_id}/resend_receipt | Resend receipt
|
|
24
|
+
[**resend_shipment_confirmation**](OrderApi.md#resend_shipment_confirmation) | **POST** /order/orders/{order_id}/resend_shipment_confirmation | Resend shipment confirmation
|
|
25
|
+
[**update_accounts_receivable_retry_config**](OrderApi.md#update_accounts_receivable_retry_config) | **POST** /order/accountsReceivableRetryConfig | Update A/R Retry Configuration
|
|
26
|
+
[**update_order**](OrderApi.md#update_order) | **PUT** /order/orders/{order_id} | Update an order
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
# **adjust_order_total**
|
|
30
|
+
> BaseResponse adjust_order_total(order_id, desired_total)
|
|
31
|
+
|
|
32
|
+
Adjusts an order total
|
|
33
|
+
|
|
34
|
+
Adjusts an order total. Adjusts individual items appropriately and considers taxes. Desired total should be provided in the same currency as the order. Returns true if successful.
|
|
35
|
+
|
|
36
|
+
### Example
|
|
37
|
+
```ruby
|
|
38
|
+
# load the gem
|
|
39
|
+
require 'ultracart_api'
|
|
40
|
+
# setup authorization
|
|
41
|
+
UltracartClient.configure do |config|
|
|
42
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
43
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
44
|
+
|
|
45
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
46
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
47
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
48
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
api_instance = UltracartClient::OrderApi.new
|
|
52
|
+
|
|
53
|
+
order_id = 'order_id_example' # String | The order id to cancel.
|
|
54
|
+
|
|
55
|
+
desired_total = 'desired_total_example' # String | The desired total with no formatting. example 123.45
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
begin
|
|
59
|
+
#Adjusts an order total
|
|
60
|
+
result = api_instance.adjust_order_total(order_id, desired_total)
|
|
61
|
+
p result
|
|
62
|
+
rescue UltracartClient::ApiError => e
|
|
63
|
+
puts "Exception when calling OrderApi->adjust_order_total: #{e}"
|
|
64
|
+
end
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### Parameters
|
|
68
|
+
|
|
69
|
+
Name | Type | Description | Notes
|
|
70
|
+
------------- | ------------- | ------------- | -------------
|
|
71
|
+
**order_id** | **String**| The order id to cancel. |
|
|
72
|
+
**desired_total** | **String**| The desired total with no formatting. example 123.45 |
|
|
73
|
+
|
|
74
|
+
### Return type
|
|
75
|
+
|
|
76
|
+
[**BaseResponse**](BaseResponse.md)
|
|
77
|
+
|
|
78
|
+
### Authorization
|
|
79
|
+
|
|
80
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
81
|
+
|
|
82
|
+
### HTTP request headers
|
|
83
|
+
|
|
84
|
+
- **Content-Type**: application/json
|
|
85
|
+
- **Accept**: application/json
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
# **cancel_order**
|
|
90
|
+
> BaseResponse cancel_order(order_id)
|
|
91
|
+
|
|
92
|
+
Cancel an order
|
|
93
|
+
|
|
94
|
+
Cancel an order on the UltraCart account. If the success flag is false, then consult the error message for why it failed.
|
|
95
|
+
|
|
96
|
+
### Example
|
|
97
|
+
```ruby
|
|
98
|
+
# load the gem
|
|
99
|
+
require 'ultracart_api'
|
|
100
|
+
# setup authorization
|
|
101
|
+
UltracartClient.configure do |config|
|
|
102
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
103
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
104
|
+
|
|
105
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
106
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
107
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
108
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
109
|
+
end
|
|
110
|
+
|
|
111
|
+
api_instance = UltracartClient::OrderApi.new
|
|
112
|
+
|
|
113
|
+
order_id = 'order_id_example' # String | The order id to cancel.
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
begin
|
|
117
|
+
#Cancel an order
|
|
118
|
+
result = api_instance.cancel_order(order_id)
|
|
119
|
+
p result
|
|
120
|
+
rescue UltracartClient::ApiError => e
|
|
121
|
+
puts "Exception when calling OrderApi->cancel_order: #{e}"
|
|
122
|
+
end
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
### Parameters
|
|
126
|
+
|
|
127
|
+
Name | Type | Description | Notes
|
|
128
|
+
------------- | ------------- | ------------- | -------------
|
|
129
|
+
**order_id** | **String**| The order id to cancel. |
|
|
130
|
+
|
|
131
|
+
### Return type
|
|
132
|
+
|
|
133
|
+
[**BaseResponse**](BaseResponse.md)
|
|
134
|
+
|
|
135
|
+
### Authorization
|
|
136
|
+
|
|
137
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
138
|
+
|
|
139
|
+
### HTTP request headers
|
|
140
|
+
|
|
141
|
+
- **Content-Type**: application/json
|
|
142
|
+
- **Accept**: application/json
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
# **delete_order**
|
|
147
|
+
> delete_order(order_id)
|
|
148
|
+
|
|
149
|
+
Delete an order
|
|
150
|
+
|
|
151
|
+
Delete an order on the UltraCart account.
|
|
152
|
+
|
|
153
|
+
### Example
|
|
154
|
+
```ruby
|
|
155
|
+
# load the gem
|
|
156
|
+
require 'ultracart_api'
|
|
157
|
+
# setup authorization
|
|
158
|
+
UltracartClient.configure do |config|
|
|
159
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
160
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
161
|
+
|
|
162
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
163
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
164
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
165
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
166
|
+
end
|
|
167
|
+
|
|
168
|
+
api_instance = UltracartClient::OrderApi.new
|
|
169
|
+
|
|
170
|
+
order_id = 'order_id_example' # String | The order id to delete.
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
begin
|
|
174
|
+
#Delete an order
|
|
175
|
+
api_instance.delete_order(order_id)
|
|
176
|
+
rescue UltracartClient::ApiError => e
|
|
177
|
+
puts "Exception when calling OrderApi->delete_order: #{e}"
|
|
178
|
+
end
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
### Parameters
|
|
182
|
+
|
|
183
|
+
Name | Type | Description | Notes
|
|
184
|
+
------------- | ------------- | ------------- | -------------
|
|
185
|
+
**order_id** | **String**| The order id to delete. |
|
|
186
|
+
|
|
187
|
+
### Return type
|
|
188
|
+
|
|
189
|
+
nil (empty response body)
|
|
190
|
+
|
|
191
|
+
### Authorization
|
|
192
|
+
|
|
193
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
194
|
+
|
|
195
|
+
### HTTP request headers
|
|
196
|
+
|
|
197
|
+
- **Content-Type**: application/json
|
|
198
|
+
- **Accept**: application/json
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
# **format**
|
|
203
|
+
> OrderFormatResponse format(order_id, format_options)
|
|
204
|
+
|
|
205
|
+
Format order
|
|
206
|
+
|
|
207
|
+
Format the order for display at text or html
|
|
208
|
+
|
|
209
|
+
### Example
|
|
210
|
+
```ruby
|
|
211
|
+
# load the gem
|
|
212
|
+
require 'ultracart_api'
|
|
213
|
+
# setup authorization
|
|
214
|
+
UltracartClient.configure do |config|
|
|
215
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
216
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
217
|
+
|
|
218
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
219
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
220
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
221
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
222
|
+
end
|
|
223
|
+
|
|
224
|
+
api_instance = UltracartClient::OrderApi.new
|
|
225
|
+
|
|
226
|
+
order_id = 'order_id_example' # String | The order id to format
|
|
227
|
+
|
|
228
|
+
format_options = UltracartClient::OrderFormat.new # OrderFormat | Format options
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
begin
|
|
232
|
+
#Format order
|
|
233
|
+
result = api_instance.format(order_id, format_options)
|
|
234
|
+
p result
|
|
235
|
+
rescue UltracartClient::ApiError => e
|
|
236
|
+
puts "Exception when calling OrderApi->format: #{e}"
|
|
237
|
+
end
|
|
238
|
+
```
|
|
239
|
+
|
|
240
|
+
### Parameters
|
|
241
|
+
|
|
242
|
+
Name | Type | Description | Notes
|
|
243
|
+
------------- | ------------- | ------------- | -------------
|
|
244
|
+
**order_id** | **String**| The order id to format |
|
|
245
|
+
**format_options** | [**OrderFormat**](OrderFormat.md)| Format options |
|
|
246
|
+
|
|
247
|
+
### Return type
|
|
248
|
+
|
|
249
|
+
[**OrderFormatResponse**](OrderFormatResponse.md)
|
|
250
|
+
|
|
251
|
+
### Authorization
|
|
252
|
+
|
|
253
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
254
|
+
|
|
255
|
+
### HTTP request headers
|
|
256
|
+
|
|
257
|
+
- **Content-Type**: application/json
|
|
258
|
+
- **Accept**: application/json
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
# **generate_order_token**
|
|
263
|
+
> OrderTokenResponse generate_order_token(order_id)
|
|
264
|
+
|
|
265
|
+
Generate an order token for a given order id
|
|
266
|
+
|
|
267
|
+
Retrieves a single order token for a given order id. The token can be used with the getOrderByToken API.
|
|
268
|
+
|
|
269
|
+
### Example
|
|
270
|
+
```ruby
|
|
271
|
+
# load the gem
|
|
272
|
+
require 'ultracart_api'
|
|
273
|
+
# setup authorization
|
|
274
|
+
UltracartClient.configure do |config|
|
|
275
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
276
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
277
|
+
|
|
278
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
279
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
280
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
281
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
282
|
+
end
|
|
283
|
+
|
|
284
|
+
api_instance = UltracartClient::OrderApi.new
|
|
285
|
+
|
|
286
|
+
order_id = 'order_id_example' # String | The order id to generate a token for.
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
begin
|
|
290
|
+
#Generate an order token for a given order id
|
|
291
|
+
result = api_instance.generate_order_token(order_id)
|
|
292
|
+
p result
|
|
293
|
+
rescue UltracartClient::ApiError => e
|
|
294
|
+
puts "Exception when calling OrderApi->generate_order_token: #{e}"
|
|
295
|
+
end
|
|
296
|
+
```
|
|
297
|
+
|
|
298
|
+
### Parameters
|
|
299
|
+
|
|
300
|
+
Name | Type | Description | Notes
|
|
301
|
+
------------- | ------------- | ------------- | -------------
|
|
302
|
+
**order_id** | **String**| The order id to generate a token for. |
|
|
303
|
+
|
|
304
|
+
### Return type
|
|
305
|
+
|
|
306
|
+
[**OrderTokenResponse**](OrderTokenResponse.md)
|
|
307
|
+
|
|
308
|
+
### Authorization
|
|
309
|
+
|
|
310
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
311
|
+
|
|
312
|
+
### HTTP request headers
|
|
313
|
+
|
|
314
|
+
- **Content-Type**: application/json
|
|
315
|
+
- **Accept**: application/json
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
# **get_accounts_receivable_retry_config**
|
|
320
|
+
> AccountsReceivableRetryConfigResponse get_accounts_receivable_retry_config
|
|
321
|
+
|
|
322
|
+
Retrieve A/R Retry Configuration
|
|
323
|
+
|
|
324
|
+
Retrieve A/R Retry Configuration. This is primarily an internal API call. It is doubtful you would ever need to use it.
|
|
325
|
+
|
|
326
|
+
### Example
|
|
327
|
+
```ruby
|
|
328
|
+
# load the gem
|
|
329
|
+
require 'ultracart_api'
|
|
330
|
+
# setup authorization
|
|
331
|
+
UltracartClient.configure do |config|
|
|
332
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
333
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
334
|
+
|
|
335
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
336
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
337
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
338
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
339
|
+
end
|
|
340
|
+
|
|
341
|
+
api_instance = UltracartClient::OrderApi.new
|
|
342
|
+
|
|
343
|
+
begin
|
|
344
|
+
#Retrieve A/R Retry Configuration
|
|
345
|
+
result = api_instance.get_accounts_receivable_retry_config
|
|
346
|
+
p result
|
|
347
|
+
rescue UltracartClient::ApiError => e
|
|
348
|
+
puts "Exception when calling OrderApi->get_accounts_receivable_retry_config: #{e}"
|
|
349
|
+
end
|
|
350
|
+
```
|
|
351
|
+
|
|
352
|
+
### Parameters
|
|
353
|
+
This endpoint does not need any parameter.
|
|
354
|
+
|
|
355
|
+
### Return type
|
|
356
|
+
|
|
357
|
+
[**AccountsReceivableRetryConfigResponse**](AccountsReceivableRetryConfigResponse.md)
|
|
358
|
+
|
|
359
|
+
### Authorization
|
|
360
|
+
|
|
361
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
362
|
+
|
|
363
|
+
### HTTP request headers
|
|
364
|
+
|
|
365
|
+
- **Content-Type**: application/json
|
|
366
|
+
- **Accept**: application/json
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
# **get_accounts_receivable_retry_stats**
|
|
371
|
+
> AccountsReceivableRetryStatsResponse get_accounts_receivable_retry_stats(opts)
|
|
372
|
+
|
|
373
|
+
Retrieve A/R Retry Statistics
|
|
374
|
+
|
|
375
|
+
Retrieve A/R Retry Statistics. This is primarily an internal API call. It is doubtful you would ever need to use it.
|
|
376
|
+
|
|
377
|
+
### Example
|
|
378
|
+
```ruby
|
|
379
|
+
# load the gem
|
|
380
|
+
require 'ultracart_api'
|
|
381
|
+
# setup authorization
|
|
382
|
+
UltracartClient.configure do |config|
|
|
383
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
384
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
385
|
+
|
|
386
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
387
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
388
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
389
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
390
|
+
end
|
|
391
|
+
|
|
392
|
+
api_instance = UltracartClient::OrderApi.new
|
|
393
|
+
|
|
394
|
+
opts = {
|
|
395
|
+
from: 'from_example', # String |
|
|
396
|
+
to: 'to_example' # String |
|
|
397
|
+
}
|
|
398
|
+
|
|
399
|
+
begin
|
|
400
|
+
#Retrieve A/R Retry Statistics
|
|
401
|
+
result = api_instance.get_accounts_receivable_retry_stats(opts)
|
|
402
|
+
p result
|
|
403
|
+
rescue UltracartClient::ApiError => e
|
|
404
|
+
puts "Exception when calling OrderApi->get_accounts_receivable_retry_stats: #{e}"
|
|
405
|
+
end
|
|
406
|
+
```
|
|
407
|
+
|
|
408
|
+
### Parameters
|
|
409
|
+
|
|
410
|
+
Name | Type | Description | Notes
|
|
411
|
+
------------- | ------------- | ------------- | -------------
|
|
412
|
+
**from** | **String**| | [optional]
|
|
413
|
+
**to** | **String**| | [optional]
|
|
414
|
+
|
|
415
|
+
### Return type
|
|
416
|
+
|
|
417
|
+
[**AccountsReceivableRetryStatsResponse**](AccountsReceivableRetryStatsResponse.md)
|
|
418
|
+
|
|
419
|
+
### Authorization
|
|
420
|
+
|
|
421
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
422
|
+
|
|
423
|
+
### HTTP request headers
|
|
424
|
+
|
|
425
|
+
- **Content-Type**: application/json
|
|
426
|
+
- **Accept**: application/json
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
# **get_order**
|
|
431
|
+
> OrderResponse get_order(order_id, opts)
|
|
432
|
+
|
|
433
|
+
Retrieve an order
|
|
434
|
+
|
|
435
|
+
Retrieves a single order using the specified order id.
|
|
436
|
+
|
|
437
|
+
### Example
|
|
438
|
+
```ruby
|
|
439
|
+
# load the gem
|
|
440
|
+
require 'ultracart_api'
|
|
441
|
+
# setup authorization
|
|
442
|
+
UltracartClient.configure do |config|
|
|
443
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
444
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
445
|
+
|
|
446
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
447
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
448
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
449
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
450
|
+
end
|
|
451
|
+
|
|
452
|
+
api_instance = UltracartClient::OrderApi.new
|
|
453
|
+
|
|
454
|
+
order_id = 'order_id_example' # String | The order id to retrieve.
|
|
455
|
+
|
|
456
|
+
opts = {
|
|
457
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
458
|
+
}
|
|
459
|
+
|
|
460
|
+
begin
|
|
461
|
+
#Retrieve an order
|
|
462
|
+
result = api_instance.get_order(order_id, opts)
|
|
463
|
+
p result
|
|
464
|
+
rescue UltracartClient::ApiError => e
|
|
465
|
+
puts "Exception when calling OrderApi->get_order: #{e}"
|
|
466
|
+
end
|
|
467
|
+
```
|
|
468
|
+
|
|
469
|
+
### Parameters
|
|
470
|
+
|
|
471
|
+
Name | Type | Description | Notes
|
|
472
|
+
------------- | ------------- | ------------- | -------------
|
|
473
|
+
**order_id** | **String**| The order id to retrieve. |
|
|
474
|
+
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
|
475
|
+
|
|
476
|
+
### Return type
|
|
477
|
+
|
|
478
|
+
[**OrderResponse**](OrderResponse.md)
|
|
479
|
+
|
|
480
|
+
### Authorization
|
|
481
|
+
|
|
482
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
483
|
+
|
|
484
|
+
### HTTP request headers
|
|
485
|
+
|
|
486
|
+
- **Content-Type**: application/json
|
|
487
|
+
- **Accept**: application/json
|
|
488
|
+
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
# **get_order_by_token**
|
|
492
|
+
> OrderResponse get_order_by_token(order_by_token_query, opts)
|
|
493
|
+
|
|
494
|
+
Retrieve an order using a token
|
|
495
|
+
|
|
496
|
+
Retrieves a single order using the specified order token.
|
|
497
|
+
|
|
498
|
+
### Example
|
|
499
|
+
```ruby
|
|
500
|
+
# load the gem
|
|
501
|
+
require 'ultracart_api'
|
|
502
|
+
# setup authorization
|
|
503
|
+
UltracartClient.configure do |config|
|
|
504
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
505
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
506
|
+
|
|
507
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
508
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
509
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
510
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
511
|
+
end
|
|
512
|
+
|
|
513
|
+
api_instance = UltracartClient::OrderApi.new
|
|
514
|
+
|
|
515
|
+
order_by_token_query = UltracartClient::OrderByTokenQuery.new # OrderByTokenQuery | Order by token query
|
|
516
|
+
|
|
517
|
+
opts = {
|
|
518
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
519
|
+
}
|
|
520
|
+
|
|
521
|
+
begin
|
|
522
|
+
#Retrieve an order using a token
|
|
523
|
+
result = api_instance.get_order_by_token(order_by_token_query, opts)
|
|
524
|
+
p result
|
|
525
|
+
rescue UltracartClient::ApiError => e
|
|
526
|
+
puts "Exception when calling OrderApi->get_order_by_token: #{e}"
|
|
527
|
+
end
|
|
528
|
+
```
|
|
529
|
+
|
|
530
|
+
### Parameters
|
|
531
|
+
|
|
532
|
+
Name | Type | Description | Notes
|
|
533
|
+
------------- | ------------- | ------------- | -------------
|
|
534
|
+
**order_by_token_query** | [**OrderByTokenQuery**](OrderByTokenQuery.md)| Order by token query |
|
|
535
|
+
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
|
536
|
+
|
|
537
|
+
### Return type
|
|
538
|
+
|
|
539
|
+
[**OrderResponse**](OrderResponse.md)
|
|
540
|
+
|
|
541
|
+
### Authorization
|
|
542
|
+
|
|
543
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
544
|
+
|
|
545
|
+
### HTTP request headers
|
|
546
|
+
|
|
547
|
+
- **Content-Type**: application/json
|
|
548
|
+
- **Accept**: application/json
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
|
|
552
|
+
# **get_orders**
|
|
553
|
+
> OrdersResponse get_orders(opts)
|
|
554
|
+
|
|
555
|
+
Retrieve orders
|
|
556
|
+
|
|
557
|
+
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.
|
|
558
|
+
|
|
559
|
+
### Example
|
|
560
|
+
```ruby
|
|
561
|
+
# load the gem
|
|
562
|
+
require 'ultracart_api'
|
|
563
|
+
# setup authorization
|
|
564
|
+
UltracartClient.configure do |config|
|
|
565
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
566
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
567
|
+
|
|
568
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
569
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
570
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
571
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
572
|
+
end
|
|
573
|
+
|
|
574
|
+
api_instance = UltracartClient::OrderApi.new
|
|
575
|
+
|
|
576
|
+
opts = {
|
|
577
|
+
order_id: 'order_id_example', # String | Order Id
|
|
578
|
+
payment_method: 'payment_method_example', # String | Payment Method
|
|
579
|
+
company: 'company_example', # String | Company
|
|
580
|
+
first_name: 'first_name_example', # String | First Name
|
|
581
|
+
last_name: 'last_name_example', # String | Last Name
|
|
582
|
+
city: 'city_example', # String | City
|
|
583
|
+
state_region: 'state_region_example', # String | State/Region
|
|
584
|
+
postal_code: 'postal_code_example', # String | Postal Code
|
|
585
|
+
country_code: 'country_code_example', # String | Country Code (ISO-3166 two letter)
|
|
586
|
+
phone: 'phone_example', # String | Phone
|
|
587
|
+
email: 'email_example', # String | Email
|
|
588
|
+
cc_email: 'cc_email_example', # String | CC Email
|
|
589
|
+
total: 8.14, # Float | Total
|
|
590
|
+
screen_branding_theme_code: 'screen_branding_theme_code_example', # String | Screen Branding Theme Code
|
|
591
|
+
storefront_host_name: 'storefront_host_name_example', # String | StoreFront Host Name
|
|
592
|
+
creation_date_begin: 'creation_date_begin_example', # String | Creation Date Begin
|
|
593
|
+
creation_date_end: 'creation_date_end_example', # String | Creation Date End
|
|
594
|
+
payment_date_begin: 'payment_date_begin_example', # String | Payment Date Begin
|
|
595
|
+
payment_date_end: 'payment_date_end_example', # String | Payment Date End
|
|
596
|
+
shipment_date_begin: 'shipment_date_begin_example', # String | Shipment Date Begin
|
|
597
|
+
shipment_date_end: 'shipment_date_end_example', # String | Shipment Date End
|
|
598
|
+
rma: 'rma_example', # String | RMA
|
|
599
|
+
purchase_order_number: 'purchase_order_number_example', # String | Purchase Order Number
|
|
600
|
+
item_id: 'item_id_example', # String | Item Id
|
|
601
|
+
current_stage: 'current_stage_example', # String | Current Stage
|
|
602
|
+
channel_partner_code: 'channel_partner_code_example', # String | Channel Partner Code
|
|
603
|
+
channel_partner_order_id: 'channel_partner_order_id_example', # String | Channel Partner Order ID
|
|
604
|
+
customer_profile_oid: 56, # Integer |
|
|
605
|
+
refund_date_begin: 'refund_date_begin_example', # String |
|
|
606
|
+
refund_date_end: 'refund_date_end_example', # String |
|
|
607
|
+
_limit: 100, # Integer | The maximum number of records to return on this one API call. (Maximum 200)
|
|
608
|
+
_offset: 0, # Integer | Pagination of the record set. Offset is a zero based index.
|
|
609
|
+
_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.
|
|
610
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result.
|
|
611
|
+
}
|
|
612
|
+
|
|
613
|
+
begin
|
|
614
|
+
#Retrieve orders
|
|
615
|
+
result = api_instance.get_orders(opts)
|
|
616
|
+
p result
|
|
617
|
+
rescue UltracartClient::ApiError => e
|
|
618
|
+
puts "Exception when calling OrderApi->get_orders: #{e}"
|
|
619
|
+
end
|
|
620
|
+
```
|
|
621
|
+
|
|
622
|
+
### Parameters
|
|
623
|
+
|
|
624
|
+
Name | Type | Description | Notes
|
|
625
|
+
------------- | ------------- | ------------- | -------------
|
|
626
|
+
**order_id** | **String**| Order Id | [optional]
|
|
627
|
+
**payment_method** | **String**| Payment Method | [optional]
|
|
628
|
+
**company** | **String**| Company | [optional]
|
|
629
|
+
**first_name** | **String**| First Name | [optional]
|
|
630
|
+
**last_name** | **String**| Last Name | [optional]
|
|
631
|
+
**city** | **String**| City | [optional]
|
|
632
|
+
**state_region** | **String**| State/Region | [optional]
|
|
633
|
+
**postal_code** | **String**| Postal Code | [optional]
|
|
634
|
+
**country_code** | **String**| Country Code (ISO-3166 two letter) | [optional]
|
|
635
|
+
**phone** | **String**| Phone | [optional]
|
|
636
|
+
**email** | **String**| Email | [optional]
|
|
637
|
+
**cc_email** | **String**| CC Email | [optional]
|
|
638
|
+
**total** | **Float**| Total | [optional]
|
|
639
|
+
**screen_branding_theme_code** | **String**| Screen Branding Theme Code | [optional]
|
|
640
|
+
**storefront_host_name** | **String**| StoreFront Host Name | [optional]
|
|
641
|
+
**creation_date_begin** | **String**| Creation Date Begin | [optional]
|
|
642
|
+
**creation_date_end** | **String**| Creation Date End | [optional]
|
|
643
|
+
**payment_date_begin** | **String**| Payment Date Begin | [optional]
|
|
644
|
+
**payment_date_end** | **String**| Payment Date End | [optional]
|
|
645
|
+
**shipment_date_begin** | **String**| Shipment Date Begin | [optional]
|
|
646
|
+
**shipment_date_end** | **String**| Shipment Date End | [optional]
|
|
647
|
+
**rma** | **String**| RMA | [optional]
|
|
648
|
+
**purchase_order_number** | **String**| Purchase Order Number | [optional]
|
|
649
|
+
**item_id** | **String**| Item Id | [optional]
|
|
650
|
+
**current_stage** | **String**| Current Stage | [optional]
|
|
651
|
+
**channel_partner_code** | **String**| Channel Partner Code | [optional]
|
|
652
|
+
**channel_partner_order_id** | **String**| Channel Partner Order ID | [optional]
|
|
653
|
+
**customer_profile_oid** | **Integer**| | [optional]
|
|
654
|
+
**refund_date_begin** | **String**| | [optional]
|
|
655
|
+
**refund_date_end** | **String**| | [optional]
|
|
656
|
+
**_limit** | **Integer**| The maximum number of records to return on this one API call. (Maximum 200) | [optional] [default to 100]
|
|
657
|
+
**_offset** | **Integer**| Pagination of the record set. Offset is a zero based index. | [optional] [default to 0]
|
|
658
|
+
**_sort** | **String**| The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional]
|
|
659
|
+
**_expand** | **String**| The object expansion to perform on the result. | [optional]
|
|
660
|
+
|
|
661
|
+
### Return type
|
|
662
|
+
|
|
663
|
+
[**OrdersResponse**](OrdersResponse.md)
|
|
664
|
+
|
|
665
|
+
### Authorization
|
|
666
|
+
|
|
667
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
668
|
+
|
|
669
|
+
### HTTP request headers
|
|
670
|
+
|
|
671
|
+
- **Content-Type**: application/json
|
|
672
|
+
- **Accept**: application/json
|
|
673
|
+
|
|
674
|
+
|
|
675
|
+
|
|
676
|
+
# **get_orders_batch**
|
|
677
|
+
> OrdersResponse get_orders_batch(order_batch, opts)
|
|
678
|
+
|
|
679
|
+
Retrieve order batch
|
|
680
|
+
|
|
681
|
+
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.
|
|
682
|
+
|
|
683
|
+
### Example
|
|
684
|
+
```ruby
|
|
685
|
+
# load the gem
|
|
686
|
+
require 'ultracart_api'
|
|
687
|
+
# setup authorization
|
|
688
|
+
UltracartClient.configure do |config|
|
|
689
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
690
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
691
|
+
|
|
692
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
693
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
694
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
695
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
696
|
+
end
|
|
697
|
+
|
|
698
|
+
api_instance = UltracartClient::OrderApi.new
|
|
699
|
+
|
|
700
|
+
order_batch = UltracartClient::OrderQueryBatch.new # OrderQueryBatch | Order batch
|
|
701
|
+
|
|
702
|
+
opts = {
|
|
703
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result.
|
|
704
|
+
}
|
|
705
|
+
|
|
706
|
+
begin
|
|
707
|
+
#Retrieve order batch
|
|
708
|
+
result = api_instance.get_orders_batch(order_batch, opts)
|
|
709
|
+
p result
|
|
710
|
+
rescue UltracartClient::ApiError => e
|
|
711
|
+
puts "Exception when calling OrderApi->get_orders_batch: #{e}"
|
|
712
|
+
end
|
|
713
|
+
```
|
|
714
|
+
|
|
715
|
+
### Parameters
|
|
716
|
+
|
|
717
|
+
Name | Type | Description | Notes
|
|
718
|
+
------------- | ------------- | ------------- | -------------
|
|
719
|
+
**order_batch** | [**OrderQueryBatch**](OrderQueryBatch.md)| Order batch |
|
|
720
|
+
**_expand** | **String**| The object expansion to perform on the result. | [optional]
|
|
721
|
+
|
|
722
|
+
### Return type
|
|
723
|
+
|
|
724
|
+
[**OrdersResponse**](OrdersResponse.md)
|
|
725
|
+
|
|
726
|
+
### Authorization
|
|
727
|
+
|
|
728
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
729
|
+
|
|
730
|
+
### HTTP request headers
|
|
731
|
+
|
|
732
|
+
- **Content-Type**: application/json
|
|
733
|
+
- **Accept**: application/json
|
|
734
|
+
|
|
735
|
+
|
|
736
|
+
|
|
737
|
+
# **get_orders_by_query**
|
|
738
|
+
> OrdersResponse get_orders_by_query(order_query, opts)
|
|
739
|
+
|
|
740
|
+
Retrieve orders
|
|
741
|
+
|
|
742
|
+
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.
|
|
743
|
+
|
|
744
|
+
### Example
|
|
745
|
+
```ruby
|
|
746
|
+
# load the gem
|
|
747
|
+
require 'ultracart_api'
|
|
748
|
+
# setup authorization
|
|
749
|
+
UltracartClient.configure do |config|
|
|
750
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
751
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
752
|
+
|
|
753
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
754
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
755
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
756
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
757
|
+
end
|
|
758
|
+
|
|
759
|
+
api_instance = UltracartClient::OrderApi.new
|
|
760
|
+
|
|
761
|
+
order_query = UltracartClient::OrderQuery.new # OrderQuery | Order query
|
|
762
|
+
|
|
763
|
+
opts = {
|
|
764
|
+
_limit: 100, # Integer | The maximum number of records to return on this one API call. (Maximum 200)
|
|
765
|
+
_offset: 0, # Integer | Pagination of the record set. Offset is a zero based index.
|
|
766
|
+
_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.
|
|
767
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result.
|
|
768
|
+
}
|
|
769
|
+
|
|
770
|
+
begin
|
|
771
|
+
#Retrieve orders
|
|
772
|
+
result = api_instance.get_orders_by_query(order_query, opts)
|
|
773
|
+
p result
|
|
774
|
+
rescue UltracartClient::ApiError => e
|
|
775
|
+
puts "Exception when calling OrderApi->get_orders_by_query: #{e}"
|
|
776
|
+
end
|
|
777
|
+
```
|
|
778
|
+
|
|
779
|
+
### Parameters
|
|
780
|
+
|
|
781
|
+
Name | Type | Description | Notes
|
|
782
|
+
------------- | ------------- | ------------- | -------------
|
|
783
|
+
**order_query** | [**OrderQuery**](OrderQuery.md)| Order query |
|
|
784
|
+
**_limit** | **Integer**| The maximum number of records to return on this one API call. (Maximum 200) | [optional] [default to 100]
|
|
785
|
+
**_offset** | **Integer**| Pagination of the record set. Offset is a zero based index. | [optional] [default to 0]
|
|
786
|
+
**_sort** | **String**| The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional]
|
|
787
|
+
**_expand** | **String**| The object expansion to perform on the result. | [optional]
|
|
788
|
+
|
|
789
|
+
### Return type
|
|
790
|
+
|
|
791
|
+
[**OrdersResponse**](OrdersResponse.md)
|
|
792
|
+
|
|
793
|
+
### Authorization
|
|
794
|
+
|
|
795
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
796
|
+
|
|
797
|
+
### HTTP request headers
|
|
798
|
+
|
|
799
|
+
- **Content-Type**: application/json
|
|
800
|
+
- **Accept**: application/json
|
|
801
|
+
|
|
802
|
+
|
|
803
|
+
|
|
804
|
+
# **insert_order**
|
|
805
|
+
> OrderResponse insert_order(order, opts)
|
|
806
|
+
|
|
807
|
+
Insert an order
|
|
808
|
+
|
|
809
|
+
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.
|
|
810
|
+
|
|
811
|
+
### Example
|
|
812
|
+
```ruby
|
|
813
|
+
# load the gem
|
|
814
|
+
require 'ultracart_api'
|
|
815
|
+
# setup authorization
|
|
816
|
+
UltracartClient.configure do |config|
|
|
817
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
818
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
819
|
+
|
|
820
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
821
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
822
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
823
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
824
|
+
end
|
|
825
|
+
|
|
826
|
+
api_instance = UltracartClient::OrderApi.new
|
|
827
|
+
|
|
828
|
+
order = UltracartClient::Order.new # Order | Order to insert
|
|
829
|
+
|
|
830
|
+
opts = {
|
|
831
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
832
|
+
}
|
|
833
|
+
|
|
834
|
+
begin
|
|
835
|
+
#Insert an order
|
|
836
|
+
result = api_instance.insert_order(order, opts)
|
|
837
|
+
p result
|
|
838
|
+
rescue UltracartClient::ApiError => e
|
|
839
|
+
puts "Exception when calling OrderApi->insert_order: #{e}"
|
|
840
|
+
end
|
|
841
|
+
```
|
|
842
|
+
|
|
843
|
+
### Parameters
|
|
844
|
+
|
|
845
|
+
Name | Type | Description | Notes
|
|
846
|
+
------------- | ------------- | ------------- | -------------
|
|
847
|
+
**order** | [**Order**](Order.md)| Order to insert |
|
|
848
|
+
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
|
849
|
+
|
|
850
|
+
### Return type
|
|
851
|
+
|
|
852
|
+
[**OrderResponse**](OrderResponse.md)
|
|
853
|
+
|
|
854
|
+
### Authorization
|
|
855
|
+
|
|
856
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
857
|
+
|
|
858
|
+
### HTTP request headers
|
|
859
|
+
|
|
860
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
861
|
+
- **Accept**: application/json
|
|
862
|
+
|
|
863
|
+
|
|
864
|
+
|
|
865
|
+
# **process_payment**
|
|
866
|
+
> OrderProcessPaymentResponse process_payment(order_id, process_payment_request)
|
|
867
|
+
|
|
868
|
+
Process payment
|
|
869
|
+
|
|
870
|
+
Process payment on order
|
|
871
|
+
|
|
872
|
+
### Example
|
|
873
|
+
```ruby
|
|
874
|
+
# load the gem
|
|
875
|
+
require 'ultracart_api'
|
|
876
|
+
# setup authorization
|
|
877
|
+
UltracartClient.configure do |config|
|
|
878
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
879
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
880
|
+
|
|
881
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
882
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
883
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
884
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
885
|
+
end
|
|
886
|
+
|
|
887
|
+
api_instance = UltracartClient::OrderApi.new
|
|
888
|
+
|
|
889
|
+
order_id = 'order_id_example' # String | The order id to process payment on
|
|
890
|
+
|
|
891
|
+
process_payment_request = UltracartClient::OrderProcessPaymentRequest.new # OrderProcessPaymentRequest | Process payment parameters
|
|
892
|
+
|
|
893
|
+
|
|
894
|
+
begin
|
|
895
|
+
#Process payment
|
|
896
|
+
result = api_instance.process_payment(order_id, process_payment_request)
|
|
897
|
+
p result
|
|
898
|
+
rescue UltracartClient::ApiError => e
|
|
899
|
+
puts "Exception when calling OrderApi->process_payment: #{e}"
|
|
900
|
+
end
|
|
901
|
+
```
|
|
902
|
+
|
|
903
|
+
### Parameters
|
|
904
|
+
|
|
905
|
+
Name | Type | Description | Notes
|
|
906
|
+
------------- | ------------- | ------------- | -------------
|
|
907
|
+
**order_id** | **String**| The order id to process payment on |
|
|
908
|
+
**process_payment_request** | [**OrderProcessPaymentRequest**](OrderProcessPaymentRequest.md)| Process payment parameters |
|
|
909
|
+
|
|
910
|
+
### Return type
|
|
911
|
+
|
|
912
|
+
[**OrderProcessPaymentResponse**](OrderProcessPaymentResponse.md)
|
|
913
|
+
|
|
914
|
+
### Authorization
|
|
915
|
+
|
|
916
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
917
|
+
|
|
918
|
+
### HTTP request headers
|
|
919
|
+
|
|
920
|
+
- **Content-Type**: application/json
|
|
921
|
+
- **Accept**: application/json
|
|
922
|
+
|
|
923
|
+
|
|
924
|
+
|
|
925
|
+
# **refund_order**
|
|
926
|
+
> OrderResponse refund_order(order, order_id, opts)
|
|
927
|
+
|
|
928
|
+
Refund an order
|
|
929
|
+
|
|
930
|
+
Perform a refund operation on an order and then update the order if successful
|
|
931
|
+
|
|
932
|
+
### Example
|
|
933
|
+
```ruby
|
|
934
|
+
# load the gem
|
|
935
|
+
require 'ultracart_api'
|
|
936
|
+
# setup authorization
|
|
937
|
+
UltracartClient.configure do |config|
|
|
938
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
939
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
940
|
+
|
|
941
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
942
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
943
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
944
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
945
|
+
end
|
|
946
|
+
|
|
947
|
+
api_instance = UltracartClient::OrderApi.new
|
|
948
|
+
|
|
949
|
+
order = UltracartClient::Order.new # Order | Order to refund
|
|
950
|
+
|
|
951
|
+
order_id = 'order_id_example' # String | The order id to refund.
|
|
952
|
+
|
|
953
|
+
opts = {
|
|
954
|
+
reject_after_refund: false, # BOOLEAN | Reject order after refund
|
|
955
|
+
skip_customer_notification: false, # BOOLEAN | Skip customer email notification
|
|
956
|
+
auto_order_cancel: false, # BOOLEAN | Cancel associated auto orders
|
|
957
|
+
manual_refund: false, # BOOLEAN | Consider a manual refund done externally
|
|
958
|
+
reverse_affiliate_transactions: true, # BOOLEAN | Reverse affiliate transactions
|
|
959
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
960
|
+
}
|
|
961
|
+
|
|
962
|
+
begin
|
|
963
|
+
#Refund an order
|
|
964
|
+
result = api_instance.refund_order(order, order_id, opts)
|
|
965
|
+
p result
|
|
966
|
+
rescue UltracartClient::ApiError => e
|
|
967
|
+
puts "Exception when calling OrderApi->refund_order: #{e}"
|
|
968
|
+
end
|
|
969
|
+
```
|
|
970
|
+
|
|
971
|
+
### Parameters
|
|
972
|
+
|
|
973
|
+
Name | Type | Description | Notes
|
|
974
|
+
------------- | ------------- | ------------- | -------------
|
|
975
|
+
**order** | [**Order**](Order.md)| Order to refund |
|
|
976
|
+
**order_id** | **String**| The order id to refund. |
|
|
977
|
+
**reject_after_refund** | **BOOLEAN**| Reject order after refund | [optional] [default to false]
|
|
978
|
+
**skip_customer_notification** | **BOOLEAN**| Skip customer email notification | [optional] [default to false]
|
|
979
|
+
**auto_order_cancel** | **BOOLEAN**| Cancel associated auto orders | [optional] [default to false]
|
|
980
|
+
**manual_refund** | **BOOLEAN**| Consider a manual refund done externally | [optional] [default to false]
|
|
981
|
+
**reverse_affiliate_transactions** | **BOOLEAN**| Reverse affiliate transactions | [optional] [default to true]
|
|
982
|
+
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
|
983
|
+
|
|
984
|
+
### Return type
|
|
985
|
+
|
|
986
|
+
[**OrderResponse**](OrderResponse.md)
|
|
987
|
+
|
|
988
|
+
### Authorization
|
|
989
|
+
|
|
990
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
991
|
+
|
|
992
|
+
### HTTP request headers
|
|
993
|
+
|
|
994
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
995
|
+
- **Accept**: application/json
|
|
996
|
+
|
|
997
|
+
|
|
998
|
+
|
|
999
|
+
# **replacement**
|
|
1000
|
+
> OrderReplacementResponse replacement(order_id, replacement)
|
|
1001
|
+
|
|
1002
|
+
Replacement order
|
|
1003
|
+
|
|
1004
|
+
Create a replacement order based upon a previous order
|
|
1005
|
+
|
|
1006
|
+
### Example
|
|
1007
|
+
```ruby
|
|
1008
|
+
# load the gem
|
|
1009
|
+
require 'ultracart_api'
|
|
1010
|
+
# setup authorization
|
|
1011
|
+
UltracartClient.configure do |config|
|
|
1012
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
1013
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1014
|
+
|
|
1015
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
1016
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
1017
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1018
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
1019
|
+
end
|
|
1020
|
+
|
|
1021
|
+
api_instance = UltracartClient::OrderApi.new
|
|
1022
|
+
|
|
1023
|
+
order_id = 'order_id_example' # String | The order id to generate a replacement for.
|
|
1024
|
+
|
|
1025
|
+
replacement = UltracartClient::OrderReplacement.new # OrderReplacement | Replacement order details
|
|
1026
|
+
|
|
1027
|
+
|
|
1028
|
+
begin
|
|
1029
|
+
#Replacement order
|
|
1030
|
+
result = api_instance.replacement(order_id, replacement)
|
|
1031
|
+
p result
|
|
1032
|
+
rescue UltracartClient::ApiError => e
|
|
1033
|
+
puts "Exception when calling OrderApi->replacement: #{e}"
|
|
1034
|
+
end
|
|
1035
|
+
```
|
|
1036
|
+
|
|
1037
|
+
### Parameters
|
|
1038
|
+
|
|
1039
|
+
Name | Type | Description | Notes
|
|
1040
|
+
------------- | ------------- | ------------- | -------------
|
|
1041
|
+
**order_id** | **String**| The order id to generate a replacement for. |
|
|
1042
|
+
**replacement** | [**OrderReplacement**](OrderReplacement.md)| Replacement order details |
|
|
1043
|
+
|
|
1044
|
+
### Return type
|
|
1045
|
+
|
|
1046
|
+
[**OrderReplacementResponse**](OrderReplacementResponse.md)
|
|
1047
|
+
|
|
1048
|
+
### Authorization
|
|
1049
|
+
|
|
1050
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1051
|
+
|
|
1052
|
+
### HTTP request headers
|
|
1053
|
+
|
|
1054
|
+
- **Content-Type**: application/json
|
|
1055
|
+
- **Accept**: application/json
|
|
1056
|
+
|
|
1057
|
+
|
|
1058
|
+
|
|
1059
|
+
# **resend_receipt**
|
|
1060
|
+
> BaseResponse resend_receipt(order_id)
|
|
1061
|
+
|
|
1062
|
+
Resend receipt
|
|
1063
|
+
|
|
1064
|
+
Resend the receipt for an order on the UltraCart account.
|
|
1065
|
+
|
|
1066
|
+
### Example
|
|
1067
|
+
```ruby
|
|
1068
|
+
# load the gem
|
|
1069
|
+
require 'ultracart_api'
|
|
1070
|
+
# setup authorization
|
|
1071
|
+
UltracartClient.configure do |config|
|
|
1072
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
1073
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1074
|
+
|
|
1075
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
1076
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
1077
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1078
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
1079
|
+
end
|
|
1080
|
+
|
|
1081
|
+
api_instance = UltracartClient::OrderApi.new
|
|
1082
|
+
|
|
1083
|
+
order_id = 'order_id_example' # String | The order id to resend the receipt for.
|
|
1084
|
+
|
|
1085
|
+
|
|
1086
|
+
begin
|
|
1087
|
+
#Resend receipt
|
|
1088
|
+
result = api_instance.resend_receipt(order_id)
|
|
1089
|
+
p result
|
|
1090
|
+
rescue UltracartClient::ApiError => e
|
|
1091
|
+
puts "Exception when calling OrderApi->resend_receipt: #{e}"
|
|
1092
|
+
end
|
|
1093
|
+
```
|
|
1094
|
+
|
|
1095
|
+
### Parameters
|
|
1096
|
+
|
|
1097
|
+
Name | Type | Description | Notes
|
|
1098
|
+
------------- | ------------- | ------------- | -------------
|
|
1099
|
+
**order_id** | **String**| The order id to resend the receipt for. |
|
|
1100
|
+
|
|
1101
|
+
### Return type
|
|
1102
|
+
|
|
1103
|
+
[**BaseResponse**](BaseResponse.md)
|
|
1104
|
+
|
|
1105
|
+
### Authorization
|
|
1106
|
+
|
|
1107
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1108
|
+
|
|
1109
|
+
### HTTP request headers
|
|
1110
|
+
|
|
1111
|
+
- **Content-Type**: application/json
|
|
1112
|
+
- **Accept**: application/json
|
|
1113
|
+
|
|
1114
|
+
|
|
1115
|
+
|
|
1116
|
+
# **resend_shipment_confirmation**
|
|
1117
|
+
> BaseResponse resend_shipment_confirmation(order_id)
|
|
1118
|
+
|
|
1119
|
+
Resend shipment confirmation
|
|
1120
|
+
|
|
1121
|
+
Resend shipment confirmation for an order on the UltraCart account.
|
|
1122
|
+
|
|
1123
|
+
### Example
|
|
1124
|
+
```ruby
|
|
1125
|
+
# load the gem
|
|
1126
|
+
require 'ultracart_api'
|
|
1127
|
+
# setup authorization
|
|
1128
|
+
UltracartClient.configure do |config|
|
|
1129
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
1130
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1131
|
+
|
|
1132
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
1133
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
1134
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1135
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
1136
|
+
end
|
|
1137
|
+
|
|
1138
|
+
api_instance = UltracartClient::OrderApi.new
|
|
1139
|
+
|
|
1140
|
+
order_id = 'order_id_example' # String | The order id to resend the shipment notification for.
|
|
1141
|
+
|
|
1142
|
+
|
|
1143
|
+
begin
|
|
1144
|
+
#Resend shipment confirmation
|
|
1145
|
+
result = api_instance.resend_shipment_confirmation(order_id)
|
|
1146
|
+
p result
|
|
1147
|
+
rescue UltracartClient::ApiError => e
|
|
1148
|
+
puts "Exception when calling OrderApi->resend_shipment_confirmation: #{e}"
|
|
1149
|
+
end
|
|
1150
|
+
```
|
|
1151
|
+
|
|
1152
|
+
### Parameters
|
|
1153
|
+
|
|
1154
|
+
Name | Type | Description | Notes
|
|
1155
|
+
------------- | ------------- | ------------- | -------------
|
|
1156
|
+
**order_id** | **String**| The order id to resend the shipment notification for. |
|
|
1157
|
+
|
|
1158
|
+
### Return type
|
|
1159
|
+
|
|
1160
|
+
[**BaseResponse**](BaseResponse.md)
|
|
1161
|
+
|
|
1162
|
+
### Authorization
|
|
1163
|
+
|
|
1164
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1165
|
+
|
|
1166
|
+
### HTTP request headers
|
|
1167
|
+
|
|
1168
|
+
- **Content-Type**: application/json
|
|
1169
|
+
- **Accept**: application/json
|
|
1170
|
+
|
|
1171
|
+
|
|
1172
|
+
|
|
1173
|
+
# **update_accounts_receivable_retry_config**
|
|
1174
|
+
> BaseResponse update_accounts_receivable_retry_config(retry_config)
|
|
1175
|
+
|
|
1176
|
+
Update A/R Retry Configuration
|
|
1177
|
+
|
|
1178
|
+
Update A/R Retry Configuration. This is primarily an internal API call. It is doubtful you would ever need to use it.
|
|
1179
|
+
|
|
1180
|
+
### Example
|
|
1181
|
+
```ruby
|
|
1182
|
+
# load the gem
|
|
1183
|
+
require 'ultracart_api'
|
|
1184
|
+
# setup authorization
|
|
1185
|
+
UltracartClient.configure do |config|
|
|
1186
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
1187
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1188
|
+
|
|
1189
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
1190
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
1191
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1192
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
1193
|
+
end
|
|
1194
|
+
|
|
1195
|
+
api_instance = UltracartClient::OrderApi.new
|
|
1196
|
+
|
|
1197
|
+
retry_config = UltracartClient::AccountsReceivableRetryConfig.new # AccountsReceivableRetryConfig | AccountsReceivableRetryConfig object
|
|
1198
|
+
|
|
1199
|
+
|
|
1200
|
+
begin
|
|
1201
|
+
#Update A/R Retry Configuration
|
|
1202
|
+
result = api_instance.update_accounts_receivable_retry_config(retry_config)
|
|
1203
|
+
p result
|
|
1204
|
+
rescue UltracartClient::ApiError => e
|
|
1205
|
+
puts "Exception when calling OrderApi->update_accounts_receivable_retry_config: #{e}"
|
|
1206
|
+
end
|
|
1207
|
+
```
|
|
1208
|
+
|
|
1209
|
+
### Parameters
|
|
1210
|
+
|
|
1211
|
+
Name | Type | Description | Notes
|
|
1212
|
+
------------- | ------------- | ------------- | -------------
|
|
1213
|
+
**retry_config** | [**AccountsReceivableRetryConfig**](AccountsReceivableRetryConfig.md)| AccountsReceivableRetryConfig object |
|
|
1214
|
+
|
|
1215
|
+
### Return type
|
|
1216
|
+
|
|
1217
|
+
[**BaseResponse**](BaseResponse.md)
|
|
1218
|
+
|
|
1219
|
+
### Authorization
|
|
1220
|
+
|
|
1221
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1222
|
+
|
|
1223
|
+
### HTTP request headers
|
|
1224
|
+
|
|
1225
|
+
- **Content-Type**: application/json
|
|
1226
|
+
- **Accept**: application/json
|
|
1227
|
+
|
|
1228
|
+
|
|
1229
|
+
|
|
1230
|
+
# **update_order**
|
|
1231
|
+
> OrderResponse update_order(order, order_id, opts)
|
|
1232
|
+
|
|
1233
|
+
Update an order
|
|
1234
|
+
|
|
1235
|
+
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.
|
|
1236
|
+
|
|
1237
|
+
### Example
|
|
1238
|
+
```ruby
|
|
1239
|
+
# load the gem
|
|
1240
|
+
require 'ultracart_api'
|
|
1241
|
+
# setup authorization
|
|
1242
|
+
UltracartClient.configure do |config|
|
|
1243
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
1244
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1245
|
+
|
|
1246
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
1247
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
1248
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1249
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
1250
|
+
end
|
|
1251
|
+
|
|
1252
|
+
api_instance = UltracartClient::OrderApi.new
|
|
1253
|
+
|
|
1254
|
+
order = UltracartClient::Order.new # Order | Order to update
|
|
1255
|
+
|
|
1256
|
+
order_id = 'order_id_example' # String | The order id to update.
|
|
1257
|
+
|
|
1258
|
+
opts = {
|
|
1259
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
1260
|
+
}
|
|
1261
|
+
|
|
1262
|
+
begin
|
|
1263
|
+
#Update an order
|
|
1264
|
+
result = api_instance.update_order(order, order_id, opts)
|
|
1265
|
+
p result
|
|
1266
|
+
rescue UltracartClient::ApiError => e
|
|
1267
|
+
puts "Exception when calling OrderApi->update_order: #{e}"
|
|
1268
|
+
end
|
|
1269
|
+
```
|
|
1270
|
+
|
|
1271
|
+
### Parameters
|
|
1272
|
+
|
|
1273
|
+
Name | Type | Description | Notes
|
|
1274
|
+
------------- | ------------- | ------------- | -------------
|
|
1275
|
+
**order** | [**Order**](Order.md)| Order to update |
|
|
1276
|
+
**order_id** | **String**| The order id to update. |
|
|
1277
|
+
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
|
1278
|
+
|
|
1279
|
+
### Return type
|
|
1280
|
+
|
|
1281
|
+
[**OrderResponse**](OrderResponse.md)
|
|
1282
|
+
|
|
1283
|
+
### Authorization
|
|
1284
|
+
|
|
1285
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1286
|
+
|
|
1287
|
+
### HTTP request headers
|
|
1288
|
+
|
|
1289
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
1290
|
+
- **Accept**: application/json
|
|
1291
|
+
|
|
1292
|
+
|
|
1293
|
+
|