--- title: Search Orders slug: api-documentation/search-orders docTags: createdAt: 2026-08-27T16:57:40.129Z --- { "id": "D64kRqooWGP65rhKRMeMR", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://api.upstartcommerce.com/v1/order/search", "servers": [ { "url": "https://api.upstartcommerce.com/v1/order/search" } ], "name": "Search Orders", "description": "

Warning: Deprecated\nThis endpoint utilizes the UpStart search to allow administrators to search through all orders.

\n

Authorized permissions:

\n", "contentType": "application/json", "request": { "pathParameters": [], "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": [ { "kind": "required", "name": "body", "type": "object", "description": "", "customType": "SearchFilterQuery", "schema": [ { "name": "query", "kind": "optional", "type": "string", "description": "Optional query string for searching." }, { "name": "filter", "kind": "optional", "type": "object", "description": "Optional filter object.", "example": "", "schema": [] }, { "name": "page", "kind": "required", "type": "integer", "description": "Page number for pagination.", "format": "int32" }, { "name": "pageSize", "kind": "required", "type": "integer", "description": "Number of items per page.", "format": "int32" }, { "name": "orders", "kind": "optional", "type": "array", "description": "List of orders.", "modelRef": "#/components/schemas/SearchOrder", "customType": "SearchOrder[]", "schema": [ { "name": "property", "kind": "required", "type": "string", "description": "" }, { "name": "asc", "kind": "optional", "type": "boolean", "description": "", "default": true } ] }, { "name": "returnEmptyFacets", "kind": "optional", "type": "boolean", "description": "Whether to return empty facets.", "default": false } ], "modelRef": "#/components/schemas/SearchFilterQuery", "isExpanded": true } ], "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" }, { "id": "ApiKeyAccess", "name": "X-Upstart-Api-Key", "kind": "optional", "type": "apiKey", "description": "Api key based authorization.", "in": "header" }, { "id": "SessionIdAccess", "name": "X-Upstart-Session-Id", "kind": "optional", "type": "apiKey", "description": "

Session based authorization. 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.

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "

Success-orders returned.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "OrderSearchResponse", "schema": [ { "name": "page", "kind": "required", "type": "integer", "description": "" }, { "name": "pageSize", "kind": "required", "type": "integer", "description": "" }, { "name": "count", "kind": "required", "type": "integer", "description": "" }, { "name": "facetCounts", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/SearchFacetCounts", "customType": "SearchFacetCounts", "schema": [ { "name": "properties", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "property", "kind": "required", "type": "string", "description": "" }, { "name": "propertyType", "kind": "required", "type": "string", "description": "", "modelRef": "#/components/schemas/SearchPropertyType", "customType": "SearchPropertyType", "schema": [] }, { "name": "counts", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/SearchCount", "customType": "SearchCount[]", "schema": [ { "name": "value", "kind": "required", "type": "string", "description": "" }, { "name": "count", "kind": "required", "type": "integer", "description": "" } ] } ] }, { "name": "ranges", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "property", "kind": "required", "type": "string", "description": "" }, { "name": "propertyType", "kind": "required", "type": "string", "description": "", "modelRef": "#/components/schemas/SearchPropertyType", "customType": "SearchPropertyType", "schema": [] }, { "name": "counts", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/SearchCount", "customType": "SearchCount[]", "schema": [ { "name": "value", "kind": "required", "type": "string", "description": "" }, { "name": "count", "kind": "required", "type": "integer", "description": "" } ] }, { "name": "start", "kind": "required", "type": "string", "description": "" }, { "name": "end", "kind": "required", "type": "string", "description": "" }, { "name": "gap", "kind": "required", "type": "string", "description": "" } ] } ] }, { "name": "queryId", "kind": "required", "type": "string", "description": "" }, { "name": "redirects", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "items", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/Order", "customType": "Order[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "", "format": "uuid" }, { "name": "siteIds", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "customerId", "kind": "required", "type": "string", "description": "", "format": "uuid" }, { "name": "anonymous", "kind": "required", "type": "boolean", "description": "" }, { "name": "state", "kind": "required", "type": "string", "description": "" }, { "name": "currency", "kind": "required", "type": "string", "description": "" }, { "name": "distanceUnit", "kind": "required", "type": "string", "description": "An enumeration of the supported distance measurements.", "modelRef": "#/components/schemas/DistanceUnits", "customType": "DistanceUnits", "schema": [] }, { "name": "items", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/OrderItem", "customType": "OrderItem[]", "schema": [ { "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.", "example": "", "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": "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": "avgRating", "kind": "optional", "type": "number", "description": "The average consumer rating for this product.", "example": 4.62, "format": "float" }, { "name": "avgGroupRating", "kind": "optional", "type": "number", "description": "", "format": "double" }, { "name": "numGroupReviews", "kind": "optional", "type": "integer", "description": "" }, { "name": "productPopularity", "kind": "optional", "type": "number", "description": "", "format": "double" }, { "name": "excludesClearanceItems", "kind": "optional", "type": "boolean", "description": "" }, { "name": "brandName", "kind": "optional", "type": "string", "description": "

The brand name (if applicable).

", "example": "Bob's Best Toy Line" }, { "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": "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": "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": "ignoreInventory", "kind": "required", "type": "boolean", "description": "

The ignore-inventory flag for the product SKU item.

", "default": false }, { "name": "liveDate", "kind": "optional", "type": "string", "description": "

The date/time this catalog entity was made active.

", "format": "date-time" }, { "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": "modifiedDate", "kind": "optional", "type": "string", "description": "

The date/time this catalog entity was last updated.

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

Consumer-facing name for the catalog item.

", "example": "Green Flubber" }, { "name": "numReviews", "kind": "optional", "type": "integer", "description": "The total number of reviews that have been submitted for this product.", "example": 17, "format": "int32" }, { "name": "offeredStandardWarranty", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/DrupalTermsAndConditions", "customType": "DrupalTermsAndConditions", "schema": [] }, { "name": "serviceQualification", "kind": "optional", "type": "object", "description": "

This is supposed to be filled in for all services and it determines associations of the service, i.e. which products and shipping methods can the service be bought for.

", "modelRef": "#/components/schemas/ServiceQualification", "customType": "ServiceQualification", "schema": [ { "name": "eligibleProductIds", "kind": "optional", "type": "array", "description": "

Lists products this service can be bought for. If empty, buying of the service is not tight to any product.

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

Lists shipping methods this service can be bought for. If empty, buying of the service is not tight to any shipping method.

", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "productItems", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/SkuItemSummary", "customType": "SkuItemSummary[]", "schema": [] }, { "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": "seo", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Seo", "customType": "Seo", "schema": [ { "name": "pageTitle", "kind": "optional", "type": "string", "description": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "" }, { "name": "metaKeywords", "kind": "optional", "type": "array", "description": "", "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": "subVersion", "kind": "optional", "type": "integer", "description": "" }, { "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": "taxCode", "kind": "optional", "type": "string", "description": "

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

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

Flag that describes whether this is a product, protection plan, service or warranty.

", "enum": [ "product", "protectionPlan", "service", "warranty", "fee", "bundle" ] }, { "name": "typeId", "kind": "required", "type": "string", "description": "", "format": "uuid" }, { "name": "typeName", "kind": "required", "type": "string", "description": "

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

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

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

", "example": 5, "default": 0, "format": "int32" } ] }, { "name": "catalogItemId", "kind": "required", "type": "string", "description": "" }, { "name": "catalogItemType", "kind": "required", "type": "string", "description": "", "enum": [ "bundle", "product", "protectionPlan", "service", "warranty", "fee" ] }, { "name": "id", "kind": "optional", "type": "string", "description": "", "format": "uuid" }, { "name": "pricing", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/OrderItemPricing", "customType": "OrderItemPricing", "schema": [ { "name": "basePrice", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/BasePrice", "customType": "BasePrice", "schema": [ { "name": "listPrice", "kind": "required", "type": "number", "description": "" }, { "name": "price", "kind": "required", "type": "number", "description": "" }, { "name": "type", "kind": "required", "type": "string", "description": "" }, { "name": "zone", "kind": "required", "type": "string", "description": "" } ] }, { "name": "feePriceAdjustments", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/FeePriceAdjustment", "customType": "FeePriceAdjustment[]", "schema": [ { "name": "baseValue", "kind": "required", "type": "number", "description": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "" }, { "name": "id", "kind": "required", "type": "string", "description": "" }, { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "quantity", "kind": "required", "type": "integer", "description": "", "format": "int32" }, { "name": "value", "kind": "required", "type": "number", "description": "" } ] }, { "name": "promotionPriceAdjustments", "kind": "required", "type": "array", "description": "

Details about any cart-level promotions applied.

", "modelRef": "#/components/schemas/PromotionPriceAdjustment", "customType": "PromotionPriceAdjustment[]", "schema": [ { "name": "description", "kind": "optional", "type": "string", "description": "The description pulled from the original promotion." }, { "name": "name", "kind": "optional", "type": "string", "description": "The name of the promotion." }, { "name": "id", "kind": "required", "type": "string", "description": "The id for the promo that was applied to the cart.", "format": "uuid" }, { "name": "value", "kind": "required", "type": "number", "description": "The calculated value of the discount applied." }, { "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": "productItemSkuId", "kind": "required", "type": "string", "description": "" }, { "name": "promotionId", "kind": "optional", "type": "string", "description": "" }, { "name": "quantity", "kind": "required", "type": "integer", "description": "", "format": "int32" }, { "name": "shipmentId", "kind": "optional", "type": "string", "description": "", "format": "uuid" }, { "name": "quoteId", "kind": "optional", "type": "integer", "description": "" }, { "name": "targetItemIds", "kind": "optional", "type": "array", "description": "

Target items are order 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": "", "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": "state", "kind": "required", "type": "string", "description": "", "enum": [ "Valid", "Canceled" ] } ] }, { "name": "locationId", "kind": "optional", "type": "string", "description": "" }, { "name": "timeZoneOffset", "kind": "optional", "type": "integer", "description": "", "format": "int32" }, { "name": "haulAwayRequested", "kind": "optional", "type": "number", "description": "" }, { "name": "coupons", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/OrderCoupon", "customType": "OrderCoupon[]", "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.", "default": null }, { "name": "promotionId", "kind": "optional", "type": "string", "description": "The id of the promotion that this coupon was applied for.", "default": null, "format": "uuid" } ] }, { "name": "returnPolicyQualifications", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/OrderReturnPolicyQualification", "customType": "OrderReturnPolicyQualification[]", "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/OrderReturnPolicyGroupQualification", "customType": "OrderReturnPolicyGroupQualification[]", "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": "id", "kind": "required", "type": "string", "description": "" } ] }, { "name": "ReturnPolicySku", "description": "", "modelRef": "#/components/schemas/ReturnPolicySku", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "" }, { "name": "skuId", "kind": "required", "type": "string", "description": "" } ] } ] }, { "name": "qualificationResult", "kind": "required", "type": "object", "discriminator": { "propertyName": "type", "mapping": { "Qualified": "#/components/schemas/Qualified", "NotQualified": "#/components/schemas/NotQualified" } }, "description": "", "modelRef": "#/components/schemas/OrderReturnPolicyQualificationResult", "customType": "OrderReturnPolicyQualificationResult", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "Qualified", "description": "", "modelRef": "#/components/schemas/Qualified", "schema": [ { "name": "triggeredMessage", "kind": "required", "type": "string", "description": "" } ] }, { "name": "NotQualified", "description": "", "modelRef": "#/components/schemas/NotQualified", "schema": [ { "name": "triggeredMessage", "kind": "required", "type": "string", "description": "" }, { "name": "unqualifiedMessage", "kind": "required", "type": "string", "description": "A notification message informing that a return policy has been triggered but not qualified for." } ] } ] } ] } ] }, { "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": "", "minimum": -90, "maximum": 90 }, { "name": "longitude", "kind": "required", "type": "number", "description": "", "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": "required", "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": "required", "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": "", "modelRef": "#/components/schemas/OrderShipment", "customType": "OrderShipment[]", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "", "format": "uuid" }, { "name": "state", "kind": "required", "type": "string", "description": "These are the valid shipment states.", "modelRef": "#/components/schemas/ShipmentStateEnum", "customType": "ShipmentStateEnum", "schema": [] }, { "name": "shippingMethodId", "kind": "required", "type": "string", "description": "", "format": "uuid" }, { "name": "shippingMethodName", "kind": "optional", "type": "string", "description": "" }, { "name": "trackingNumber", "kind": "optional", "type": "string", "description": "" }, { "name": "trackingUrl", "kind": "optional", "type": "string", "description": "

Tracking URL. If defined, tracking is supported for given carrier.

", "example": "https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=391274234820&cntry_code=us&locale=en_US" }, { "name": "labelDownload", "kind": "optional", "type": "map", "description": "", "example": "", "customType": "map", "schema": [] }, { "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": "required", "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": "" }, { "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": "required", "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": "" }, { "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": "rate", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/ShippingRate", "customType": "ShippingRate", "schema": [ { "name": "rateId", "kind": "required", "type": "string", "description": "" }, { "name": "carrierId", "kind": "required", "type": "string", "description": "" }, { "name": "pricing", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/ShippingRatePricing", "customType": "ShippingRatePricing", "schema": [ { "name": "shipping", "kind": "required", "type": "number", "description": "" }, { "name": "insurance", "kind": "optional", "type": "number", "description": "" }, { "name": "confirmation", "kind": "optional", "type": "number", "description": "" }, { "name": "other", "kind": "optional", "type": "number", "description": "" }, { "name": "fee", "kind": "optional", "type": "number", "description": "" } ] }, { "name": "packageType", "kind": "optional", "type": "string", "description": "" }, { "name": "deliveryDays", "kind": "optional", "type": "integer", "description": "", "format": "int32" }, { "name": "estimatedDeliveryDate", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "carrierDeliveryDates", "kind": "required", "type": "string", "description": "" }, { "name": "shipDate", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "serviceType", "kind": "required", "type": "string", "description": "" }, { "name": "serviceCode", "kind": "required", "type": "string", "description": "" }, { "name": "carrierCode", "kind": "required", "type": "string", "description": "" } ] }, { "name": "packages", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/ShippingPackage", "customType": "ShippingPackage[]", "schema": [ { "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": "" }, { "name": "packageCode", "kind": "optional", "type": "string", "description": "" }, { "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": "trackingNumber", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "pricing", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/OrderShipmentPricing", "customType": "OrderShipmentPricing", "schema": [ { "name": "basePrice", "kind": "optional", "type": "number", "description": "" }, { "name": "promotionPriceAdjustments", "kind": "required", "type": "array", "description": "

Details about any cart-level promotions applied.

", "modelRef": "#/components/schemas/PromotionPriceAdjustment", "customType": "PromotionPriceAdjustment[]", "schema": [ { "name": "description", "kind": "optional", "type": "string", "description": "The description pulled from the original promotion." }, { "name": "name", "kind": "optional", "type": "string", "description": "The name of the promotion." }, { "name": "id", "kind": "required", "type": "string", "description": "The id for the promo that was applied to the cart.", "format": "uuid" }, { "name": "value", "kind": "required", "type": "number", "description": "The calculated value of the discount applied." }, { "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": "deliveredDate", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "errors", "kind": "optional", "type": "array", "description": "

Describes an error that needs to be corrected prior to any state-change in the order.

", "modelRef": "#/components/schemas/ErrorMessage", "customType": "ErrorMessage[]", "schema": [ { "name": "code", "kind": "required", "type": "string", "description": "A code that represents a specific type of error." }, { "name": "detail", "kind": "optional", "type": "string", "description": "A detailed trace of the issue." }, { "name": "level", "kind": "required", "type": "string", "description": "Level of the issue.", "enum": [ "ERROR", "INFO", "WARNING" ] }, { "name": "message", "kind": "optional", "type": "string", "description": "

A message indicating what caused the error to be included. THIS IS NOT INTENDED TO BE DISPLAYED TO A USER.\nIf you choose to do so, you are welcome to - but this is mostly intended to allow a developer to diagnose an issue.

" } ] }, { "name": "pickupHours", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/NormalHoursOfOperation", "customType": "NormalHoursOfOperation[]", "schema": [], "complexType": "allOf", "complexItems": [ { "name": "HoursOfOperation", "description": "", "modelRef": "#/components/schemas/HoursOfOperation", "schema": [ { "name": "isOpen", "kind": "required", "type": "boolean", "description": "" }, { "name": "open", "kind": "optional", "type": "string", "description": "" }, { "name": "closed", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "object", "description": "", "schema": [ { "name": "day", "kind": "required", "type": "string", "description": "The day of the week.", "enum": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] } ] } ] } ] }, { "name": "pricing", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/OrderPricing", "customType": "OrderPricing", "schema": [ { "name": "promotionPriceAdjustments", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/OrderPromotionPriceAdjustment", "customType": "OrderPromotionPriceAdjustment[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "The unique id for this promotional price adjustment." }, { "name": "name", "kind": "optional", "type": "string", "description": "The name of the promotion that this adjustment is based on." }, { "name": "value", "kind": "required", "type": "number", "description": "The value that this promotional adjustment applies to the cart. It will always be a negative number.", "example": -200, "exclusiveMaximum": false }, { "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": "totalFee", "kind": "optional", "type": "number", "description": "", "default": 0 }, { "name": "totalItemOrderPromotion", "kind": "optional", "type": "number", "description": "", "default": 0 }, { "name": "totalItemsBasePrice", "kind": "optional", "type": "number", "description": "", "default": 0 }, { "name": "totalItemsPrice", "kind": "optional", "type": "number", "description": "", "default": 0 }, { "name": "totalPreTaxPrice", "kind": "optional", "type": "number", "description": "", "default": 0 }, { "name": "totalPrice", "kind": "optional", "type": "number", "description": "", "default": 0 }, { "name": "totalPromotion", "kind": "optional", "type": "number", "description": "", "default": 0 }, { "name": "totalShippingBasePrice", "kind": "optional", "type": "number", "description": "", "default": 0 }, { "name": "totalShippingPrice", "kind": "optional", "type": "number", "description": "", "default": 0 }, { "name": "totalShippingPromotion", "kind": "optional", "type": "number", "description": "", "default": 0 }, { "name": "totalTax", "kind": "optional", "type": "number", "description": "", "default": 0 } ] }, { "name": "payments", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/OrderPayment", "customType": "OrderPayment[]", "schema": [ { "name": "exec", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/PaymentExec", "customType": "PaymentExec", "schema": [] }, { "name": "id", "kind": "optional", "type": "string", "description": "" }, { "name": "processedDate", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "refundedDate", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "state", "kind": "required", "type": "string", "description": "", "modelRef": "#/components/schemas/PaymentStatesEnum", "customType": "PaymentStatesEnum", "schema": [] }, { "name": "transactionId", "kind": "optional", "type": "string", "description": "" }, { "name": "value", "kind": "optional", "type": "number", "description": "" } ] }, { "name": "tax", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/OrderTax", "customType": "OrderTax", "schema": [ { "name": "processedDate", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "refundedDate", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "state", "kind": "required", "type": "string", "description": "

The processing-state of the taxes applied to an order's payment.

", "modelRef": "#/components/schemas/TaxStatesEnum", "customType": "TaxStatesEnum", "schema": [] }, { "name": "transactionCode", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "email", "kind": "optional", "type": "string", "description": "", "format": "email" }, { "name": "orderDate", "kind": "required", "type": "string", "description": "", "format": "date-time" }, { "name": "modifiedDate", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "closeoutDate", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "internalInvoiceId", "kind": "optional", "type": "string", "description": "" }, { "name": "timeZoneId", "kind": "optional", "type": "string", "description": "" } ] } ], "modelRef": "#/components/schemas/OrderSearchResponse", "complexItems": [ { "name": "object", "schema": [ { "name": "page", "kind": "required", "type": "integer", "description": "" }, { "name": "pageSize", "kind": "required", "type": "integer", "description": "" }, { "name": "count", "kind": "required", "type": "integer", "description": "" }, { "name": "facetCounts", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/SearchFacetCounts", "customType": "SearchFacetCounts", "schema": [ { "name": "properties", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "property", "kind": "required", "type": "string", "description": "" }, { "name": "propertyType", "kind": "required", "type": "string", "description": "", "modelRef": "#/components/schemas/SearchPropertyType", "customType": "SearchPropertyType", "schema": [] }, { "name": "counts", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/SearchCount", "customType": "SearchCount[]", "schema": [ { "name": "value", "kind": "required", "type": "string", "description": "" }, { "name": "count", "kind": "required", "type": "integer", "description": "" } ] } ] }, { "name": "ranges", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "property", "kind": "required", "type": "string", "description": "" }, { "name": "propertyType", "kind": "required", "type": "string", "description": "", "modelRef": "#/components/schemas/SearchPropertyType", "customType": "SearchPropertyType", "schema": [] }, { "name": "counts", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/SearchCount", "customType": "SearchCount[]", "schema": [ { "name": "value", "kind": "required", "type": "string", "description": "" }, { "name": "count", "kind": "required", "type": "integer", "description": "" } ] }, { "name": "start", "kind": "required", "type": "string", "description": "" }, { "name": "end", "kind": "required", "type": "string", "description": "" }, { "name": "gap", "kind": "required", "type": "string", "description": "" } ] } ] }, { "name": "queryId", "kind": "required", "type": "string", "description": "" }, { "name": "redirects", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ], "modelRef": "#/components/schemas/SearchResponse", "customType": "SearchResponse" }, { "name": "object", "schema": [ { "name": "items", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/Order", "customType": "Order[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "", "format": "uuid" }, { "name": "siteIds", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "customerId", "kind": "required", "type": "string", "description": "", "format": "uuid" }, { "name": "anonymous", "kind": "required", "type": "boolean", "description": "" }, { "name": "state", "kind": "required", "type": "string", "description": "" }, { "name": "currency", "kind": "required", "type": "string", "description": "" }, { "name": "distanceUnit", "kind": "required", "type": "string", "description": "An enumeration of the supported distance measurements.", "modelRef": "#/components/schemas/DistanceUnits", "customType": "DistanceUnits", "schema": [] }, { "name": "items", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/OrderItem", "customType": "OrderItem[]", "schema": [ { "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.", "example": "", "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": "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": "avgRating", "kind": "optional", "type": "number", "description": "The average consumer rating for this product.", "example": 4.62, "format": "float" }, { "name": "avgGroupRating", "kind": "optional", "type": "number", "description": "", "format": "double" }, { "name": "numGroupReviews", "kind": "optional", "type": "integer", "description": "" }, { "name": "productPopularity", "kind": "optional", "type": "number", "description": "", "format": "double" }, { "name": "excludesClearanceItems", "kind": "optional", "type": "boolean", "description": "" }, { "name": "brandName", "kind": "optional", "type": "string", "description": "

The brand name (if applicable).

", "example": "Bob's Best Toy Line" }, { "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": "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": "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": "ignoreInventory", "kind": "required", "type": "boolean", "description": "

The ignore-inventory flag for the product SKU item.

", "default": false }, { "name": "liveDate", "kind": "optional", "type": "string", "description": "

The date/time this catalog entity was made active.

", "format": "date-time" }, { "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": "modifiedDate", "kind": "optional", "type": "string", "description": "

The date/time this catalog entity was last updated.

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

Consumer-facing name for the catalog item.

", "example": "Green Flubber" }, { "name": "numReviews", "kind": "optional", "type": "integer", "description": "The total number of reviews that have been submitted for this product.", "example": 17, "format": "int32" }, { "name": "offeredStandardWarranty", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/DrupalTermsAndConditions", "customType": "DrupalTermsAndConditions", "schema": [] }, { "name": "serviceQualification", "kind": "optional", "type": "object", "description": "

This is supposed to be filled in for all services and it determines associations of the service, i.e. which products and shipping methods can the service be bought for.

", "modelRef": "#/components/schemas/ServiceQualification", "customType": "ServiceQualification", "schema": [ { "name": "eligibleProductIds", "kind": "optional", "type": "array", "description": "

Lists products this service can be bought for. If empty, buying of the service is not tight to any product.

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

Lists shipping methods this service can be bought for. If empty, buying of the service is not tight to any shipping method.

", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "productItems", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/SkuItemSummary", "customType": "SkuItemSummary[]", "schema": [] }, { "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": "seo", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Seo", "customType": "Seo", "schema": [ { "name": "pageTitle", "kind": "optional", "type": "string", "description": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "" }, { "name": "metaKeywords", "kind": "optional", "type": "array", "description": "", "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": "subVersion", "kind": "optional", "type": "integer", "description": "" }, { "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": "taxCode", "kind": "optional", "type": "string", "description": "

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

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

Flag that describes whether this is a product, protection plan, service or warranty.

", "enum": [ "product", "protectionPlan", "service", "warranty", "fee", "bundle" ] }, { "name": "typeId", "kind": "required", "type": "string", "description": "", "format": "uuid" }, { "name": "typeName", "kind": "required", "type": "string", "description": "

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

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

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

", "example": 5, "default": 0, "format": "int32" } ] }, { "name": "catalogItemId", "kind": "required", "type": "string", "description": "" }, { "name": "catalogItemType", "kind": "required", "type": "string", "description": "", "enum": [ "bundle", "product", "protectionPlan", "service", "warranty", "fee" ] }, { "name": "id", "kind": "optional", "type": "string", "description": "", "format": "uuid" }, { "name": "pricing", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/OrderItemPricing", "customType": "OrderItemPricing", "schema": [ { "name": "basePrice", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/BasePrice", "customType": "BasePrice", "schema": [ { "name": "listPrice", "kind": "required", "type": "number", "description": "" }, { "name": "price", "kind": "required", "type": "number", "description": "" }, { "name": "type", "kind": "required", "type": "string", "description": "" }, { "name": "zone", "kind": "required", "type": "string", "description": "" } ] }, { "name": "feePriceAdjustments", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/FeePriceAdjustment", "customType": "FeePriceAdjustment[]", "schema": [ { "name": "baseValue", "kind": "required", "type": "number", "description": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "" }, { "name": "id", "kind": "required", "type": "string", "description": "" }, { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "quantity", "kind": "required", "type": "integer", "description": "", "format": "int32" }, { "name": "value", "kind": "required", "type": "number", "description": "" } ] }, { "name": "promotionPriceAdjustments", "kind": "required", "type": "array", "description": "

Details about any cart-level promotions applied.

", "modelRef": "#/components/schemas/PromotionPriceAdjustment", "customType": "PromotionPriceAdjustment[]", "schema": [ { "name": "description", "kind": "optional", "type": "string", "description": "The description pulled from the original promotion." }, { "name": "name", "kind": "optional", "type": "string", "description": "The name of the promotion." }, { "name": "id", "kind": "required", "type": "string", "description": "The id for the promo that was applied to the cart.", "format": "uuid" }, { "name": "value", "kind": "required", "type": "number", "description": "The calculated value of the discount applied." }, { "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": "productItemSkuId", "kind": "required", "type": "string", "description": "" }, { "name": "promotionId", "kind": "optional", "type": "string", "description": "" }, { "name": "quantity", "kind": "required", "type": "integer", "description": "", "format": "int32" }, { "name": "shipmentId", "kind": "optional", "type": "string", "description": "", "format": "uuid" }, { "name": "quoteId", "kind": "optional", "type": "integer", "description": "" }, { "name": "targetItemIds", "kind": "optional", "type": "array", "description": "

Target items are order 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": "", "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": "state", "kind": "required", "type": "string", "description": "", "enum": [ "Valid", "Canceled" ] } ] }, { "name": "locationId", "kind": "optional", "type": "string", "description": "" }, { "name": "timeZoneOffset", "kind": "optional", "type": "integer", "description": "", "format": "int32" }, { "name": "haulAwayRequested", "kind": "optional", "type": "number", "description": "" }, { "name": "coupons", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/OrderCoupon", "customType": "OrderCoupon[]", "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.", "default": null }, { "name": "promotionId", "kind": "optional", "type": "string", "description": "The id of the promotion that this coupon was applied for.", "default": null, "format": "uuid" } ] }, { "name": "returnPolicyQualifications", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/OrderReturnPolicyQualification", "customType": "OrderReturnPolicyQualification[]", "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/OrderReturnPolicyGroupQualification", "customType": "OrderReturnPolicyGroupQualification[]", "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": "id", "kind": "required", "type": "string", "description": "" } ] }, { "name": "ReturnPolicySku", "description": "", "modelRef": "#/components/schemas/ReturnPolicySku", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "" }, { "name": "skuId", "kind": "required", "type": "string", "description": "" } ] } ] }, { "name": "qualificationResult", "kind": "required", "type": "object", "discriminator": { "propertyName": "type", "mapping": { "Qualified": "#/components/schemas/Qualified", "NotQualified": "#/components/schemas/NotQualified" } }, "description": "", "modelRef": "#/components/schemas/OrderReturnPolicyQualificationResult", "customType": "OrderReturnPolicyQualificationResult", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "Qualified", "description": "", "modelRef": "#/components/schemas/Qualified", "schema": [ { "name": "triggeredMessage", "kind": "required", "type": "string", "description": "" } ] }, { "name": "NotQualified", "description": "", "modelRef": "#/components/schemas/NotQualified", "schema": [ { "name": "triggeredMessage", "kind": "required", "type": "string", "description": "" }, { "name": "unqualifiedMessage", "kind": "required", "type": "string", "description": "A notification message informing that a return policy has been triggered but not qualified for." } ] } ] } ] } ] }, { "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": "", "minimum": -90, "maximum": 90 }, { "name": "longitude", "kind": "required", "type": "number", "description": "", "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": "required", "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": "required", "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": "", "modelRef": "#/components/schemas/OrderShipment", "customType": "OrderShipment[]", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "", "format": "uuid" }, { "name": "state", "kind": "required", "type": "string", "description": "These are the valid shipment states.", "modelRef": "#/components/schemas/ShipmentStateEnum", "customType": "ShipmentStateEnum", "schema": [] }, { "name": "shippingMethodId", "kind": "required", "type": "string", "description": "", "format": "uuid" }, { "name": "shippingMethodName", "kind": "optional", "type": "string", "description": "" }, { "name": "trackingNumber", "kind": "optional", "type": "string", "description": "" }, { "name": "trackingUrl", "kind": "optional", "type": "string", "description": "

Tracking URL. If defined, tracking is supported for given carrier.

", "example": "https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=391274234820&cntry_code=us&locale=en_US" }, { "name": "labelDownload", "kind": "optional", "type": "map", "description": "", "example": "", "customType": "map", "schema": [] }, { "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": "required", "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": "" }, { "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": "required", "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": "" }, { "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": "rate", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/ShippingRate", "customType": "ShippingRate", "schema": [ { "name": "rateId", "kind": "required", "type": "string", "description": "" }, { "name": "carrierId", "kind": "required", "type": "string", "description": "" }, { "name": "pricing", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/ShippingRatePricing", "customType": "ShippingRatePricing", "schema": [ { "name": "shipping", "kind": "required", "type": "number", "description": "" }, { "name": "insurance", "kind": "optional", "type": "number", "description": "" }, { "name": "confirmation", "kind": "optional", "type": "number", "description": "" }, { "name": "other", "kind": "optional", "type": "number", "description": "" }, { "name": "fee", "kind": "optional", "type": "number", "description": "" } ] }, { "name": "packageType", "kind": "optional", "type": "string", "description": "" }, { "name": "deliveryDays", "kind": "optional", "type": "integer", "description": "", "format": "int32" }, { "name": "estimatedDeliveryDate", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "carrierDeliveryDates", "kind": "required", "type": "string", "description": "" }, { "name": "shipDate", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "serviceType", "kind": "required", "type": "string", "description": "" }, { "name": "serviceCode", "kind": "required", "type": "string", "description": "" }, { "name": "carrierCode", "kind": "required", "type": "string", "description": "" } ] }, { "name": "packages", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/ShippingPackage", "customType": "ShippingPackage[]", "schema": [ { "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": "" }, { "name": "packageCode", "kind": "optional", "type": "string", "description": "" }, { "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": "trackingNumber", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "pricing", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/OrderShipmentPricing", "customType": "OrderShipmentPricing", "schema": [ { "name": "basePrice", "kind": "optional", "type": "number", "description": "" }, { "name": "promotionPriceAdjustments", "kind": "required", "type": "array", "description": "

Details about any cart-level promotions applied.

", "modelRef": "#/components/schemas/PromotionPriceAdjustment", "customType": "PromotionPriceAdjustment[]", "schema": [ { "name": "description", "kind": "optional", "type": "string", "description": "The description pulled from the original promotion." }, { "name": "name", "kind": "optional", "type": "string", "description": "The name of the promotion." }, { "name": "id", "kind": "required", "type": "string", "description": "The id for the promo that was applied to the cart.", "format": "uuid" }, { "name": "value", "kind": "required", "type": "number", "description": "The calculated value of the discount applied." }, { "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": "deliveredDate", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "errors", "kind": "optional", "type": "array", "description": "

Describes an error that needs to be corrected prior to any state-change in the order.

", "modelRef": "#/components/schemas/ErrorMessage", "customType": "ErrorMessage[]", "schema": [ { "name": "code", "kind": "required", "type": "string", "description": "A code that represents a specific type of error." }, { "name": "detail", "kind": "optional", "type": "string", "description": "A detailed trace of the issue." }, { "name": "level", "kind": "required", "type": "string", "description": "Level of the issue.", "enum": [ "ERROR", "INFO", "WARNING" ] }, { "name": "message", "kind": "optional", "type": "string", "description": "

A message indicating what caused the error to be included. THIS IS NOT INTENDED TO BE DISPLAYED TO A USER.\nIf you choose to do so, you are welcome to - but this is mostly intended to allow a developer to diagnose an issue.

" } ] }, { "name": "pickupHours", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/NormalHoursOfOperation", "customType": "NormalHoursOfOperation[]", "schema": [], "complexType": "allOf", "complexItems": [ { "name": "HoursOfOperation", "description": "", "modelRef": "#/components/schemas/HoursOfOperation", "schema": [ { "name": "isOpen", "kind": "required", "type": "boolean", "description": "" }, { "name": "open", "kind": "optional", "type": "string", "description": "" }, { "name": "closed", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "object", "description": "", "schema": [ { "name": "day", "kind": "required", "type": "string", "description": "The day of the week.", "enum": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] } ] } ] } ] }, { "name": "pricing", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/OrderPricing", "customType": "OrderPricing", "schema": [ { "name": "promotionPriceAdjustments", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/OrderPromotionPriceAdjustment", "customType": "OrderPromotionPriceAdjustment[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "The unique id for this promotional price adjustment." }, { "name": "name", "kind": "optional", "type": "string", "description": "The name of the promotion that this adjustment is based on." }, { "name": "value", "kind": "required", "type": "number", "description": "The value that this promotional adjustment applies to the cart. It will always be a negative number.", "example": -200, "exclusiveMaximum": false }, { "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": "", "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": "totalFee", "kind": "optional", "type": "number", "description": "", "default": 0 }, { "name": "totalItemOrderPromotion", "kind": "optional", "type": "number", "description": "", "default": 0 }, { "name": "totalItemsBasePrice", "kind": "optional", "type": "number", "description": "", "default": 0 }, { "name": "totalItemsPrice", "kind": "optional", "type": "number", "description": "", "default": 0 }, { "name": "totalPreTaxPrice", "kind": "optional", "type": "number", "description": "", "default": 0 }, { "name": "totalPrice", "kind": "optional", "type": "number", "description": "", "default": 0 }, { "name": "totalPromotion", "kind": "optional", "type": "number", "description": "", "default": 0 }, { "name": "totalShippingBasePrice", "kind": "optional", "type": "number", "description": "", "default": 0 }, { "name": "totalShippingPrice", "kind": "optional", "type": "number", "description": "", "default": 0 }, { "name": "totalShippingPromotion", "kind": "optional", "type": "number", "description": "", "default": 0 }, { "name": "totalTax", "kind": "optional", "type": "number", "description": "", "default": 0 } ] }, { "name": "payments", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/OrderPayment", "customType": "OrderPayment[]", "schema": [ { "name": "exec", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/PaymentExec", "customType": "PaymentExec", "schema": [] }, { "name": "id", "kind": "optional", "type": "string", "description": "" }, { "name": "processedDate", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "refundedDate", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "state", "kind": "required", "type": "string", "description": "", "modelRef": "#/components/schemas/PaymentStatesEnum", "customType": "PaymentStatesEnum", "schema": [] }, { "name": "transactionId", "kind": "optional", "type": "string", "description": "" }, { "name": "value", "kind": "optional", "type": "number", "description": "" } ] }, { "name": "tax", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/OrderTax", "customType": "OrderTax", "schema": [ { "name": "processedDate", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "refundedDate", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "state", "kind": "required", "type": "string", "description": "

The processing-state of the taxes applied to an order's payment.

", "modelRef": "#/components/schemas/TaxStatesEnum", "customType": "TaxStatesEnum", "schema": [] }, { "name": "transactionCode", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "email", "kind": "optional", "type": "string", "description": "", "format": "email" }, { "name": "orderDate", "kind": "required", "type": "string", "description": "", "format": "date-time" }, { "name": "modifiedDate", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "closeoutDate", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "internalInvoiceId", "kind": "optional", "type": "string", "description": "" }, { "name": "timeZoneId", "kind": "optional", "type": "string", "description": "" } ] } ] } ], "complexType": "allOf", "isExpanded": true } ] }, { "statusCode": "400", "description": "The request contained information that the server was unable to process. Appropriate errors are provided in the response body.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ValidationErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ValidationErrorResponse", "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, "deprecated": true, "examples": { "languages": [ { "id": "zWu__wE50oHQZuy5PXVHZ", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.upstartcommerce.com/v1/order/search \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --header 'x-upstart-tenant: string' \\\n --data '{\n \"page\": \"\",\n \"pageSize\": \"\",\n \"orders\": [\n {\n \"property\": \"\",\n \"asc\": true\n }\n ]\n }'" }, { "id": "PpU1QPopm1SfXrRpmVdtm", "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 raw = JSON.stringify({\n \"page\": \"\",\n \"pageSize\": \"\",\n \"orders\": [\n {\n \"property\": \"\",\n \"asc\": true\n }\n ]\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.upstartcommerce.com/v1/order/search\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "YOlLyo2Oi2JNPFVGf1LaX", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/v1/order/search\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-upstart-tenant\"] = \"string\"\nrequest.body = JSON.dump({\n \"page\": \"\",\n \"pageSize\": \"\",\n \"orders\": [\n {\n \"property\": \"\",\n \"asc\": true\n }\n ]\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "yg9AgFF3x_hPl2Kw27dfl", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/v1/order/search\"\n\npayload = json.dumps({\n \"page\": \"\",\n \"pageSize\": \"\",\n \"orders\": [\n {\n \"property\": \"\",\n \"asc\": True\n }\n ]\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-upstart-tenant': 'string'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "zWu__wE50oHQZuy5PXVHZ" }, "results": { "languages": [ { "id": "YG9V6AJAeQQ89vRv3ilXu", "language": "200", "code": "// Success-orders returned.\n{\n \"page\": 0,\n \"pageSize\": 0,\n \"count\": 0,\n \"facetCounts\": {\n \"properties\": [\n {\n \"property\": \"\",\n \"propertyType\": \"\",\n \"counts\": [\n {\n \"value\": \"\",\n \"count\": 0\n }\n ]\n }\n ],\n \"ranges\": [\n {\n \"property\": \"\",\n \"propertyType\": \"\",\n \"counts\": [\n {\n \"value\": \"\",\n \"count\": 0\n }\n ],\n \"start\": \"\",\n \"end\": \"\",\n \"gap\": \"\"\n }\n ]\n },\n \"queryId\": \"\",\n \"redirects\": [\n \"\"\n ],\n \"items\": [\n {\n \"id\": \"\",\n \"siteIds\": [\n \"\"\n ],\n \"customerId\": \"\",\n \"anonymous\": false,\n \"state\": \"\",\n \"currency\": \"\",\n \"distanceUnit\": \"\",\n \"items\": [\n {\n \"catalogItem\": {\n \"id\": \"\",\n \"siteIds\": [\n \"\"\n ],\n \"activationDate\": \"\",\n \"archived\": false,\n \"avgRating\": 4.62,\n \"avgGroupRating\": \"\",\n \"numGroupReviews\": 0,\n \"productPopularity\": \"\",\n \"excludesClearanceItems\": false,\n \"brandName\": \"Bob's Best Toy Line\",\n \"deactivationDate\": \"\",\n \"dynamicProperties\": {},\n \"hidden\": false,\n \"ignoreInventory\": false,\n \"liveDate\": \"\",\n \"manufacturerName\": \"Bob's chemical company.\",\n \"media\": \"\",\n \"modifiedDate\": \"\",\n \"name\": \"Green Flubber\",\n \"numReviews\": 17,\n \"offeredStandardWarranty\": {},\n \"serviceQualification\": {\n \"eligibleProductIds\": [\n \"\"\n ],\n \"eligibleShippingMethodIds\": [\n \"\"\n ]\n },\n \"productItems\": [\n \"\"\n ],\n \"relatedIds\": [\n \"\"\n ],\n \"seo\": {\n \"pageTitle\": \"\",\n \"description\": \"\",\n \"metaKeywords\": [\n \"\"\n ]\n },\n \"shippingMethodIds\": [\n \"\"\n ],\n \"subVersion\": 0,\n \"tags\": [\n \"\"\n ],\n \"taxCode\": \"P0000000\",\n \"type\": \"\",\n \"typeId\": \"\",\n \"typeName\": \"Speaker\",\n \"version\": 5\n },\n \"catalogItemId\": \"\",\n \"catalogItemType\": \"\",\n \"id\": \"\",\n \"pricing\": {\n \"basePrice\": {\n \"listPrice\": 0,\n \"price\": 0,\n \"type\": \"\",\n \"zone\": \"\"\n },\n \"feePriceAdjustments\": [\n {\n \"baseValue\": 0,\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"quantity\": \"\",\n \"value\": 0\n }\n ],\n \"promotionPriceAdjustments\": [\n {\n \"description\": \"\",\n \"name\": \"\",\n \"id\": \"\",\n \"value\": 0,\n \"taxPriceAdjustment\": {\n \"taxCode\": \"\",\n \"value\": 0\n }\n }\n ],\n \"taxPriceAdjustment\": {\n \"taxCode\": \"\",\n \"value\": 0\n }\n },\n \"productItemSkuId\": \"\",\n \"promotionId\": \"\",\n \"quantity\": \"\",\n \"shipmentId\": \"\",\n \"quoteId\": 0,\n \"targetItemIds\": [\n \"\"\n ],\n \"targetShipmentIds\": [\n \"\"\n ],\n \"state\": \"\"\n }\n ],\n \"locationId\": \"\",\n \"timeZoneOffset\": \"\",\n \"haulAwayRequested\": 0,\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\": 0,\n \"longitude\": 0\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\": \"\",\n \"state\": \"\",\n \"shippingMethodId\": \"\",\n \"shippingMethodName\": \"\",\n \"trackingNumber\": \"\",\n \"trackingUrl\": \"https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=391274234820&cntry_code=us&locale=en_US\",\n \"labelDownload\": \"\",\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\": \"\",\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\": \"\",\n \"shippingToDistance\": {\n \"value\": 157.75,\n \"unit\": \"\"\n },\n \"rate\": {\n \"rateId\": \"\",\n \"carrierId\": \"\",\n \"pricing\": {\n \"shipping\": 0,\n \"insurance\": 0,\n \"confirmation\": 0,\n \"other\": 0,\n \"fee\": 0\n },\n \"packageType\": \"\",\n \"deliveryDays\": \"\",\n \"estimatedDeliveryDate\": \"\",\n \"carrierDeliveryDates\": \"\",\n \"shipDate\": \"\",\n \"serviceType\": \"\",\n \"serviceCode\": \"\",\n \"carrierCode\": \"\"\n },\n \"packages\": [\n {\n \"dimensions\": {\n \"width\": 18.5,\n \"length\": 18.5,\n \"height\": 18.5,\n \"unit\": \"\"\n },\n \"insuredValue\": 0,\n \"packageCode\": \"\",\n \"weight\": {\n \"value\": \"\",\n \"unit\": \"\"\n },\n \"trackingNumber\": \"\"\n }\n ],\n \"pricing\": {\n \"basePrice\": 0,\n \"promotionPriceAdjustments\": [\n {\n \"description\": \"\",\n \"name\": \"\",\n \"id\": \"\",\n \"value\": 0,\n \"taxPriceAdjustment\": {\n \"taxCode\": \"\",\n \"value\": 0\n }\n }\n ],\n \"taxPriceAdjustment\": {\n \"taxCode\": \"\",\n \"value\": 0\n }\n },\n \"deliveredDate\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"level\": \"\",\n \"message\": \"\"\n }\n ],\n \"pickupHours\": {}\n }\n ],\n \"pricing\": {\n \"promotionPriceAdjustments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": -200,\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 \"totalFee\": 0,\n \"totalItemOrderPromotion\": 0,\n \"totalItemsBasePrice\": 0,\n \"totalItemsPrice\": 0,\n \"totalPreTaxPrice\": 0,\n \"totalPrice\": 0,\n \"totalPromotion\": 0,\n \"totalShippingBasePrice\": 0,\n \"totalShippingPrice\": 0,\n \"totalShippingPromotion\": 0,\n \"totalTax\": 0\n },\n \"payments\": [\n {\n \"exec\": {},\n \"id\": \"\",\n \"processedDate\": \"\",\n \"refundedDate\": \"\",\n \"state\": \"\",\n \"transactionId\": \"\",\n \"value\": 0\n }\n ],\n \"tax\": {\n \"processedDate\": \"\",\n \"refundedDate\": \"\",\n \"state\": \"\",\n \"transactionCode\": \"\"\n },\n \"email\": \"\",\n \"orderDate\": \"\",\n \"modifiedDate\": \"\",\n \"closeoutDate\": \"\",\n \"internalInvoiceId\": \"\",\n \"timeZoneId\": \"\"\n }\n ]\n}" }, { "id": "D7Q3mM45w7HaGXg-w7QmU", "language": "400", "code": "// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n}" }, { "id": "z1CnApFM1hH6hqrg6PlmS", "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": "74w9TYDREFO24DKPwZvnQ", "language": "404", "code": "// The requested resource was not found in the NoChannel system.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" } ], "selectedLanguageId": "YG9V6AJAeQQ89vRv3ilXu" } }, "children": [ { "text": "" } ] }