Response [200 Ok]

Uri /api/v2/cart!coupons
UriDescription List Cart Coupons
EndpointType CartCoupons
Locator CartCoupon
LocatorType Objects

Timing

Total

cycles 1
objects 0
time 0.02643

Request

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

Config

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

Options

Notes

  • _multiargs does not work at this endpoint

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

Parameters

GET

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/cart!coupons"
    },
    "Options": {
        "MethodDetails": {
            "OPTIONS": {
                "Permissions": [
                    "Read"
                ]
            },
            "GET": {
                "Permissions": [
                    "Read"
                ]
            }
        },
        "Methods": [
            "OPTIONS",
            "GET"
        ],
        "ParameterDescription": {
            "Select": "Select one option. Options should pass only the \"Value\"."
        },
        "Parameters": {
            "GET": [
                {
                    "Name": "Currency",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": null,
                    "Type": "Select",
                    "OPTIONS": [
                        "USD",
                        "CAD",
                        "GBP",
                        "EUR",
                        "AUD",
                        "JPY",
                        "CHF",
                        "NZD",
                        "SEK",
                        "HKD"
                    ],
                    "MIN_COUNT": 1,
                    "MAX_COUNT": 1
                }
            ]
        },
        "MediaTypes": [
            "application/json",
            "application/vnd.php.serialized",
            "application/x-msgpack",
            "text/html",
            "text/csv"
        ],
        "Notes": [
            "_multiargs does not work at this endpoint"
        ]
    },
    "Response": {
        "Uri": "/api/v2/cart!coupons",
        "Locator": "CartCoupon",
        "LocatorType": "Objects",
        "UriDescription": "List Cart Coupons",
        "EndpointType": "CartCoupons",
        "Timing": {
            "Total": {
                "time": 0.02643,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}