customer_order

List Customer Orders

Get a list of customer orders based on search parameters.

get/customer-orders

Request

Base URL: https://app.allocadence.com/rest
URL: https://app.allocadence.com/rest/customer-orders
Auth: none declared

Query parameters

openboolean

True to filter for open customer orders.

completedboolean

True to filter for completed customer orders.

draftboolean

True to filter for draft customer orders.

cancelledboolean

True to filter for cancelled customer orders.

includePickedItemMetadataboolean

True to include the lot numbers, expiration dates, and serial numbers picked for the line items in the additional fields.

...string

Additional query parameters are available from the Customer Order Advanced Filter section. These can be used in conjunction with the above parameters.

Response

Success

Example response

{
  "customerOrders": [
    {
      "id": 10376,
      "orderNumber": "101156",
      "orderReference": "",
      "customer": {
        "id": 6382,
        "title": "",
        "name": "Anna",
        "surname": "Fuugo",
        "email": "email@address.com",
        "company": "Aconite",
        "accountNumber": "S01E07"
      },
      "client": null,
      "orderedDate": "2022-09-20T11:31:01-07:00",
      "createdDate": "2022-09-20T11:31:01-07:00",
      "modifiedDate": "2022-09-20T11:31:01-07:00",
      "orderPlaced": true,
      "createdBy": {
        "id": 1,
        "name": "Mr Sparks"
      },
      "completed": false,
      "completedDate": "",
      "cancelled": false,
      "cancelledDate": "",
      "cancelledReason": "",
      "cancelledBy": null,
      "onHold": false,
      "onHoldUntil": "",
      "postageAccount": "sender",
      "buyerPaidShipping": 0,
      "shippingAddress": {
        "id": 666,
        "company": "Aconite",
        "name": "Anna Fuugo",
        "line1": "123 Home Street",
        "line2": "",
        "line3": "",
        "city": "Phoenix",
        "state": "AZ",
        "zip": "85013",
        "country": "United States",
        "countryCode": "US",
        "phone": "555-555-5555",
        "code": "anna-test",
        "verifiedStatus": "awaiting",
        "verifiedDate": "",
        "verifiedMessage": ""
      },
      "billingAddress": {
        "id": 666,
        "company": "Aconite",
        "name": "Anna Fuugo",
        "line1": "123 Home Street",
        "line2": "",
        "line3": "",
        "city": "Phoenix",
        "state": "AZ",
        "zip": "85013",
        "country": "United States",
        "countryCode": "US",
        "phone": "555-555-5555",
        "code": "anna-test",
        "verifiedStatus": "awaiting",
        "verifiedDate": "",
        "verifiedMessage": ""
      },
      "shipVia": "fedex_ground",
      "shipViaPackaging": "",
      "shipViaConfirmation": "direct_signature",
      "dryIceWeight": 0,
      "packageSku": "",
      "shipFromWarehouse": {
        "id": 1,
        "name": "Main Warehouse"
      },
      "projectNumber": "",
      "discountPercentage": 0,
      "orderSource": "REST API",
      "internalNote": "",
      "noteFromCustomer": "",
      "noteToCustomer": "",
      "notificationEmail": "",
      "userField1": "",
      "userField2": "",
      "userField3": "",
      "myList1": "",
      "myList2": "",
      "tags": [
        {
          "id": 1,
          "tag": "Expedite",
          "note": "Expedite this order."
        }
      ],
      "items": [
        {
          "id": 13664,
          "itemId": 2306,
          "sku": "FumoFumo-002",
          "description": "Marisa Kirisame",
          "orderQuantity": 5,
          "uom": "Each",
          "quantity": 5,
          "allocatedQuantity": 0,
          "pickedQuantity": 0,
          "price": 50,
          "discountPercentage": 0,
          "partOfKit": false,
          "componentOf": 0,
          "additionalFields": null
        },
        {
          "id": 13665,
          "itemId": 2330,
          "sku": "FumoFumo-006",
          "description": "Alice Margatroid",
          "orderQuantity": 1,
          "uom": "Case",
          "quantity": 6,
          "allocatedQuantity": 0,
          "pickedQuantity": 0,
          "price": 50,
          "discountPercentage": 0,
          "partOfKit": false,
          "componentOf": 0,
          "additionalFields": null
        }
      ]
    },
    "..."
  ],
  "meta": {
    "count": 70,
    "page": 1,
    "perPage": 20,
    "totalPages": 4
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.