Response [200 Ok]

Uri /api/v2/cart!applycoupon
UriDescription Apply Coupon
EndpointType ApplyCoupon

Timing

Total

cycles 1
objects 0
time 0.01386

Request

Uri /api/v2/cart!applycoupon
Method GET
Version v2

Config

{
    "expand_method": "ref",
    "shorturis": false
}

Options

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

POST

Permissions
  • Read

DELETE

Permissions
  • Read

Parameters

POST

a valid coupon apiv2 uri
OR a valid coupon code

DELETE

A valid coupon code

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/cart!applycoupon"
    },
    "Options": {
        "MethodDetails": {
            "OPTIONS": {
                "Permissions": [
                    "Read"
                ]
            },
            "GET": {
                "Permissions": [
                    "Read"
                ]
            },
            "POST": {
                "Permissions": [
                    "Read"
                ]
            },
            "DELETE": {
                "Permissions": [
                    "Read"
                ]
            }
        },
        "Methods": [
            "OPTIONS",
            "GET",
            "POST",
            "DELETE"
        ],
        "ParameterDescription": {
            "Uri": "Absolute or relative URL, restricted to Locator(s) of the supplied URL if not null.   Up to a MAX_LENGTH in length.",
            "Varchar": "Variable length text from MIN_CHARS to MAX_CHARS (MAX_CHARS = INFINITY meaning arbitrary length)"
        },
        "Parameters": {
            "POST": [
                {
                    "Name": "Coupon",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": null,
                    "Description": "a valid coupon apiv2 uri",
                    "Type": "Uri",
                    "MAX_LENGTH": "INFINITY",
                    "Locator": [
                        "UserCoupon"
                    ]
                },
                {
                    "Name": "CouponCode",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": null,
                    "Description": "OR a valid coupon code",
                    "Type": "Varchar",
                    "MIN_CHARS": 0,
                    "MAX_CHARS": 20
                }
            ],
            "DELETE": [
                {
                    "Name": "CouponCode",
                    "Required": true,
                    "ReadOnly": false,
                    "Default": null,
                    "Description": "A valid coupon code",
                    "Type": "Varchar",
                    "MIN_CHARS": 0,
                    "MAX_CHARS": 20
                }
            ]
        },
        "MediaTypes": [
            "application/json",
            "application/vnd.php.serialized",
            "application/x-msgpack",
            "text/html",
            "text/csv"
        ]
    },
    "Response": {
        "Uri": "/api/v2/cart!applycoupon",
        "UriDescription": "Apply Coupon",
        "EndpointType": "ApplyCoupon",
        "Timing": {
            "Total": {
                "time": 0.01386,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}