TAG LINE
SMALL TITLE

Order

(API Version v3)


What can you do with Order?


Properties

Property Details
id
"id": 25
Type: Number
This is the unique numeric identifier for the Order
ownerId
"ownerId": 8
Type: Number
Unique identifier for the associated Owner object.
accountId
"accountId": 20
Type: Number
Unique identifier for the associated Account object.
contactId
"contactId": 19
Type: Number
Unique identifier for the associated Contact object.
invoiceId
"invoiceId": 14
Type: Number
Unique identifier for the associated Invoice object.
orderStatusTypeId
"orderStatusTypeId": 1
Type: Number
Unique identifier for the associated OrderStatusType object.
companyName
"companyName": "Hello World"
Type: String
externalIdentifier
"externalIdentifier": "Hello World"
Type: String
completed
"completed": "2005-04-11T14:56:24"
Type: Date
purchaseOrderNumber
"purchaseOrderNumber": "Hello World"
Type: String
totalAmountEstimate
"totalAmountEstimate": "Hello World"
Type: String
preAuthTransactionIdentifier
"preAuthTransactionIdentifier": "Hello World"
Type: String
created
"created": "2005-04-11T14:56:24"
Type: Date
createdByUserId
"createdByUserId": 24
Type: Number
Unique identifier for the associated User object.
statusUpdated
"statusUpdated": "2005-04-11T14:56:24"
Type: Date


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:

  • contactId
  • companyName
  • externalIdentifier
  • purchaseOrderNumber
  • totalAmountEstimate
  • preAuthTransactionIdentifier

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 Order object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEapi/v3/Order/{id:int}
Delete an instance of the Order object.
GETapi/v3/Order
Retrieve all of the Order objects.
GETapi/v3/Order/Paged
Retreive all of the Order objects in a paged fashion.
GETapi/v3/Order/Paged/Detail
Retreive all of the Order objects in a paged fashion with all object details.
GETapi/v3/Order/{id:int}
Retrieve an instance of the Order object by it's ID.
{id:int}Unique identifier for the Order object.
GETapi/v3/Order/{id:int}/Detail
Retreive all of the Detail objects for the specified Order.
{id:int}Unique identifier for the Order object.
PATCHapi/v3/Order/{id:int}
Update the Order object and optionally make changes to any child objects.
POSTapi/v3/Order
Create a new instance of the Order object.
PUTapi/v3/Order/{id:int}
Update an existing instance of the Order object.
UNKNOWNapi/v3/Order/Process