--- title: Return Cart by Consumer slug: api-documentation/return-cart-by-consumer docTags: createdAt: 2026-08-27T16:53:32.339Z --- { "id": "LdRerN6NAEcfisY9EeYBS", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.upstartcommerce.com/v1/cart/{customerId}/cart/{cartId}", "servers": [ { "url": "https://api.upstartcommerce.com/v1/cart/{customerId}/cart/{cartId}" } ], "name": "Return Cart by Consumer", "description": "This endpoint returns a specific cart for a specific consumer.", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "customerId", "type": "string", "description": "Unique identifier representing the \"owner\" of the cart." }, { "kind": "required", "name": "cartId", "type": "string", "description": "Unique identifier for this cart." } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" }, { "kind": "required", "name": "x-upstart-tenant", "type": "string", "description": "Tenant identifier associated with the site this call is for." } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "NoChannelPortalAccess", "name": "NoChannelPortalAccess", "kind": "optional", "type": "http", "description": "

This authentication is required for clients to interact with any of the management APIs. Similar to 'LoggedIn', it indicates that the user has actually logged into the system, but in this case with a management role.

", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "

Success-the requested cart was returned.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "The general structure of a cart.", "customType": "Cart", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for this cart.", "example": "5B3B51DF-5AE2-4ED0-A1BE-3332B48745F2", "format": "uuid" }, { "name": "siteIds", "kind": "optional", "type": "array", "description": "A set of identifiers for the sites that this location is available on.", "modelRef": "#/components/schemas/SiteId", "customType": "SiteId[]", "schema": [] }, { "name": "customerId", "kind": "required", "type": "string", "description": "The id for the consumer who owns this cart.", "example": "BA5030A9-AE17-45E3-8CA7-713BB832523C", "format": "uuid" }, { "name": "anonymous", "kind": "required", "type": "boolean", "description": "Flags whether the cart belongs to an anonymous user.", "example": false }, { "name": "state", "kind": "required", "type": "string", "description": "These are the valid states for a given cart.", "example": "Paid", "enum": [ "New", "Submitted", "Paid" ] }, { "name": "currency", "kind": "required", "type": "string", "description": "

Currency being used in this cart (applying the 3-character ISO code).

", "example": "USD" }, { "name": "distanceUnit", "kind": "required", "type": "string", "description": "

The units that the distance for delivery/shipping are measured in.

", "enum": [ "mi", "km" ] }, { "name": "items", "kind": "required", "type": "array", "description": "Item that the consumer has added to their cart.", "modelRef": "#/components/schemas/CartItem", "customType": "CartItem[]", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "", "format": "uuid" }, { "name": "catalogItemId", "kind": "required", "type": "string", "description": "" }, { "name": "productItemSkuId", "kind": "required", "type": "string", "description": "" }, { "name": "catalogItemType", "kind": "required", "type": "string", "description": "", "modelRef": "#/components/schemas/catalogItemType", "customType": "catalogItemType", "schema": [] }, { "name": "quantity", "kind": "required", "type": "integer", "description": "", "format": "int32" }, { "name": "pricing", "kind": "required", "type": "object", "description": "Object providing pricing data for the cart.", "modelRef": "#/components/schemas/CartItemPricing", "customType": "CartItemPricing", "schema": [ { "name": "basePrice", "kind": "optional", "type": "object", "description": "Object describing price.", "modelRef": "#/components/schemas/BasePrice", "customType": "BasePrice", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "" }, { "name": "zone", "kind": "required", "type": "string", "description": "" }, { "name": "price", "kind": "required", "type": "number", "description": "", "example": 1599.99 }, { "name": "listPrice", "kind": "required", "type": "number", "description": "", "example": 1999.99 } ] }, { "name": "promotionPriceAdjustments", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/PromotionPriceAdjustment", "customType": "PromotionPriceAdjustment[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "The unique id for this promotional price adjustment.", "example": "E9A22EA5-253E-4764-8238-48AAEFE2E1D3", "format": "uuid" }, { "name": "value", "kind": "required", "type": "number", "description": "The value that this promotional adjustment applies to the cart. It will always be a negative number.", "maximum": 0, "exclusiveMaximum": true }, { "name": "name", "kind": "optional", "type": "string", "description": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "This will contain any relevant details about the adjustment.", "example": "Buy 1 flubber get 10 free" }, { "name": "taxPriceAdjustment", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/TaxPriceAdjustment", "customType": "TaxPriceAdjustment", "schema": [ { "name": "taxCode", "kind": "required", "type": "string", "description": "" }, { "name": "value", "kind": "optional", "type": "number", "description": "" } ] } ] }, { "name": "feePriceAdjustments", "kind": "optional", "type": "array", "description": "

Any additional fees, e.g. mattress-recycling fee.

", "modelRef": "#/components/schemas/FeePriceAdjustment", "customType": "FeePriceAdjustment[]", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "quantity", "kind": "required", "type": "integer", "description": "", "format": "int32" }, { "name": "baseValue", "kind": "required", "type": "number", "description": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "" }, { "name": "value", "kind": "required", "type": "number", "description": "" }, { "name": "taxable", "kind": "optional", "type": "boolean", "description": "", "default": true } ] }, { "name": "taxPriceAdjustment", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/TaxPriceAdjustment", "customType": "TaxPriceAdjustment", "schema": [ { "name": "taxCode", "kind": "required", "type": "string", "description": "" }, { "name": "value", "kind": "optional", "type": "number", "description": "" } ] } ] }, { "name": "catalogItem", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/CatalogItemSummary", "customType": "CatalogItemSummary", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "" }, { "name": "siteIds", "kind": "required", "type": "array", "description": "This should be a list of ids indicating the allowed sites. Each id must reference a valid site.", "modelRef": "#/components/schemas/SiteId", "customType": "SiteId[]", "schema": [] }, { "name": "typeId", "kind": "required", "type": "string", "description": "Unique identifier for the catalog item type. This must be an id of an existing catalog item type.", "example": "FA1F5DC8-E4FB-415F-BDD8-8E6F0AD43318", "format": "uuid" }, { "name": "type", "kind": "required", "type": "string", "description": "", "modelRef": "#/components/schemas/catalogItemType", "customType": "catalogItemType", "schema": [] }, { "name": "typeName", "kind": "required", "type": "string", "description": "

A readable form of the \"type\" of this product (e.g., \"chair\" or \"phone\").

", "example": "Speaker" }, { "name": "name", "kind": "required", "type": "string", "description": "

Consumer-facing name for the catalog item.

", "example": "Green Flubber" }, { "name": "brandName", "kind": "optional", "type": "string", "description": "

The brand name (if applicable).

", "example": "Bob's Best Toy Line" }, { "name": "manufacturerName", "kind": "optional", "type": "string", "description": "The manufacturer's name.", "example": "Bob's chemical company." }, { "name": "media", "kind": "optional", "type": "map", "description": "A list of media associated with this catalog entity.", "example": "", "customType": "map", "schema": [] }, { "name": "tags", "kind": "optional", "type": "array", "description": "

A list of tags to support searching, categorization, and filtering.

", "example": "[\"Men's\",\"Shirts\",\"Blue\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "dynamicProperties", "kind": "required", "type": "object", "description": "

A pre-configured JSON structure including the data that is unique to this particular product type.

", "example": "", "schema": [] }, { "name": "productItems", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/SkuItemSummary", "customType": "SkuItemSummary[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "ProductItemSummary", "description": "", "modelRef": "#/components/schemas/ProductItemSummary", "schema": [ { "name": "skuId", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/SkuItemId", "customType": "SkuItemId", "schema": [] }, { "name": "name", "kind": "optional", "type": "string", "description": "Name for the product item." }, { "name": "brandName", "kind": "optional", "type": "string", "description": "" }, { "name": "manufacturerName", "kind": "optional", "type": "string", "description": "" }, { "name": "media", "kind": "optional", "type": "map", "description": "", "example": "", "customType": "map", "schema": [] }, { "name": "tags", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "dynamicProperties", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "shippingMethodIds", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "ignoreInventory", "kind": "optional", "type": "boolean", "description": "" }, { "name": "dimensions", "kind": "optional", "type": "object", "deprecated": true, "description": "Warning: Deprecated\n

Please use skuDimensions instead.

", "modelRef": "#/components/schemas/Dimensions", "customType": "Dimensions", "schema": [ { "name": "width", "kind": "required", "type": "number", "description": "", "example": 18.5, "format": "double" }, { "name": "length", "kind": "required", "type": "number", "description": "", "example": 18.5, "format": "double" }, { "name": "height", "kind": "required", "type": "number", "description": "", "example": 18.5, "format": "double" }, { "name": "unit", "kind": "required", "type": "string", "description": "", "enum": [ "cm", "m", "in", "mm" ] } ] }, { "name": "weight", "kind": "optional", "type": "object", "description": "Defines a common structure for representing weights.", "modelRef": "#/components/schemas/Weight", "customType": "Weight", "schema": [ { "name": "value", "kind": "required", "type": "number", "description": "", "format": "double", "minimum": 0 }, { "name": "unit", "kind": "required", "type": "string", "description": "Unit of measurement.", "enum": [ "g", "kg", "lb" ] } ] }, { "name": "numPieces", "kind": "optional", "type": "integer", "description": "", "minimum": 0, "exclusiveMinimum": true }, { "name": "shippingPackages", "kind": "required", "type": "array", "description": "This represents a shipping package.", "modelRef": "#/components/schemas/ShippingPackage", "customType": "ShippingPackage[]", "schema": [ { "name": "packageCode", "kind": "optional", "type": "string", "description": "This represents a package code.", "example": "PackageCode" }, { "name": "weight", "kind": "required", "type": "object", "description": "Defines a common structure for representing weights.", "modelRef": "#/components/schemas/Weight", "customType": "Weight", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "dimensions", "kind": "optional", "type": "object", "description": "This is a common definition of a dimension.", "modelRef": "#/components/schemas/Dimensions", "customType": "Dimensions", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "insuredValue", "kind": "optional", "type": "number", "description": "This represents the value of an insurance.", "example": 100 } ] }, { "name": "purchasable", "kind": "required", "type": "boolean", "description": "", "default": true }, { "name": "pricing", "kind": "optional", "type": "object", "description": "Pricing details of the item", "modelRef": "#/components/schemas/Pricing", "customType": "Pricing", "schema": [ { "name": "price", "kind": "required", "type": "number", "description": "The price of the item" }, { "name": "currency", "kind": "required", "type": "string", "description": "", "example": "USD", "pattern": "^[A-Z]{3}$" } ] }, { "name": "disabled", "kind": "optional", "type": "boolean", "description": "", "default": false }, { "name": "upc", "kind": "optional", "type": "string", "description": "" }, { "name": "feeMultiplier", "kind": "optional", "type": "integer", "description": "" }, { "name": "skuDimensions", "kind": "required", "type": "array", "description": "This is a common definition of a SKU's dimension.", "modelRef": "#/components/schemas/DimensionsInfo", "customType": "DimensionsInfo[]", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "" }, { "name": "width", "kind": "required", "type": "number", "description": "", "example": 18.5, "format": "double" }, { "name": "length", "kind": "required", "type": "number", "description": "", "example": 18.5, "format": "double" }, { "name": "height", "kind": "required", "type": "number", "description": "", "example": 18.5, "format": "double" }, { "name": "unit", "kind": "required", "type": "string", "description": "", "enum": [ "cm", "m", "in", "mm" ] } ] }, { "name": "type", "kind": "optional", "type": "string", "description": "", "enum": [ "product" ] } ] }, { "name": "ProtectionPlanItemSummary", "description": "", "modelRef": "#/components/schemas/ProtectionPlanItemSummary", "schema": [ { "name": "skuId", "kind": "required", "type": "string", "description": "" }, { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "description", "kind": "required", "type": "string", "description": "" }, { "name": "termsAndConditions", "kind": "required", "type": "object", "discriminator": { "propertyName": "type", "mapping": { "DrupalTermsAndConditions": "#/components/schemas/DrupalTermsAndConditions", "UrlTermsAndConditions": "#/components/schemas/UrlTermsAndConditions", "CloudinaryAsset": "#/components/schemas/CloudinaryAsset" } }, "description": "Base trait for terms and conditions", "modelRef": "#/components/schemas/TermsAndConditions", "customType": "TermsAndConditions", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "DrupalTermsAndConditions", "description": "", "modelRef": "#/components/schemas/DrupalTermsAndConditions", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "UrlTermsAndConditions", "description": "", "modelRef": "#/components/schemas/UrlTermsAndConditions", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "CloudinaryAsset", "description": "", "modelRef": "#/components/schemas/CloudinaryAsset", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "dynamicProperties", "kind": "optional", "type": "object", "description": "Optional dynamic properties for the protection plan item.", "example": "", "schema": [] }, { "name": "pricing", "kind": "optional", "type": "object", "description": "Optional pricing information for the protection plan item.", "modelRef": "#/components/schemas/Pricing", "customType": "Pricing", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "purchasable", "kind": "required", "type": "boolean", "description": "", "default": true }, { "name": "disabled", "kind": "required", "type": "boolean", "description": "", "default": false }, { "name": "type", "kind": "optional", "type": "string", "description": "", "enum": [ "protectionPlan" ] } ] }, { "name": "ServiceItemSummary", "description": "", "modelRef": "#/components/schemas/ServiceItemSummary", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "WarrantyItemSummary", "description": "", "modelRef": "#/components/schemas/WarrantyItemSummary", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "offeredWarrantyId", "kind": "optional", "type": "string", "description": "" }, { "name": "offeredProtectionPlanType", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/OfferedProtectionPlanType", "customType": "OfferedProtectionPlanType", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "DmOfferedProtectionPlanType", "description": "", "modelRef": "#/components/schemas/DmOfferedProtectionPlanType", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "", "enum": [ "DmOfferedProtectionPlanType" ] } ] }, { "name": "StandardOfferedProtectionPlanType", "description": "", "modelRef": "#/components/schemas/StandardOfferedProtectionPlanType", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "", "enum": [ "StandardOfferedProtectionPlanType" ] }, { "name": "id", "kind": "required", "type": "string", "description": "" } ] } ] }, { "name": "offeredStandardWarranty", "kind": "optional", "type": "object", "discriminator": { "propertyName": "type", "mapping": { "DrupalTermsAndConditions": "#/components/schemas/DrupalTermsAndConditions", "UrlTermsAndConditions": "#/components/schemas/UrlTermsAndConditions", "CloudinaryAsset": "#/components/schemas/CloudinaryAsset" } }, "description": "Base trait for terms and conditions", "modelRef": "#/components/schemas/TermsAndConditions", "customType": "TermsAndConditions", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "DrupalTermsAndConditions", "description": "", "modelRef": "#/components/schemas/DrupalTermsAndConditions", "schema": [ { "name": "resource", "kind": "required", "type": "object", "discriminator": { "propertyName": "type", "mapping": { "NidDrupalResource": "#/components/schemas/NidDrupalResource", "ResolvedDrupalResource": "#/components/schemas/ResolvedDrupalResource" } }, "description": "Base trait for a Drupal resource", "modelRef": "#/components/schemas/DrupalResource", "customType": "DrupalResource", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "NidDrupalResource", "description": "", "modelRef": "#/components/schemas/NidDrupalResource", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "ResolvedDrupalResource", "description": "", "modelRef": "#/components/schemas/ResolvedDrupalResource", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "type", "kind": "optional", "type": "string", "description": "", "enum": [ "DrupalTermsAndConditions" ] } ] }, { "name": "UrlTermsAndConditions", "description": "", "modelRef": "#/components/schemas/UrlTermsAndConditions", "schema": [ { "name": "url", "kind": "required", "type": "string", "description": "URL of the terms and conditions" }, { "name": "version", "kind": "optional", "type": "integer", "description": "Optional version of the terms", "format": "int32" }, { "name": "validSince", "kind": "optional", "type": "string", "description": "Optional date since when the terms are valid", "format": "date-time" }, { "name": "type", "kind": "optional", "type": "string", "description": "", "enum": [ "UrlTermsAndConditions" ] } ] }, { "name": "CloudinaryAsset", "description": "", "modelRef": "#/components/schemas/CloudinaryAsset", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "serviceQualification", "kind": "optional", "type": "object", "description": "Represents the eligibility criteria for a service.", "modelRef": "#/components/schemas/ServiceQualification", "customType": "ServiceQualification", "schema": [ { "name": "eligibleProductIds", "kind": "optional", "type": "array", "description": "A list of product IDs eligible for the service.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "eligibleShippingMethodIds", "kind": "optional", "type": "array", "description": "A list of shipping method IDs eligible for the service.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "excludesClearanceItems", "kind": "optional", "type": "boolean", "description": "Indicates if clearance items are excluded." }, { "name": "relatedIds", "kind": "required", "type": "array", "description": "This provides a way of hardwiring related products. The array should contain a set of ids for products that are related items.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "shippingMethodIds", "kind": "required", "type": "array", "description": "This should be a list of ids indicating the allowed shipping methods. Each id must reference a valid shipping method.", "example": "[\"6A883710-0E0A-47ED-8DFE-7CCDBAC8F2C0\",\"B7E96644-DBCB-4608-B882-010DDCF9E70F\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "activationDate", "kind": "optional", "type": "string", "description": "

The date/time before which this product is not available (if not provided, the item is available immediately).

", "format": "date-time" }, { "name": "deactivationDate", "kind": "optional", "type": "string", "description": "

The date/time after which this product is unavailable (if not provided, the item remains available).

", "format": "date-time" }, { "name": "taxCode", "kind": "optional", "type": "string", "description": "

The tax code under which this product falls (will vary based on tax provider).

", "example": "P0000000" }, { "name": "ignoreInventory", "kind": "required", "type": "boolean", "description": "

The ignore-inventory flag for the product SKU item.

", "default": false }, { "name": "hidden", "kind": "required", "type": "boolean", "description": "

A boolean flag to indicate that this item should not appear in search results and should not be available to add-to-cart/checkout.

", "default": false }, { "name": "avgRating", "kind": "optional", "type": "number", "description": "The average consumer rating for this product.", "example": 4.62, "format": "double" }, { "name": "numReviews", "kind": "optional", "type": "integer", "description": "The total number of reviews that have been submitted for this product.", "example": 17, "format": "int32" }, { "name": "avgGroupRating", "kind": "optional", "type": "number", "description": "The average rating for group reviews.", "format": "double" }, { "name": "numGroupReviews", "kind": "optional", "type": "integer", "description": "The total number of group reviews that have been submitted.", "format": "int32" }, { "name": "version", "kind": "required", "type": "integer", "description": "

For internal use - determines the version of this catalog item.

", "example": 5, "default": 0, "format": "int32" }, { "name": "subVersion", "kind": "optional", "type": "integer", "description": "

Indicates a sub-version of this catalog item.

", "format": "int32" }, { "name": "seo", "kind": "optional", "type": "object", "description": "

Represents SEO-related metadata for a catalog item.

", "modelRef": "#/components/schemas/Seo", "customType": "Seo", "schema": [ { "name": "pageTitle", "kind": "optional", "type": "string", "description": "The title of the page for SEO purposes." }, { "name": "description", "kind": "optional", "type": "string", "description": "A description of the catalog item for SEO purposes." }, { "name": "metaKeywords", "kind": "required", "type": "array", "description": "A list of keywords associated with the catalog item for SEO optimization.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "liveDate", "kind": "optional", "type": "string", "description": "

The date/time this catalog entity was made active.

", "format": "date-time" }, { "name": "modifiedDate", "kind": "optional", "type": "string", "description": "

The date/time this catalog entity was last updated.

", "format": "date-time" }, { "name": "archived", "kind": "optional", "type": "boolean", "description": "

A boolean flag to indicate that this item is no longer available, is excluded from live catalog and will not appear in search results.

", "default": false }, { "name": "productPopularity", "kind": "optional", "type": "number", "description": "An optional field to indicate product popularity.", "format": "double" } ] }, { "name": "shipmentId", "kind": "optional", "type": "string", "description": "", "format": "uuid" }, { "name": "promotionId", "kind": "optional", "type": "string", "description": "" }, { "name": "targetItemIds", "kind": "optional", "type": "array", "description": "

Target items are cart item ids / references to products from warranties and protection plans. Products are not allowed to have targetItems, warranty must reference only one product and protection plan must reference one or more products.

", "example": "", "default": [], "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "targetShipmentIds", "kind": "optional", "type": "array", "description": "

Target shipments are references from shipping-only-associated services. It can refer to one or more shipments. Other types of services, products, protection plans, nor warranties are not allowed to have targetShipmentIds.

", "example": "", "default": [], "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "invalid", "kind": "required", "type": "boolean", "description": "

This flag determines if any cart items are invalid. When true the invalid item/s need to be removed prior to further processing.

", "default": false }, { "name": "errors", "kind": "required", "type": "array", "description": "

This array contains current cart processing/validation errors.

", "modelRef": "#/components/schemas/ErrorMessage", "customType": "ErrorMessage[]", "schema": [ { "name": "level", "kind": "required", "type": "string", "description": "", "enum": [ "INFO", "WARN", "ERROR" ] }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "message", "kind": "optional", "type": "string", "description": "" }, { "name": "detail", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "quoteId", "kind": "optional", "type": "integer", "description": "ID of the quote if the item is coming from a quote", "format": "int64" }, { "name": "availableQuantity", "kind": "optional", "type": "integer", "description": "", "format": "int32" }, { "name": "isLeaseable", "kind": "optional", "type": "boolean", "description": "Flags whether the item is leaseable in case of Koalafi.", "example": false }, { "name": "category", "kind": "optional", "type": "string", "description": "", "enum": [ "product", "service" ] } ] }, { "name": "locationId", "kind": "optional", "type": "string", "description": "Unique identifier for the location that this cart is associated with.", "example": "loc_456" }, { "name": "postalCode", "kind": "optional", "type": "string", "description": "The postal code that this cart is associated with.", "example": "03101" }, { "name": "stateOrRegion", "kind": "optional", "type": "string", "description": "

Similar to the postal code property, this is the state or region that the cart is associated with.

", "example": "WA" }, { "name": "country", "kind": "optional", "type": "string", "description": "

A 2-character country code for the provided postal code.

", "example": "US", "minLength": 2, "maxLength": 2 }, { "name": "haulAwayRequested", "kind": "optional", "type": "integer", "description": "", "format": "int32" }, { "name": "haulAwayAllowed", "kind": "optional", "type": "integer", "description": "", "format": "int32" }, { "name": "coupons", "kind": "required", "type": "array", "description": "Object describing status of coupon.", "modelRef": "#/components/schemas/CartCoupon", "customType": "CartCoupon[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "The id for the coupon." }, { "name": "applied", "kind": "required", "type": "boolean", "description": "Flag indicating whether this coupon was applied.", "default": false }, { "name": "applyStatus", "kind": "optional", "type": "string", "description": "Text indicating the status of the coupon." }, { "name": "promotionId", "kind": "optional", "type": "string", "description": "The id of the promotion that this coupon was applied for." } ] }, { "name": "returnPolicyQualifications", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/CartReturnPolicyQualification", "customType": "CartReturnPolicyQualification[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "", "format": "uuid" }, { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "groupQualifications", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/CartReturnPolicyGroupQualification", "customType": "CartReturnPolicyGroupQualification[]", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "A name of the return policy group this qualification is of." }, { "name": "triggeringItemIds", "kind": "required", "type": "array", "description": "Cart item IDs that are triggering the return policy in question.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "qualifyingItemIds", "kind": "required", "type": "array", "description": "Cart item IDs that are make you qualify for the return policy in question.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "qualifyingSubjects", "kind": "required", "type": "object", "description": "

All product and/or SKU IDs that make you qualify for the return policy in question.

", "modelRef": "#/components/schemas/ReturnPolicySubject", "customType": "ReturnPolicySubject[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "ReturnPolicyProduct", "description": "", "modelRef": "#/components/schemas/ReturnPolicyProduct", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "" }, { "name": "id", "kind": "required", "type": "string", "description": "A product ID of the product." } ] }, { "name": "ReturnPolicySku", "description": "", "modelRef": "#/components/schemas/ReturnPolicySku", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "" }, { "name": "id", "kind": "required", "type": "string", "description": "A product ID of the product this SKU belongs to." }, { "name": "skuId", "kind": "required", "type": "string", "description": "An ID of this SKU." } ] } ] }, { "name": "qualificationResult", "kind": "required", "type": "object", "description": "The result of qualifying a cart for a return policy.", "modelRef": "#/components/schemas/CartReturnPolicyQualificationResult", "customType": "CartReturnPolicyQualificationResult", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "Qualified", "description": "", "modelRef": "#/components/schemas/Qualified", "schema": [ { "name": "triggeredMessage", "kind": "required", "type": "string", "description": "A notification message informing that a return policy has been triggered." }, { "name": "type", "kind": "required", "type": "string", "description": "", "default": "Qualified" } ] }, { "name": "NotQualified", "description": "", "modelRef": "#/components/schemas/NotQualified", "schema": [ { "name": "triggeredMessage", "kind": "required", "type": "string", "description": "A notification message informing that a return policy has been triggered." }, { "name": "unqualifiedMessage", "kind": "required", "type": "string", "description": "A notification message informing that a return policy has been triggered but not qualified for." }, { "name": "type", "kind": "required", "type": "string", "description": "", "default": "NotQualified" } ] } ] } ] } ] }, { "name": "shippingCoordinates", "kind": "optional", "type": "object", "description": "

Latitude/longitude-based coordinates.

", "modelRef": "#/components/schemas/Coordinates", "customType": "Coordinates", "schema": [ { "name": "latitude", "kind": "required", "type": "number", "description": "", "format": "double", "minimum": -90, "maximum": 90 }, { "name": "longitude", "kind": "required", "type": "number", "description": "", "format": "double", "minimum": -180, "maximum": 180 } ] }, { "name": "shippingAddress", "kind": "optional", "type": "object", "description": "Standardized format for global addresses.", "modelRef": "#/components/schemas/Address", "customType": "Address", "schema": [ { "name": "street1", "kind": "required", "type": "string", "description": "" }, { "name": "street2", "kind": "optional", "type": "string", "description": "" }, { "name": "city", "kind": "required", "type": "string", "description": "" }, { "name": "county", "kind": "optional", "type": "string", "description": "" }, { "name": "stateOrRegion", "kind": "required", "type": "string", "description": "" }, { "name": "country", "kind": "required", "type": "string", "description": "Defaults to US.", "minLength": 2, "maxLength": 2 }, { "name": "postalCode", "kind": "required", "type": "string", "description": "" }, { "name": "poBox", "kind": "optional", "type": "boolean", "description": "", "default": false }, { "name": "name", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Name", "customType": "Name", "schema": [ { "name": "first", "kind": "required", "type": "string", "description": "The first name of the individual being addressed.", "example": "John" }, { "name": "last", "kind": "required", "type": "string", "description": "The last name of the individual being addressed.", "example": "Smith" }, { "name": "middleInitial", "kind": "optional", "type": "string", "description": "The middle initial of the individual being addressed.", "example": "D." }, { "name": "salutation", "kind": "optional", "type": "string", "description": "The salutation of the individual being addressed.", "example": "Capt." }, { "name": "suffix", "kind": "optional", "type": "string", "description": "The optional suffix of the individual being addressed.", "example": "Sr." } ] }, { "name": "businessName", "kind": "optional", "type": "string", "description": "" }, { "name": "phoneNumber", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "billingAddress", "kind": "optional", "type": "object", "description": "Standardized format for global addresses.", "modelRef": "#/components/schemas/Address", "customType": "Address", "schema": [ { "name": "street1", "kind": "required", "type": "string", "description": "" }, { "name": "street2", "kind": "optional", "type": "string", "description": "" }, { "name": "city", "kind": "required", "type": "string", "description": "" }, { "name": "county", "kind": "optional", "type": "string", "description": "" }, { "name": "stateOrRegion", "kind": "required", "type": "string", "description": "" }, { "name": "country", "kind": "required", "type": "string", "description": "Defaults to US.", "minLength": 2, "maxLength": 2 }, { "name": "postalCode", "kind": "required", "type": "string", "description": "" }, { "name": "poBox", "kind": "optional", "type": "boolean", "description": "", "default": false }, { "name": "name", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Name", "customType": "Name", "schema": [ { "name": "first", "kind": "required", "type": "string", "description": "The first name of the individual being addressed.", "example": "John" }, { "name": "last", "kind": "required", "type": "string", "description": "The last name of the individual being addressed.", "example": "Smith" }, { "name": "middleInitial", "kind": "optional", "type": "string", "description": "The middle initial of the individual being addressed.", "example": "D." }, { "name": "salutation", "kind": "optional", "type": "string", "description": "The salutation of the individual being addressed.", "example": "Capt." }, { "name": "suffix", "kind": "optional", "type": "string", "description": "The optional suffix of the individual being addressed.", "example": "Sr." } ] }, { "name": "businessName", "kind": "optional", "type": "string", "description": "" }, { "name": "phoneNumber", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "shipments", "kind": "required", "type": "array", "description": "This represents how the cart items are bundled for shipping purposes and contains the associated method by which bundles are being shipped.", "modelRef": "#/components/schemas/CartShipment", "customType": "CartShipment[]", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "Unique identifier for the shipment.", "example": "A9CA1B7E-7BDE-4285-937E-B81A38DEAEEC", "format": "uuid" }, { "name": "shippingMethodId", "kind": "required", "type": "string", "description": "Unique identifier for the shipping method used to generate this rate set.", "example": "537ED6DF-9DE2-47DE-8C0C-A47022B6F940", "format": "uuid" }, { "name": "shippingMethodName", "kind": "optional", "type": "string", "description": "

This is the user-facing name of the shipping method indicated by the shipping method id.

", "example": "FedEx" }, { "name": "inStorePickup", "kind": "optional", "type": "boolean", "description": "This flag determines if cart shipment is invalid." }, { "name": "trackingNumber", "kind": "optional", "type": "string", "description": "

Tracking number; available once shipping labels have been generated for this shipment.

", "example": "TZ54235423NSF42334" }, { "name": "addressFrom", "kind": "optional", "type": "object", "description": "Standardized format for global addresses.", "modelRef": "#/components/schemas/Address", "customType": "Address", "schema": [ { "name": "street1", "kind": "required", "type": "string", "description": "" }, { "name": "street2", "kind": "optional", "type": "string", "description": "" }, { "name": "city", "kind": "required", "type": "string", "description": "" }, { "name": "county", "kind": "optional", "type": "string", "description": "" }, { "name": "stateOrRegion", "kind": "required", "type": "string", "description": "" }, { "name": "country", "kind": "required", "type": "string", "description": "Defaults to US.", "minLength": 2, "maxLength": 2 }, { "name": "postalCode", "kind": "required", "type": "string", "description": "" }, { "name": "poBox", "kind": "optional", "type": "boolean", "description": "", "default": false }, { "name": "name", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Name", "customType": "Name", "schema": [ { "name": "first", "kind": "required", "type": "string", "description": "The first name of the individual being addressed.", "example": "John" }, { "name": "last", "kind": "required", "type": "string", "description": "The last name of the individual being addressed.", "example": "Smith" }, { "name": "middleInitial", "kind": "optional", "type": "string", "description": "The middle initial of the individual being addressed.", "example": "D." }, { "name": "salutation", "kind": "optional", "type": "string", "description": "The salutation of the individual being addressed.", "example": "Capt." }, { "name": "suffix", "kind": "optional", "type": "string", "description": "The optional suffix of the individual being addressed.", "example": "Sr." } ] }, { "name": "businessName", "kind": "optional", "type": "string", "description": "" }, { "name": "phoneNumber", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "locationFromId", "kind": "optional", "type": "string", "description": "

This indicates the source location of the shipment (typically a warehouse).

", "example": "wrhse-23425" }, { "name": "addressTo", "kind": "optional", "type": "object", "description": "Standardized format for global addresses.", "modelRef": "#/components/schemas/Address", "customType": "Address", "schema": [ { "name": "street1", "kind": "required", "type": "string", "description": "" }, { "name": "street2", "kind": "optional", "type": "string", "description": "" }, { "name": "city", "kind": "required", "type": "string", "description": "" }, { "name": "county", "kind": "optional", "type": "string", "description": "" }, { "name": "stateOrRegion", "kind": "required", "type": "string", "description": "" }, { "name": "country", "kind": "required", "type": "string", "description": "Defaults to US.", "minLength": 2, "maxLength": 2 }, { "name": "postalCode", "kind": "required", "type": "string", "description": "" }, { "name": "poBox", "kind": "optional", "type": "boolean", "description": "", "default": false }, { "name": "name", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Name", "customType": "Name", "schema": [ { "name": "first", "kind": "required", "type": "string", "description": "The first name of the individual being addressed.", "example": "John" }, { "name": "last", "kind": "required", "type": "string", "description": "The last name of the individual being addressed.", "example": "Smith" }, { "name": "middleInitial", "kind": "optional", "type": "string", "description": "The middle initial of the individual being addressed.", "example": "D." }, { "name": "salutation", "kind": "optional", "type": "string", "description": "The salutation of the individual being addressed.", "example": "Capt." }, { "name": "suffix", "kind": "optional", "type": "string", "description": "The optional suffix of the individual being addressed.", "example": "Sr." } ] }, { "name": "businessName", "kind": "optional", "type": "string", "description": "" }, { "name": "phoneNumber", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "locationToId", "kind": "optional", "type": "string", "description": "The id of the location from which items are being picked up in a store or pickup location.", "example": "store-14678" }, { "name": "shippingToDistance", "kind": "optional", "type": "object", "description": "This defines a generic distance.", "modelRef": "#/components/schemas/Distance", "customType": "Distance", "schema": [ { "name": "value", "kind": "required", "type": "number", "description": "The numeric portion of the distance.", "example": 157.75, "format": "double" }, { "name": "unit", "kind": "required", "type": "string", "description": "An enumeration of the supported distance measurements.", "modelRef": "#/components/schemas/DistanceUnits", "customType": "DistanceUnits", "schema": [] } ] }, { "name": "rateServiceCode", "kind": "optional", "type": "string", "description": "This is the code identifying the type of service being applied to the shipment.", "example": "fedex_overnight" }, { "name": "rateVariants", "kind": "required", "type": "array", "description": "This contains the set of available shipping options based on the selected shipping method.", "modelRef": "#/components/schemas/ShippingRate", "customType": "ShippingRate[]", "schema": [ { "name": "rateId", "kind": "required", "type": "string", "description": "

The vendor-provided id for this specific shipping quote.

", "example": "ups-abcdef" }, { "name": "carrierId", "kind": "required", "type": "string", "description": "Unique identifier for the carrier the rate applies to.", "example": "se-12345" }, { "name": "pricing", "kind": "required", "type": "object", "description": "This represents the pricing for this rate variation.", "example": "", "schema": [ { "name": "shipping", "kind": "required", "type": "number", "description": "The actual cost of shipping for this package with this rate variation." }, { "name": "insurance", "kind": "optional", "type": "number", "description": "Any fee based on the consumer's request for additional insurance.", "minimum": 0, "exclusiveMinimum": true }, { "name": "confirmation", "kind": "optional", "type": "number", "description": "Any fee based on the consumer's request for signature confirmation.", "minimum": 0, "exclusiveMinimum": true }, { "name": "other", "kind": "optional", "type": "number", "description": "This is any miscellaneous fee imposed by the carrier.", "minimum": 0, "exclusiveMinimum": true }, { "name": "fee", "kind": "optional", "type": "number", "description": "Any fee based on the consumer's request for signature confirmation.", "minimum": 0, "exclusiveMinimum": true } ] }, { "name": "packageType", "kind": "optional", "type": "string", "description": "This is one a a set of predefined package types available from a given carrier.", "example": "fixed_rate_priority_envelope" }, { "name": "deliveryDays", "kind": "optional", "type": "integer", "description": "

The number of days that the carrier estimates it will take to deliver, based on the rate option.

", "example": 4, "format": "int32" }, { "name": "estimatedDeliveryDate", "kind": "optional", "type": "string", "description": "The estimated delivery date.", "example": "2019-09-23T00:00:00Z", "format": "date-time" }, { "name": "carrierDeliveryDates", "kind": "required", "type": "string", "description": "

This is a carrier-provided indication of when the package will be delivered.

", "example": "2 business days" }, { "name": "shipDate", "kind": "optional", "type": "string", "description": "The anticipated date for shipping. This will provide data for calculations such as the estimated delivery date.", "format": "date-time" }, { "name": "serviceType", "kind": "required", "type": "string", "description": "

This is a read-only reference from the shipping platform.

", "example": "$5587Z76" }, { "name": "serviceCode", "kind": "required", "type": "string", "description": "

The vendor-provided code for the type of service requested.

", "example": "next-day" }, { "name": "carrierCode", "kind": "required", "type": "string", "description": "This is this identifier for rate as defined by the carrier.", "example": "fixed_rate_priority" } ] }, { "name": "packages", "kind": "required", "type": "array", "description": "This contains a list of all of the packages associated with this particular shipment.", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "packageCode", "kind": "optional", "type": "string", "description": "

This is a shipping-vendor specific code for the type of package being used.

", "example": "flat_rate_padded_envelope" }, { "name": "weight", "kind": "required", "type": "object", "description": "Defines a common structure for representing weights.", "modelRef": "#/components/schemas/Weight", "customType": "Weight", "schema": [ { "name": "value", "kind": "required", "type": "number", "description": "", "format": "double", "minimum": 0 }, { "name": "unit", "kind": "required", "type": "string", "description": "Unit of measurement.", "enum": [ "g", "kg", "lb" ] } ] }, { "name": "dimensions", "kind": "optional", "type": "object", "description": "This is a common definition of a dimension.", "modelRef": "#/components/schemas/Dimensions", "customType": "Dimensions", "schema": [ { "name": "width", "kind": "required", "type": "number", "description": "", "example": 18.5, "format": "double" }, { "name": "length", "kind": "required", "type": "number", "description": "", "example": 18.5, "format": "double" }, { "name": "height", "kind": "required", "type": "number", "description": "", "example": 18.5, "format": "double" }, { "name": "unit", "kind": "required", "type": "string", "description": "", "enum": [ "cm", "m", "in", "mm" ] } ] }, { "name": "insuredValue", "kind": "optional", "type": "number", "description": "

This is the (optional) value that the package is insured for.

", "minimum": 0 } ] }, { "name": "pricing", "kind": "required", "type": "object", "description": "A breakdown of costs associated with the shipping.", "example": "", "schema": [ { "name": "basePrice", "kind": "optional", "type": "number", "description": "The cost of this shipment prior to discounts and taxes.", "example": 199.99 }, { "name": "promotionPriceAdjustments", "kind": "optional", "type": "array", "description": "This represents any promotional discounts associated with this shipment.", "modelRef": "#/components/schemas/PromotionPriceAdjustment", "customType": "PromotionPriceAdjustment[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "The unique id for this promotional price adjustment.", "example": "E9A22EA5-253E-4764-8238-48AAEFE2E1D3", "format": "uuid" }, { "name": "value", "kind": "required", "type": "number", "description": "The value that this promotional adjustment applies to the cart. It will always be a negative number.", "maximum": 0, "exclusiveMaximum": true }, { "name": "name", "kind": "optional", "type": "string", "description": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "This will contain any relevant details about the adjustment.", "example": "Buy 1 flubber get 10 free" }, { "name": "taxPriceAdjustment", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/TaxPriceAdjustment", "customType": "TaxPriceAdjustment", "schema": [ { "name": "taxCode", "kind": "required", "type": "string", "description": "" }, { "name": "value", "kind": "optional", "type": "number", "description": "" } ] } ] }, { "name": "taxPriceAdjustment", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/TaxPriceAdjustment", "customType": "TaxPriceAdjustment", "schema": [ { "name": "taxCode", "kind": "required", "type": "string", "description": "" }, { "name": "value", "kind": "optional", "type": "number", "description": "" } ] } ] }, { "name": "invalid", "kind": "optional", "type": "boolean", "description": "This flag determines if cart shipment is invalid." }, { "name": "metadata", "kind": "optional", "type": "object", "description": "Metadata about the shipment calculation that are specific per calculator.", "example": "", "schema": [] }, { "name": "errors", "kind": "optional", "type": "array", "description": "

This array contains current shipments processing/validation errors.

", "modelRef": "#/components/schemas/ErrorMessage", "customType": "ErrorMessage[]", "schema": [ { "name": "level", "kind": "required", "type": "string", "description": "", "enum": [ "INFO", "WARN", "ERROR" ] }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "message", "kind": "optional", "type": "string", "description": "" }, { "name": "detail", "kind": "optional", "type": "string", "description": "" } ] } ] }, { "name": "pricing", "kind": "required", "type": "object", "description": "This describes the cart's pricing details.", "modelRef": "#/components/schemas/CartPricing", "customType": "CartPricing", "schema": [ { "name": "promotionPriceAdjustments", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/CartPromotionPriceAdjustment", "customType": "CartPromotionPriceAdjustment[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "The unique id for this promotional price adjustment." }, { "name": "value", "kind": "required", "type": "number", "description": "The value that this promotional adjustment applies to the cart. It will always be a negative number." }, { "name": "name", "kind": "optional", "type": "string", "description": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "This will contain any relevant details about the adjustment.", "example": "Buy 1 flubber get 10 free" }, { "name": "itemIds", "kind": "required", "type": "array", "description": "The IDs of the cart items the cart level promotion is based on", "example": "[\"E9A22EA5-253E-4764-8238-48AAEFE2E1D3\"]", "itemType": "string", "customType": "string[]", "itemExample": "E9A22EA5-253E-4764-8238-48AAEFE2E1D3", "itemDefault": "" }, { "name": "taxPriceAdjustment", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/TaxPriceAdjustment", "customType": "TaxPriceAdjustment", "schema": [ { "name": "taxCode", "kind": "required", "type": "string", "description": "" }, { "name": "value", "kind": "optional", "type": "number", "description": "" } ] } ] }, { "name": "totalItemsPrice", "kind": "optional", "type": "number", "description": "The sum of the price of all cart items after applying discounts.", "example": 1799.99, "minimum": 0 }, { "name": "totalItemsBasePrice", "kind": "optional", "type": "number", "description": "The sum of the price of all cart items prior to any discounting.", "example": 1999.99, "minimum": 0 }, { "name": "totalWarrantyItemsPrice", "kind": "optional", "type": "number", "description": "The sum of the price of all warranty items with discount.", "example": 1999.99, "minimum": 0 }, { "name": "totalWarrantyItemsBasePrice", "kind": "optional", "type": "number", "description": "The sum of the price of all warranty items prior to any discounting.", "example": 1999.99, "minimum": 0 }, { "name": "totalShippingPrice", "kind": "optional", "type": "number", "description": "The sum total of all shipping charges after applying promotions.", "example": 150, "minimum": 0 }, { "name": "totalShippingBasePrice", "kind": "optional", "type": "number", "description": "The sum total of all shipping charges prior to applying promotions.", "example": 150, "minimum": 0 }, { "name": "totalFee", "kind": "optional", "type": "number", "description": "The sum of all of the additional fees.", "example": 29.54 }, { "name": "totalTax", "kind": "optional", "type": "number", "description": "The sum total of all taxes tied to this cart..", "example": 29.23, "minimum": 0 }, { "name": "totalShippingPromotion", "kind": "optional", "type": "number", "description": "The sum total of all promotions on shipping. This will always be a negative number or zero." }, { "name": "totalCartPromotion", "kind": "optional", "type": "number", "description": "

The sum total of all cart-level promotions from cart-level promotionPriceAdjustments. This will always be a negative number or zero.

" }, { "name": "totalItemCartPromotion", "kind": "optional", "type": "number", "description": "

The sum of all of the cart-level promotions. This will always be a negative number or zero.

" }, { "name": "totalPromotion", "kind": "optional", "type": "number", "description": "

The sum total of all promotions (both cart-level and item-level). This will always be a negative number or zero.

" }, { "name": "totalPrice", "kind": "optional", "type": "number", "description": "The sum total of the shopping cart including taxes.", "example": 2012.48, "minimum": 0 }, { "name": "totalPreTaxPrice", "kind": "optional", "type": "number", "description": "The sum total of the shopping cart prior to applying taxes.", "example": 1829.53, "minimum": 0 } ] }, { "name": "payments", "kind": "required", "type": "array", "description": "This represents the list of payments to be applied to the order.", "modelRef": "#/components/schemas/CartPayment", "customType": "CartPayment[]", "schema": [ { "name": "exec", "kind": "required", "type": "object", "discriminator": { "propertyName": "type" }, "description": "", "complexType": "oneOf", "complexItems": [ { "name": "CyberSourcePaymentExec", "description": "", "modelRef": "#/components/schemas/CyberSourcePaymentExec", "schema": [ { "name": "cardHolderName", "kind": "required", "type": "string", "description": "Full name of the card holder.", "example": "Johnny B Goode" }, { "name": "cardNumber", "kind": "required", "type": "string", "description": "The last four digits of the card number.", "minLength": 4, "maxLength": 4, "pattern": "^[0-9]{4}$" }, { "name": "cardType", "kind": "required", "type": "string", "description": "The type of credit card.", "example": "001" }, { "name": "expirationMonth", "kind": "required", "type": "string", "description": "" }, { "name": "expirationYear", "kind": "required", "type": "string", "description": "", "example": "2042", "minLength": 4, "maxLength": 4, "pattern": "^2[0-9]{3}$" }, { "name": "processingLogs", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/PaymentExecProcessingLog", "customType": "PaymentExecProcessingLog", "schema": [ { "name": "date", "kind": "required", "type": "string", "description": "", "format": "date-time" }, { "name": "errors", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" }, { "name": "state", "kind": "required", "type": "string", "description": "The current state of the payment transaction.", "default": "New", "modelRef": "#/components/schemas/PaymentStates", "customType": "PaymentStates", "schema": [] }, { "name": "transactionId", "kind": "optional", "type": "string", "description": "" }, { "name": "value", "kind": "optional", "type": "number", "description": "" } ] }, { "name": "requestId", "kind": "required", "type": "string", "description": "This is the id that CycberSource generated when the authorization on the card indicated was tokenized." }, { "name": "token", "kind": "required", "type": "string", "description": "This is a tokenized representation of the card that the consumer is purchasing with." } ] }, { "name": "GoogleCSPaymentExec", "description": "", "modelRef": "#/components/schemas/GoogleCSPaymentExec", "schema": [ { "name": "cardHolderName", "kind": "required", "type": "string", "description": "Full name of the card holder.", "example": "Johnny B Goode" }, { "name": "cardNumber", "kind": "required", "type": "string", "description": "The last four digits of the card number.", "minLength": 4, "maxLength": 4, "pattern": "^[0-9]{4}$" }, { "name": "cardType", "kind": "required", "type": "string", "description": "The type of credit card.", "example": "001" }, { "name": "expirationMonth", "kind": "required", "type": "string", "description": "" }, { "name": "expirationYear", "kind": "required", "type": "string", "description": "", "example": "2042", "minLength": 4, "maxLength": 4, "pattern": "^2[0-9]{3}$" }, { "name": "processingLogs", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/PaymentExecProcessingLog", "customType": "PaymentExecProcessingLog", "schema": [ { "name": "date", "kind": "required", "type": "string", "description": "", "format": "date-time" }, { "name": "errors", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" }, { "name": "state", "kind": "required", "type": "string", "description": "The current state of the payment transaction.", "default": "New", "modelRef": "#/components/schemas/PaymentStates", "customType": "PaymentStates", "schema": [] }, { "name": "transactionId", "kind": "optional", "type": "string", "description": "" }, { "name": "value", "kind": "optional", "type": "number", "description": "" } ] }, { "name": "requestId", "kind": "required", "type": "string", "description": "This is the id that CycberSource generated when the authorization on the card indicated was tokenized." }, { "name": "token", "kind": "required", "type": "string", "description": "This is a tokenized representation of the card that the consumer is purchasing with." } ] }, { "name": "AppleCSPaymentExec", "description": "", "modelRef": "#/components/schemas/AppleCSPaymentExec", "schema": [ { "name": "cardHolderName", "kind": "required", "type": "string", "description": "Full name of the card holder.", "example": "Johnny B Goode" }, { "name": "cardNumber", "kind": "required", "type": "string", "description": "The last four digits of the card number.", "minLength": 4, "maxLength": 4, "pattern": "^[0-9]{4}$" }, { "name": "cardType", "kind": "required", "type": "string", "description": "The type of credit card.", "example": "001" }, { "name": "expirationMonth", "kind": "required", "type": "string", "description": "" }, { "name": "expirationYear", "kind": "required", "type": "string", "description": "", "example": "2042", "minLength": 4, "maxLength": 4, "pattern": "^2[0-9]{3}$" }, { "name": "processingLogs", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/PaymentExecProcessingLog", "customType": "PaymentExecProcessingLog", "schema": [ { "name": "date", "kind": "required", "type": "string", "description": "", "format": "date-time" }, { "name": "errors", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" }, { "name": "state", "kind": "required", "type": "string", "description": "The current state of the payment transaction.", "default": "New", "modelRef": "#/components/schemas/PaymentStates", "customType": "PaymentStates", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "transactionId", "kind": "optional", "type": "string", "description": "" }, { "name": "value", "kind": "optional", "type": "number", "description": "" } ] }, { "name": "requestId", "kind": "required", "type": "string", "description": "This is the id that CycberSource generated when the authorization on the card indicated was tokenized." }, { "name": "token", "kind": "required", "type": "string", "description": "This is a tokenized representation of the card that the consumer is purchasing with." } ] }, { "name": "FortivaPaymentExec", "description": "", "modelRef": "#/components/schemas/FortivaPaymentExec", "schema": [ { "name": "accountId", "kind": "required", "type": "string", "description": "" }, { "name": "accountNumber", "kind": "required", "type": "string", "description": "" }, { "name": "authorizationCode", "kind": "required", "type": "string", "description": "" }, { "name": "promoLegalText", "kind": "required", "type": "string", "description": "" }, { "name": "processingLogs", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/PaymentExecProcessingLog", "customType": "PaymentExecProcessingLog", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "SynchronyPaymentExec", "description": "", "modelRef": "#/components/schemas/SynchronyPaymentExec", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "PayPalPaymentExec", "description": "", "modelRef": "#/components/schemas/PayPalPaymentExec", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "KoalafiPaymentExec", "description": "", "modelRef": "#/components/schemas/KoalafiPaymentExec", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "schema": [] }, { "name": "id", "kind": "optional", "type": "string", "description": "Unique identifier for this payment." }, { "name": "state", "kind": "required", "type": "string", "description": "The current state of the payment transaction.", "default": "New", "modelRef": "#/components/schemas/PaymentStates", "customType": "PaymentStates", "schema": [] }, { "name": "transactionId", "kind": "optional", "type": "string", "description": "

Unique identifier for the transaction; provided by the vendor.

", "example": "469512" }, { "name": "value", "kind": "optional", "type": "number", "description": "The order total to be applied to this payment.", "example": 1500 } ] }, { "name": "tax", "kind": "required", "type": "object", "description": "Object providing payment option data.", "modelRef": "#/components/schemas/CartTax", "customType": "CartTax", "schema": [ { "name": "transactionCode", "kind": "optional", "type": "string", "description": "Unique identifier for this payment." }, { "name": "processedDate", "kind": "optional", "type": "string", "description": "", "example": "2021-12-01T00:00:00Z", "format": "date-time" }, { "name": "entityUseCode", "kind": "optional", "type": "string", "description": "Unique identifier for this payment." }, { "name": "state", "kind": "required", "type": "string", "description": "

The 2-digit month portion of the date on which the card expires.

", "default": "New", "enum": [ "New", "Initiated", "Processed", "Canceled", "Refunded", "ProcessFailed", "ProcessDisabled" ] } ] }, { "name": "email", "kind": "optional", "type": "string", "description": "Email address the consumer provided for this cart.", "example": "example@example.com", "format": "email" }, { "name": "errors", "kind": "required", "type": "array", "description": "This is present if the there are any unresolved processing errors in the cart the need to be handled prior to final checkout.", "modelRef": "#/components/schemas/CartErrorMessage", "customType": "CartErrorMessage[]", "schema": [ { "name": "transactionId", "kind": "required", "type": "string", "description": "Unique transaction id representing the cart update. It can be used to track errors and issues in internal log files. It is primarily here for support.", "format": "uuid" }, { "name": "level", "kind": "required", "type": "string", "description": "This represents the severity of the issue.", "enum": [ "INFO", "WARN", "ERROR" ] }, { "name": "code", "kind": "required", "type": "string", "description": "

Can contain codes like

\n
    \n
  • promo
    • \n
  • invalid-item
    • \n
  • shipping-method-rates
    • \n
  • shipping-method-labels
    • \n
  • tax-call-fail
    • \n
  • shipping-call-fail
    • \n
  • fee-call-fail
    • \n
  • payments-invalid
    • \n
  • payment-failed
    • \n
  • shipping
    • \n
  • promo-call-fail
    • \n
  • pricing-call-fail
    • \n
  • pricing-item-undefined
    • \n
  • tax-address-undefined
    • \n
  • tax-item-undefined
    • \n
  • etc.
    • \n
" }, { "name": "message", "kind": "optional", "type": "string", "description": "Basic error message." }, { "name": "detail", "kind": "optional", "type": "string", "description": "This is a message specific to this error. It is not intended for display to the user." } ] }, { "name": "timezoneId", "kind": "optional", "type": "string", "description": "

Timezone id (tz database). If not specified - tenant's default timezone is used.

", "example": "America/Denver" }, { "name": "modifiedDate", "kind": "optional", "type": "string", "description": "

Cart's last modification date. The date is adjusted to be in the cart's timezone (timezoneId) or in tenant's default timezone if not specified explicitly.

", "example": "2021-06-04T05:55:27.067Z", "format": "date-time" }, { "name": "publicDealerId", "kind": "optional", "type": "string", "description": "

Unique identifier for the public dealer (PDI) from Koalafi.

", "example": "your-pdi" } ], "modelRef": "#/components/schemas/Cart", "isExpanded": true } ] }, { "statusCode": "401", "description": "The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "404", "description": "The requested resource was not found in the NoChannel system.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "sd4wmqvKuCBeTbtrCcZ4A", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.upstartcommerce.com/v1/cart/{customerId}/cart/{cartId} \\\n --header 'accept: application/json' \\\n --header 'x-upstart-tenant: string'" }, { "id": "NtjL8_z8JSE2DzBrf4_R0", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-upstart-tenant\", \"string\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.upstartcommerce.com/v1/cart/{customerId}/cart/{cartId}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "JwXbMstDISDpwF6LcfV12", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/v1/cart/{customerId}/cart/{cartId}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-upstart-tenant\"] = \"string\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "f_UlNGxn6urT6yezyhYPI", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/v1/cart/{customerId}/cart/{cartId}\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-upstart-tenant': 'string'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "sd4wmqvKuCBeTbtrCcZ4A" }, "results": { "languages": [ { "id": "Nk6qOjHN3RXvC4v1aAwQo", "language": "200", "code": "// Success-the requested cart was returned.\n{\n \"id\": \"5B3B51DF-5AE2-4ED0-A1BE-3332B48745F2\",\n \"siteIds\": [\n \"\"\n ],\n \"customerId\": \"BA5030A9-AE17-45E3-8CA7-713BB832523C\",\n \"anonymous\": false,\n \"state\": \"Paid\",\n \"currency\": \"USD\",\n \"distanceUnit\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"catalogItemId\": \"\",\n \"productItemSkuId\": \"\",\n \"catalogItemType\": \"\",\n \"quantity\": \"\",\n \"pricing\": {\n \"basePrice\": {\n \"type\": \"\",\n \"zone\": \"\",\n \"price\": 1599.99,\n \"listPrice\": 1999.99\n },\n \"promotionPriceAdjustments\": [\n {\n \"id\": \"E9A22EA5-253E-4764-8238-48AAEFE2E1D3\",\n \"value\": 0,\n \"name\": \"\",\n \"description\": \"Buy 1 flubber get 10 free\",\n \"taxPriceAdjustment\": {\n \"taxCode\": \"\",\n \"value\": 0\n }\n }\n ],\n \"feePriceAdjustments\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"baseValue\": 0,\n \"description\": \"\",\n \"value\": 0,\n \"taxable\": false\n }\n ],\n \"taxPriceAdjustment\": {\n \"taxCode\": \"\",\n \"value\": 0\n }\n },\n \"catalogItem\": {\n \"id\": \"\",\n \"siteIds\": [\n \"\"\n ],\n \"typeId\": \"FA1F5DC8-E4FB-415F-BDD8-8E6F0AD43318\",\n \"type\": \"\",\n \"typeName\": \"Speaker\",\n \"name\": \"Green Flubber\",\n \"brandName\": \"Bob's Best Toy Line\",\n \"manufacturerName\": \"Bob's chemical company.\",\n \"media\": \"\",\n \"tags\": [\n \"\"\n ],\n \"dynamicProperties\": {},\n \"productItems\": {},\n \"offeredWarrantyId\": \"\",\n \"offeredProtectionPlanType\": {},\n \"offeredStandardWarranty\": {},\n \"serviceQualification\": {\n \"eligibleProductIds\": [\n \"\"\n ],\n \"eligibleShippingMethodIds\": [\n \"\"\n ]\n },\n \"excludesClearanceItems\": false,\n \"relatedIds\": [\n \"\"\n ],\n \"shippingMethodIds\": [\n \"\"\n ],\n \"activationDate\": \"\",\n \"deactivationDate\": \"\",\n \"taxCode\": \"P0000000\",\n \"ignoreInventory\": false,\n \"hidden\": false,\n \"avgRating\": 4.62,\n \"numReviews\": 17,\n \"avgGroupRating\": \"\",\n \"numGroupReviews\": \"\",\n \"version\": 5,\n \"subVersion\": \"\",\n \"seo\": {\n \"pageTitle\": \"\",\n \"description\": \"\",\n \"metaKeywords\": [\n \"\"\n ]\n },\n \"liveDate\": \"\",\n \"modifiedDate\": \"\",\n \"archived\": false,\n \"productPopularity\": \"\"\n },\n \"shipmentId\": \"\",\n \"promotionId\": \"\",\n \"targetItemIds\": [\n \"\"\n ],\n \"targetShipmentIds\": [\n \"\"\n ],\n \"invalid\": false,\n \"errors\": [\n {\n \"level\": \"\",\n \"code\": \"\",\n \"message\": \"\",\n \"detail\": \"\"\n }\n ],\n \"quoteId\": \"\",\n \"availableQuantity\": \"\",\n \"isLeaseable\": false,\n \"category\": \"\"\n }\n ],\n \"locationId\": \"loc_456\",\n \"postalCode\": \"03101\",\n \"stateOrRegion\": \"WA\",\n \"country\": \"US\",\n \"haulAwayRequested\": \"\",\n \"haulAwayAllowed\": \"\",\n \"coupons\": [\n {\n \"id\": \"\",\n \"applied\": false,\n \"applyStatus\": \"\",\n \"promotionId\": \"\"\n }\n ],\n \"returnPolicyQualifications\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"groupQualifications\": [\n {\n \"name\": \"\",\n \"triggeringItemIds\": [\n \"\"\n ],\n \"qualifyingItemIds\": [\n \"\"\n ],\n \"qualifyingSubjects\": {},\n \"qualificationResult\": {}\n }\n ]\n }\n ],\n \"shippingCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"shippingAddress\": {\n \"street1\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"stateOrRegion\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"poBox\": false,\n \"name\": {\n \"first\": \"John\",\n \"last\": \"Smith\",\n \"middleInitial\": \"D.\",\n \"salutation\": \"Capt.\",\n \"suffix\": \"Sr.\"\n },\n \"businessName\": \"\",\n \"phoneNumber\": \"\"\n },\n \"billingAddress\": {\n \"street1\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"stateOrRegion\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"poBox\": false,\n \"name\": {\n \"first\": \"John\",\n \"last\": \"Smith\",\n \"middleInitial\": \"D.\",\n \"salutation\": \"Capt.\",\n \"suffix\": \"Sr.\"\n },\n \"businessName\": \"\",\n \"phoneNumber\": \"\"\n },\n \"shipments\": [\n {\n \"id\": \"A9CA1B7E-7BDE-4285-937E-B81A38DEAEEC\",\n \"shippingMethodId\": \"537ED6DF-9DE2-47DE-8C0C-A47022B6F940\",\n \"shippingMethodName\": \"FedEx\",\n \"inStorePickup\": false,\n \"trackingNumber\": \"TZ54235423NSF42334\",\n \"addressFrom\": {\n \"street1\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"stateOrRegion\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"poBox\": false,\n \"name\": {\n \"first\": \"John\",\n \"last\": \"Smith\",\n \"middleInitial\": \"D.\",\n \"salutation\": \"Capt.\",\n \"suffix\": \"Sr.\"\n },\n \"businessName\": \"\",\n \"phoneNumber\": \"\"\n },\n \"locationFromId\": \"wrhse-23425\",\n \"addressTo\": {\n \"street1\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"stateOrRegion\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"poBox\": false,\n \"name\": {\n \"first\": \"John\",\n \"last\": \"Smith\",\n \"middleInitial\": \"D.\",\n \"salutation\": \"Capt.\",\n \"suffix\": \"Sr.\"\n },\n \"businessName\": \"\",\n \"phoneNumber\": \"\"\n },\n \"locationToId\": \"store-14678\",\n \"shippingToDistance\": {\n \"value\": 157.75,\n \"unit\": \"\"\n },\n \"rateServiceCode\": \"fedex_overnight\",\n \"rateVariants\": [\n {\n \"rateId\": \"ups-abcdef\",\n \"carrierId\": \"se-12345\",\n \"pricing\": {\n \"shipping\": 0,\n \"insurance\": 0,\n \"confirmation\": 0,\n \"other\": 0,\n \"fee\": 0\n },\n \"packageType\": \"fixed_rate_priority_envelope\",\n \"deliveryDays\": 4,\n \"estimatedDeliveryDate\": \"2019-09-23T00:00:00Z\",\n \"carrierDeliveryDates\": \"2 business days\",\n \"shipDate\": \"\",\n \"serviceType\": \"$5587Z76\",\n \"serviceCode\": \"next-day\",\n \"carrierCode\": \"fixed_rate_priority\"\n }\n ],\n \"packages\": [\n {\n \"packageCode\": \"flat_rate_padded_envelope\",\n \"weight\": {\n \"value\": \"\",\n \"unit\": \"\"\n },\n \"dimensions\": {\n \"width\": 18.5,\n \"length\": 18.5,\n \"height\": 18.5,\n \"unit\": \"\"\n },\n \"insuredValue\": 0\n }\n ],\n \"pricing\": {\n \"basePrice\": 199.99,\n \"promotionPriceAdjustments\": [\n {\n \"id\": \"E9A22EA5-253E-4764-8238-48AAEFE2E1D3\",\n \"value\": 0,\n \"name\": \"\",\n \"description\": \"Buy 1 flubber get 10 free\",\n \"taxPriceAdjustment\": {\n \"taxCode\": \"\",\n \"value\": 0\n }\n }\n ],\n \"taxPriceAdjustment\": {\n \"taxCode\": \"\",\n \"value\": 0\n }\n },\n \"invalid\": false,\n \"metadata\": {},\n \"errors\": [\n {\n \"level\": \"\",\n \"code\": \"\",\n \"message\": \"\",\n \"detail\": \"\"\n }\n ]\n }\n ],\n \"pricing\": {\n \"promotionPriceAdjustments\": [\n {\n \"id\": \"\",\n \"value\": 0,\n \"name\": \"\",\n \"description\": \"Buy 1 flubber get 10 free\",\n \"itemIds\": [\n \"E9A22EA5-253E-4764-8238-48AAEFE2E1D3\"\n ],\n \"taxPriceAdjustment\": {\n \"taxCode\": \"\",\n \"value\": 0\n }\n }\n ],\n \"totalItemsPrice\": 1799.99,\n \"totalItemsBasePrice\": 1999.99,\n \"totalWarrantyItemsPrice\": 1999.99,\n \"totalWarrantyItemsBasePrice\": 1999.99,\n \"totalShippingPrice\": 150,\n \"totalShippingBasePrice\": 150,\n \"totalFee\": 29.54,\n \"totalTax\": 29.23,\n \"totalShippingPromotion\": 0,\n \"totalCartPromotion\": 0,\n \"totalItemCartPromotion\": 0,\n \"totalPromotion\": 0,\n \"totalPrice\": 2012.48,\n \"totalPreTaxPrice\": 1829.53\n },\n \"payments\": [\n {\n \"exec\": {},\n \"id\": \"\",\n \"state\": \"\",\n \"transactionId\": \"469512\",\n \"value\": 1500\n }\n ],\n \"tax\": {\n \"transactionCode\": \"\",\n \"processedDate\": \"2021-12-01T00:00:00Z\",\n \"entityUseCode\": \"\",\n \"state\": \"\"\n },\n \"email\": \"example@example.com\",\n \"errors\": [\n {\n \"transactionId\": \"\",\n \"level\": \"\",\n \"code\": \"\",\n \"message\": \"\",\n \"detail\": \"\"\n }\n ],\n \"timezoneId\": \"America/Denver\",\n \"modifiedDate\": \"2021-06-04T05:55:27.067Z\",\n \"publicDealerId\": \"your-pdi\"\n}" }, { "id": "u82uIwqan7etiVNet6LN2", "language": "401", "code": "// The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "V8R4Rf08C6wiv_MH9ZtTm", "language": "404", "code": "// The requested resource was not found in the NoChannel system.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" } ], "selectedLanguageId": "Nk6qOjHN3RXvC4v1aAwQo" } }, "children": [ { "text": "" } ] }