Orders

Get Orders By Key

GET /order

Query Parameters

Key	Required	Description
`field`	true	Field to query (i.e, `vin`)
`value`	true	Value to search for.

Queryable Fields

Key
`coachId`
`vin`

Sample Request

GET /order?field=vin&value=WDAPF1049593100

Sample Response

HTTP 200 OK

{
  "success": true,
  "error": "",
  "result": {
    "orderId": 00000,
    "orderRev": 00,
    "orderStatus": "Open",
    "orderDate": "YYYY-MM-DDTHH:mm:ss.sssZ",
    "dealerId": 00000,
    "dealerName": "",
    "shipToId": 00,
    "shipToName": "",
    "purchaseOrder": "",
    "coachId": "null",
    "vin": "null",
    "action": "",
    "extension": {
      "guid": "",
      "approverEmail": "",
      "approverName": "",
      "coordinatorEmail": "",
      "coordinatorName": "",
      "salesPersonEmail": "",
      "salesPersonName": "",
      "customerEmail": "",
      "customerFirstName": "",
      "customerLastName": null,
      "requestedShipDate": "YYYY-MM-DDTHH:mm:ss.sssZ",
      "note": "",
      "customRequest": "",
      "showName": "",
      "requestId": "",
      "signStatus": "",
      "signatureId": ""
    },
    "options": [
      {
        "item": "",
        "name": "",
        "description": "",
        "price": 0,
        "msrp": 0
      }
    ],
    "properties": [
      {
        "name": "Cabinetry",
        "value": "Cashmere"
      }
    ]
  }
}

Get a Single Order

GET /order/{orderId}

URL Parameters

Key	Required	Description
`orderId`	true	A valid sales order ID.

Sample Response

HTTP 200 OK

{
  "success": true,
  "error": "",
  "result": {
    "orderId": 00000,
    "orderRev": 00,
    "orderStatus": "Open",
    "orderDate": "YYYY-MM-DDTHH:mm:ss.sssZ",
    "dealerId": 00000,
    "dealerName": "",
    "shipToId": 00,
    "shipToName": "",
    "purchaseOrder": "",
    "coachId": "null",
    "vin": "null",
    "action": "",
    "extension": {
      "guid": "",
      "approverEmail": "",
      "approverName": "",
      "coordinatorEmail": "",
      "coordinatorName": "",
      "salesPersonEmail": "",
      "salesPersonName": "",
      "customerEmail": "",
      "customerFirstName": "",
      "customerLastName": null,
      "requestedShipDate": "YYYY-MM-DDTHH:mm:ss.sssZ",
      "note": "",
      "customRequest": "",
      "showName": "",
      "requestId": "",
      "signStatus": "",
      "signatureId": ""
    },
    "options": [
      {
        "item": "",
        "name": "",
        "description": "",
        "price": 0,
        "msrp": 0
      }
    ],
    "properties": [
      {
        "name": "Cabinetry",
        "value": "Cashmere"
      }
    ]
  }
}

Get All Orders by Dealer

GET /order/dealer/{dealerId}

Returns a list of order header information.

URL Parameters

Key	Required	Description
`dealerId`	true	A valid dealer ID.

Possible Order Status:

Status	Description
Started	Order is submitted.
Awaiting Approval	Order submitted with custom requests.
Open	Order has been opened in M2M.
Closed	Order has been built.
Cancelled	Not implemented.

Possible Sign Status:

Status	Description
Unsigned	Order is submitted.
Out for signature	Order submitted with custom requests.
Signed	Order has been opened in M2M.

Sample Response

HTTP 200 OK

{
  "success": true,
  "error": "",
  "result": [
    {
      "orderId": 00000,
      "orderStatus": "",
      "orderDate": "",
      "purchaseOrder": "",
      "modelYear": "",
      "model": "",
      "customerName": "",
      "signStatus": ""
    }
  ]
}

Get Unsigned Orders

GET /order/unsigned

Returns a list of orders that have a signStatus of Unsigned or Out for signature.

Sample Response

HTTP 200 OK

{
  "success": true,
  "error": "",
  "result": [
    {
      "orderId": 00000,
      "orderStatus": "",
      "orderDate": "YYYY-MM-DDTHH:mm:ss.sssZ",
      "dealerId": 00000,
      "dealerName": "",
      "purchaseOrder": "",
      "modelYear": "",
      "model": "",
      "customerFirstName": "",
      "customerLastName": "",
      "customRequest": "",
      "signStatus": ""
    },
  ]
}

Create an Order

POST /order

Sample Request

{
  "orderDate": "YYYY-MM-DDTHH:mm:ss.sssZ",
  "dealerId": 00000,
  "shipToId": 0,
  "purchaseOrder": "",
  "requestedShipDate": "",
  "showName": "",
  "extension": {
    "approverName": "",
    "approverEmail": "",
    "salespersonEmail": "",
    "salespersonName": "",
    "customerFirstName": "",
    "customerLastName": "",
    "customRequest": "",
  },
  "options": [
    {
      "name": "",
      "description": "",
    }
  ],
  "properties": [
    {
      "name": "",
      "value": ""
    }
  ]
}

Sample Response

HTTP 201 Created

{
  "success": true,
  "error": "",
  "result": {
    "orderId": 00000,
    "orderRev": 00,
    "orderStatus": "Open",
    "orderDate": "YYYY-MM-DDTHH:mm:ss.sssZ",
    "dealerId": 00000,
    "dealerName": "",
    "shipToId": 00,
    "shipToName": "",
    "purchaseOrder": "",
    "coachId": "null",
    "vin": "null",
    "action": "Post",
    "extension": {
      "guid": "",
      "approverEmail": "",
      "approverName": "",
      "coordinatorEmail": "",
      "coordinatorName": "",
      "salesPersonEmail": "",
      "salesPersonName": "",
      "customerEmail": "",
      "customerFirstName": "",
      "customerLastName": null,
      "requestedShipDate": "YYYY-MM-DDTHH:mm:ss.sssZ",
      "note": "",
      "customRequest": "",
      "showName": "",
      "requestId": "",
      "signStatus": "",
      "signatureId": ""
    },
    "options": [
      {
        "item": "",
        "name": "",
        "description": "",
        "price": 0,
        "msrp": 0
      }
    ],
    "properties": [
      {
        "name": "Cabinetry",
        "value": "Cashmere"
      }
    ]
  }
}

Update an Order

PUT /order/{orderId}

URL Parameters

Key	Required	Description
`orderId`	true	A valid sales order ID.

Sample Request

Sample Response

HTTP 201 Created