GetCategoryShipDateRestrictions (Method)

Description

Gets any ship date restrictions from categories of items in the shopping cart. Introduced in 2023.1

Request (GetCategoryShipDateRestrictionsSoapIn)

The request body is of type GetCategoryShipDateRestrictions.

Example

The following example shows how to perform the web operation in CyberStore.

Javascript

// Example: Requesting category ship date restrictions in current cart

MakeAJAXCall("Cart.GetCategoryShipDateRestrictions", {}, console.log)

200 Response (GetCategoryShipDateRestrictionsSoapOut)

The response body is of type GetCategoryShipDateRestrictionsResponse.

Response Body Parameters

Name	Description	Data Type
GetCategoryShipDateRestrictionsResult	A string value containing a JSON object. // Example 1: Sample when restrictions exist { "Data": { "ShipDateRestricted": true, "ShipDateRange": { "MinimumShipDate": "08/26/2020", "MaximumShipDate": "10/31/2020" } }, "Result": { "Success": true, "Message": "The shopping cart contains items that are in categories with ship date restrictions. Ship date restrictions returned.", "ElapsedTime": "192 ms" } } // Example 2: Sample when no restrictions exist { "Data": { "ShipDateRestricted": false, "ShipDateRange": {} }, "Result": { "Success": true, "Message": "The shopping cart items do not contain any category ship date restrictions. No ship date restrictions returned.", "ElapsedTime": "192 ms" } }	xml:string

Name

Description

Data Type

GetCategoryShipDateRestrictionsResult

A string value containing a JSON object.

// Example 1: Sample when restrictions exist 
{
    "Data": {
        "ShipDateRestricted": true,
        "ShipDateRange": {
            "MinimumShipDate": "08/26/2020",
            "MaximumShipDate": "10/31/2020"
        }
    },
    "Result": {
        "Success": true,
        "Message": "The shopping cart contains items that are in categories with ship date restrictions. Ship date restrictions returned.",
        "ElapsedTime": "192 ms"
    }
}

// Example 2: Sample when no restrictions exist
{
    "Data": {
        "ShipDateRestricted": false,
        "ShipDateRange": {}
    },
    "Result": {
        "Success": true,
        "Message": "The shopping cart items do not contain any category ship date restrictions. No ship date restrictions returned.",
        "ElapsedTime": "192 ms"
    }
}

xml:string