Skip to main content

API Call Adjustments for Accounts that Transition To SalesDoc

InkSoft Support Team
Updated

For accounts that were using the previous version of InkSoft and then transitioned into our SalesDoc environment, some API call changes will be necessary if you are currently using these calls.

The information below gives a breakdown of these changes:

1. Changed the Id and ItemGuid for OrderShipmentPackageItem
            A. Changed Id to Guid
            B. Changed OrderRetailItemSizeId to ItemGuid

2. Any structure that had a RetailItemId, CartRetailItemId, OrderRetailItemId, RetailItemSizeId, CartRetailItemSizeId, or OrderRetailItemSizeId has been changed. These properties have been removed and we recommend you use the UniqueId field instead.

3. Integer “SessionId” parameter is no longer accepted in many API calls.  The Globally Unique ID (UUID) “SessionToken” parameter should be used instead.  The signatures for these endpoints have been updated to expect a UUID “SessionToken” parameter in place of the former SessionId (or in a few cases, the endpoint is altogether removed):

 

Endpoint

Change Description

{storeUri}/Api2/GetCart

Endpoint is eliminated

{storeUri}/Api2/GetCartCheckoutFieldValues

 Endpoint is eliminated

{storeUri}/Api2/SetCartCheckoutFieldValues

 Endpoint is eliminated

{storeUri}/Api2/GetCartPackage

SessionId parameter has been removed

{storeUri}/Api2/GetShippingMethods

SessionId parameter has been removed

{storeUri}/Api2/SaveArt

SessionId parameter has been removed

{storeUri}/Api2/SaveCartOrder

SessionId parameter has been removed

{storeUri}/Api2/SetCart

SessionId parameter has been removed

{storeUri}/Api2/UploadArt

SessionId parameter has been removed

{storeUri}/Api2/CreateMobileUploadRequest

Endpoint is eliminated

{storeUri}/Api2/SendArtEmail

Endpoint is eliminated

{storeUri}/Api2/SendDesignEmail

SessionId parameter has been removed

GetCart/{StoreID}/{SessionToken}/{CartRetailItemID}/{ReadyToOrder}/{IncludeAddOns}

SessionId parameter has been removed

SendDesignEmail/{StoreID}/{SessionToken}/{UserID}/{DesignID}

SessionId parameter has been removed

GetCart/{StoreID}/{SessionToken}/{CartRetailItemID}/{ReadyToOrder}/{IncludeAddOns}

Endpoint is eliminated

SendDesignEmail/{StoreID}/{SessionToken}/{UserID}/{DesignID}

Endpoint is eliminated

 

GetCartPackage Changes

  • The following ShoppingCart level fields are no longer populated:

    • CartItemWeight

    • CartRequestId

    • DefaultCountryId

    • DiscountTax

    • NameNumberSettings

    • ProcessMarkup

    • QuantityDiscountTax

    • QuantityPricingPercentDiscount

  • The no longer populated fields for GetOrderPackage Order.CustomLineItems, Order.Items, and Order.Items.Addons also apply here

GetOrderPackage Changes

  • IncludeProposals API option removed and associated proposals are not returned

  • The following Order level fields are no longer populated:

    • ApprovalDate

    • ApprovalRequired

    • Authorized

    • ContactEmailAddresses

    • Confirmed

    • ConfirmedShipDate

    • CurrencyCode

    • CurrencySymbol

    • DiscountId (this is now a hash-code of the corresponding SalesDoc pre-tax total discount adjustment for convenience)

    • DiscountTax

    • DisplayPricing

    • DueDate

    • GiftCertificates

    • NameNumberSettings

    • Ordered

    • Paid

    • PaymentRequestSentDate

    • Prepared

    • ProcessAmount

    • ProductionCards

    • ProductStyleSizeInventoryStatuses

    • ProductStyleSizePrices

    • ProposalId

    • PurchaseOrderAttachmentUrl

    • QuantityDiscountPercent

    • ReadyForPickupNotificationSentDate

    • Received

    • RetailDiscount

    • Shipped

    • ShortCodes

    • TaxName

    • Timeline

  • TotalAdjustments.ID is now a hash-code of the corresponding SalesDoc total adjustment Guid

  • The following Order.CustomLineItems level fields are no longer populated:

    • Active

    • CustomLineItemImages

    • ID (this is now a hash-code of the corresponding SalesDocItem Guid for convenience)

    • ImageUrl

    • Size

    • Style

  • The following Order.Items level fields are no longer populated:

    • NameNumberValues

    • PrintCostOverride

    • PrintOverridePriceBack

    • PrintOverridePriceFront

    • PrintOverrideSleeveLeft

    • PrintOverrideSleeveRight

    • PrintPriceBack

    • PrintPriceFront

    • PrintPriceSleeveLeft

    • PrintPriceSleeveRight

    • PrintSetupOverrideBack

    • PrintSetupOverrideFront

    • PrintSetupOverrideSleeveLeft

    • PrintSetupOverrideSleeveRight

    • PrintSetupPriceBack

    • PrintSetupPriceFront

    • PrintSetupPriceSleeveLeft

    • PrintSetupPriceSleeveRight

    • RetailItemId

    • RetailItemSizeId

    • SideColorways

  • The following Order.Items.Addons level fields are no longer populated:

    • Name

    • Quantity

  • The following Order.Payments level fields are no longer populated:

    • AvsCode

    • GatewayAccount

    • DateVoided

    • ID

    • InkSoftFee

    • ProcessingFee

    • ProposalId

    • TestMode

  • The following Order.PurchasedGiftCertificate level fields are no longer populated:

    • AppliedAmount

    • InitialPurchaseAmount

    • Created

    • DateSent

    • HasOrders

    • Number

    • ToEmail

    • ToName

GetOrderSummaries Changes

  • The following OrderSummary level fields are no longer populated:

    • Authorized

    • Canceled

    • Confirmed

    • Ordered

    • Paid

    • PaymentDueDate

    • Prepared

    • ProcessAmount

    • ProposalId

    • ReadyForPickupNotificationSentDate

    • Received

    • Shipped

    • ShippingVendorId


You can read more about our API here! If you have any questions, please let us know!

Related articles

Comments

0 comments

Article is closed for comments.