TAG LINE
TAG LINE
SMALL TITLE

Package / Currency

(API Version v6)


Represents a linking of the different currencies in which a Package can be sold.


What can you do with PackageCurrency?


Properties

Property Details
identity
READ-ONLY
"identity": 27
Type: Number
This is the unique numeric identifier for the PackageCurrency
packageId
"packageId": 10
Type: Number
Unique identifier for the associated Package object.
packageName
"packageName": "Sample Name"
Type: String
The name of the object associated with the packageId property.
currencyId
"currencyId": 26
Type: Number
Unique identifier for the associated Currency object.
currencyName
"currencyName": "Sample Name"
Type: String
The name of the object associated with the currencyId property.


End Points

GETPackage/Currency/
Retrieve all of the PackageCurrency objects.
Retrieve all of the PackageCurrency objects.
GET Package/Currency/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "packageId": 3,
            "packageName": "Sample Text Data",
            "currencyId": 23,
            "currencyName": "Sample Text Data"
        }
    ]
}
GETPackage/Currency/Paged
Retrieve all of the PackageCurrency 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 PackageCurrency objects in a paged fashion.
GET Package/Currency/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,
                "packageId": 12,
                "packageName": "Sample Text Data",
                "currencyId": 11,
                "currencyName": "Sample Text Data"
            }
        ]
    }
}
GETPackage/Currency/{id}
Retrieve an instance of the PackageCurrency object by its ID.
{id}Unique identifier for the PackageCurrency object.
Retrieve an instance of the PackageCurrency object by its ID.
GET Package/Currency/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "packageId": 24,
        "packageName": "Sample Text Data",
        "currencyId": 22,
        "currencyName": "Sample Text Data"
    }
}