Discount Promo Code

(API Version v8)

Definition of the Promo Code Discount objects within the system.

What can you do with DiscountPromoCode?

DELETE Discount/PromoCode/{id}
Delete an instance of the DiscountPromoCode object.
GET Discount/PromoCode/
Retrieve all of the DiscountPromoCode objects.
GET Discount/PromoCode/Paged
Retrieve all of the DiscountPromoCode objects in a paged fashion.
GET Discount/PromoCode/Paged/Detail
Retrieve all of the DiscountPromoCode objects in a paged fashion with all object details.
GET Discount/PromoCode/{id}
Retrieve an instance of the DiscountPromoCode object by its ID.
GET Discount/PromoCode/{id}/Detail
Retrieve deep detail of the DiscountPromoCode object by its ID.
PATCH Discount/PromoCode/{id}
Update or Add the DiscountPromoCode object and optionally make changes to any child objects.
POST Discount/PromoCode/
Create a new instance of the DiscountPromoCode object.
PUT Discount/PromoCode/{id}
Update an existing instance of the DiscountPromoCode object.

Properties

Property Details

identity READ-ONLY	"identity": 7 Type: Number This is the unique numeric identifier for the DiscountPromoCode
ownerId READ-ONLY	"ownerId": 8 Type: Number Unique identifier for the associated Owner object.
ownerName READ-ONLY	"ownerName": "Sample Name" Type: String The name of the object associated with the ownerId property.
name	"name": "Christmas Promo" Type: String The name of the Promo Code.
promoDescription	"promoDescription": "10% off Set up fees - Christmas Promo" Type: String A description of the Promo Code.
discountStart	"discountStart": "2021-04-26T15:25:27.587Z" Type: Date The start date of the Promo. Date and time values are specified in the ISO 8601 format.
discountEnd	"discountEnd": "2021-04-26T15:25:27.587Z" Type: Date The end date of the Promo. Date and time values are specified in the ISO 8601 format.
isActive	"isActive": true Type: Boolean Identifies if the Promo Code is active or not.
isProrated	"isProrated": true Type: Boolean Identifies if the Promo Code supports proration.
isNegativeAllowed	"isNegativeAllowed": true Type: Boolean

Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call. Below you will find the child objects that can be updated as part of PATCH operations for the DiscountPromoCode object.

Standard PATCH objects:

discountPromoCodeCurrency - create, update, delete

DataFlow PATCH objects:

discountPromoCode - create, update, delete
discountPromoCodeCurrency - create, update, delete

End Points

DELETE	Discount/PromoCode/{id}
Delete an instance of the DiscountPromoCode object. Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system.
{id}	Unique identifier for the DiscountPromoCode object.
Delete an instance of the DiscountPromoCode object. DELETE Discount/PromoCode/{id} View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "type": "delete", "results": { "totalCount": 4, "items": [ { "identity": 1, "action": "deleted", "dtoTypeKey": "discountPromoCode" }, { "lhsId": 2, "rhsId": 2, "action": "detached", "dtoTypeKey": "sampleObjectConnector" }, { "foreignKeyIdentity": 2, "action": "deleted", "dtoTypeKey": "sampleObject" } ] } }

Retrieve all of the DiscountPromoCode objects.

GET Discount/PromoCode/

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 16,
            "ownerName": "Sample Text Data",
            "name": "Christmas Promo",
            "promoDescription": "10% off Set up fees - Christmas Promo",
            "discountStart": "2021-04-26T15:25:27.587Z",
            "discountEnd": "2021-04-26T15:25:27.587Z",
            "isActive": true,
            "isProrated": true,
            "isNegativeAllowed": true
        }
    ]
}

Retrieve all of the DiscountPromoCode objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints.

Retrieve all of the DiscountPromoCode objects in a paged fashion.

GET Discount/PromoCode/Paged

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 18,
                "ownerName": "Sample Text Data",
                "name": "Christmas Promo",
                "promoDescription": "10% off Set up fees - Christmas Promo",
                "discountStart": "2021-04-26T15:25:27.587Z",
                "discountEnd": "2021-04-26T15:25:27.587Z",
                "isActive": true,
                "isProrated": true,
                "isNegativeAllowed": true
            }
        ]
    }
}

Retrieve all of the DiscountPromoCode objects in a paged fashion with all object details. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.

Retrieve all of the DiscountPromoCode objects in a paged fashion with all object details.

GET Discount/PromoCode/Paged/Detail

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 8,
                "ownerName": "Sample Text Data",
                "name": "Christmas Promo",
                "promoDescription": "10% off Set up fees - Christmas Promo",
                "discountStart": "2021-04-26T15:25:27.587Z",
                "discountEnd": "2021-04-26T15:25:27.587Z",
                "isActive": true,
                "isProrated": true,
                "isNegativeAllowed": true,
                "details": {
                    "discountPromoCodeCurrencies": [
                        {
                            "identity": 57,
                            "discountPromoCodeId": 81,
                            "discountPromoCodeName": "Sample Text Data",
                            "currencyId": 22,
                            "currencyCode": "Sample Text Data",
                            "currencyName": "Sample Text Data",
                            "discountId": 42,
                            "isActive": true,
                            "details": {
                                "discountAmounts": [
                                    {
                                        "identity": 55,
                                        "discountId": 67,
                                        "discountTypeId": 86,
                                        "discountTypeName": "Sample Text Data",
                                        "frequency": 48,
                                        "frequencyTypeId": 11,
                                        "frequencyTypeName": "Sample Text Data",
                                        "amount": 79.27,
                                        "appliedOrder": 18
                                    }
                                ]
                            }
                        }
                    ]
                }
            }
        ]
    }
}

GET	Discount/PromoCode/{id}
Retrieve an instance of the DiscountPromoCode object by its ID.
{id}	Unique identifier for the DiscountPromoCode object.
Retrieve an instance of the DiscountPromoCode object by its ID. GET Discount/PromoCode/{id} View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "ownerId": 0, "ownerName": "Sample Text Data", "name": "Christmas Promo", "promoDescription": "10% off Set up fees - Christmas Promo", "discountStart": "2021-04-26T15:25:27.587Z", "discountEnd": "2021-04-26T15:25:27.587Z", "isActive": true, "isProrated": true, "isNegativeAllowed": true } }

GET	Discount/PromoCode/{id}/Detail
Retrieve deep detail of the DiscountPromoCode object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
{id}	Unique identifier for the DiscountPromoCode object.
Retrieve deep detail of the DiscountPromoCode object by its ID. GET Discount/PromoCode/{id}/Detail View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "ownerId": 3, "ownerName": "Sample Text Data", "name": "Christmas Promo", "promoDescription": "10% off Set up fees - Christmas Promo", "discountStart": "2021-04-26T15:25:27.587Z", "discountEnd": "2021-04-26T15:25:27.587Z", "isActive": true, "isProrated": true, "isNegativeAllowed": true, "details": { "discountPromoCodeCurrencies": [ { "identity": 57, "discountPromoCodeId": 81, "discountPromoCodeName": "Sample Text Data", "currencyId": 22, "currencyCode": "Sample Text Data", "currencyName": "Sample Text Data", "discountId": 42, "isActive": true, "details": { "discountAmounts": [ { "identity": 55, "discountId": 67, "discountTypeId": 86, "discountTypeName": "Sample Text Data", "frequency": 48, "frequencyTypeId": 11, "frequencyTypeName": "Sample Text Data", "amount": 79.27, "appliedOrder": 18 } ] } } ] } } }

PATCH	Discount/PromoCode/{id}
Update or Add the DiscountPromoCode object and optionally make changes to any child objects. Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array.
{id}	Unique identifier for the DiscountPromoCode object.
Update or Add the DiscountPromoCode object and optionally make changes to any child objects. PATCH Discount/PromoCode/{id} { "details": {}, "discountPromoCodes": { "items": [ { "patchType": "create", "patchClientId": 1, "name": "Christmas Promo", "promoDescription": "10% off Set up fees - Christmas Promo", "discountStart": "2021-04-26T15:25:27.587Z", "discountEnd": "2021-04-26T15:25:27.587Z", "isActive": true, "isProrated": true, "isNegativeAllowed": true } ] } } View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "type": "patch", "results": { "totalCount": 1, "items": [ { "identity": 1, "action": "created", "dtoTypeKey": "discountPromoCode", "instance": { "identity": 1, "ownerId": 15, "ownerName": "Sample Text Data", "name": "Christmas Promo", "promoDescription": "10% off Set up fees - Christmas Promo", "discountStart": "2021-04-26T15:25:27.587Z", "discountEnd": "2021-04-26T15:25:27.587Z", "isActive": true, "isProrated": true, "isNegativeAllowed": true } } ] } }

Create a new instance of the DiscountPromoCode object.

POST Discount/PromoCode/

{
    "name": "Christmas Promo",
    "promoDescription": "10% off Set up fees - Christmas Promo",
    "discountStart": "2021-04-26T15:25:27.587Z",
    "discountEnd": "2021-04-26T15:25:27.587Z",
    "isActive": true,
    "isProrated": true,
    "isNegativeAllowed": true
}

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 8,
                "ownerName": "Sample Text Data",
                "name": "Christmas Promo",
                "promoDescription": "10% off Set up fees - Christmas Promo",
                "discountStart": "2021-04-26T15:25:27.587Z",
                "discountEnd": "2021-04-26T15:25:27.587Z",
                "isActive": true,
                "isProrated": true,
                "isNegativeAllowed": true
            }
        ]
    }
}

Update an existing instance of the DiscountPromoCode object.

PUT Discount/PromoCode/{id}

{
    "identity": 1,
    "name": "Christmas Promo",
    "promoDescription": "10% off Set up fees - Christmas Promo",
    "discountStart": "2021-04-26T15:25:27.587Z",
    "discountEnd": "2021-04-26T15:25:27.587Z",
    "isActive": true,
    "isProrated": true,
    "isNegativeAllowed": true
}

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 25,
                "ownerName": "Sample Text Data",
                "name": "Christmas Promo",
                "promoDescription": "10% off Set up fees - Christmas Promo",
                "discountStart": "2021-04-26T15:25:27.587Z",
                "discountEnd": "2021-04-26T15:25:27.587Z",
                "isActive": true,
                "isProrated": true,
                "isNegativeAllowed": true
            }
        ]
    }
}