customer_order

Create Customer Order

Create a new customer order.

post/customer-orders

Request

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

Request body

orderNumberstring

Order number for the customer order. If blank, one will automatically be generated.

clientIdinteger

Id of the client that the customer order is for. Defaults to the user's client id.

clientNamestring

Name of the client that the customer order is for. Ignored if clientId is provided and is nonzero.

shipFromWarehouseIdinteger

Id of the warehouse the ordered items will be allocated from. If no warehouse parameters are given, then the user's current warehouse will be used.

shipFromWarehouseNamestring

Name of the warehouse the ordered items will be allocated from. Ignored if warehouseId is provided.

shipViastring

Code of the carrier or service to use for shipping.

shipViaPackagingstring

Code of the package type to use for shipping.

shipViaConfirmationstring

Code of the confirmation type to use for shipping.

postageAccount'sender' | 'client' | 'recipient'

Who to bill for shipping.

postageAccountNumberstring

If provided, attempts to associate the account number with the ship via carrier. Not needed if the account number is already on file.

orderReferencestring
projectNumberstring
internalNotestring
noteFromCustomerstring
noteToCustomerstring
notificationEmailstring
userField1string
userField2string
userField3string
myList1string
myList2string
buyerPaidShippingnumber
dryIceWeightnumber
packageSkustring
discountPercentagenumber

If not provided, the customer's default discount percentage will be used.

saveAsDraftboolean

True to save the customer order as a draft and finalize at a later time.

skipAutomationboolean

True to skip all automation rules.

Response

Success

idinteger
orderNumberstring
orderReferencestring
orderedDatestring date-time
createdDatestring date-time
modifiedDatestring date-time
orderPlacedboolean
completedboolean
completedDatestring date-time
cancelledboolean
cancelledDatestring date-time
cancelledReasonstring
onHoldboolean
onHoldUntilstring date-time
postageAccountstring
buyerPaidShippingnumber
shipViastring
shipViaPackagingstring
shipViaConfirmationstring
dryIceWeightnumber
packageSkustring
projectNumberstring
discountPercentagenumber
orderSourcestring
internalNotestring
noteFromCustomerstring
noteToCustomerstring
notificationEmailstring
userField1string
userField2string
userField3string
myList1string
myList2string

Example response

{
  "id": 10376,
  "customer": {
    "id": 6382,
    "name": "Anna",
    "surname": "Fuugo",
    "email": "email@address.com",
    "company": "Aconite",
    "accountNumber": "S01E07"
  },
  "client": {
    "id": 3,
    "name": "Hardware Store"
  },
  "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"
  },
  "cancelledBy": {
    "id": 1,
    "name": "Mr Sparks"
  },
  "postageAccount": "sender",
  "shippingAddress": {
    "id": 666,
    "company": "Aconite",
    "name": "Anna Fuugo",
    "line1": "123 Home Street",
    "city": "Phoenix",
    "state": "AZ",
    "country": "United States",
    "countryCode": "US",
    "phone": "555-555-5555",
    "verifiedStatus": "awaiting"
  },
  "billingAddress": {
    "id": 666,
    "company": "Aconite",
    "name": "Anna Fuugo",
    "line1": "123 Home Street",
    "city": "Phoenix",
    "state": "AZ",
    "country": "United States",
    "countryCode": "US",
    "phone": "555-555-5555",
    "verifiedStatus": "awaiting"
  },
  "shipVia": "fedex_ground",
  "shipViaConfirmation": "direct_signature",
  "shipFromWarehouse": {
    "id": 1,
    "name": "Main Warehouse"
  },
  "orderSource": "REST API",
  "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
    }
  ]
}

Changes

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