Order Package

(API Version v3)

What can you do with OrderPackage?

GET api/v3/OrderPackage
GET api/v3/OrderPackage/Paged
GET api/v3/OrderPackage/Paged/Detail
GET api/v3/OrderPackage/{id:int}
GET api/v3/OrderPackage/{id:int}/Detail

Properties

Property Details

id	"id": 21 Type: Number This is the unique numeric identifier for the OrderPackage
ownerId	"ownerId": 13 Type: Number Unique identifier for the associated Owner object.
orderId	"orderId": 11 Type: Number Unique identifier for the associated Order object.
packageFrequencyId	"packageFrequencyId": 22 Type: Number Unique identifier for the associated PackageFrequency object.
quantity	"quantity": 9 Type: Number
effective	"effective": "2005-04-11T14:56:24" Type: Date
extensions	"extensions": "Hello World" Type: String

Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

quantity
effective
extensions

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 or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the OrderPackage object.

Standard PATCH objects:

orderService - create, update, delete

DataFlow PATCH objects:

orderPackage - create, update, delete
orderService - create, update, delete

End Points

GET	api/v3/OrderPackage
Retrieve all of the OrderPackage objects.

GET	api/v3/OrderPackage/Paged
Retreive all of the OrderPackage objects in a paged fashion.

GET	api/v3/OrderPackage/Paged/Detail
Retreive all of the OrderPackage objects in a paged fashion with all object details.

GET	api/v3/OrderPackage/{id:int}
Retrieve an instance of the OrderPackage object by it's ID.
{id:int}	Unique identifier for the OrderPackage object.

GET	api/v3/OrderPackage/{id:int}/Detail
Retreive all of the Detail objects for the specified OrderPackage.
{id:int}	Unique identifier for the OrderPackage object.