Body Required

• adjustmentReasonId integer(int32) | null

  Adjustment reason

• adminNotes string | null

  Admin notes

• approved boolean Required

  Approved

  Default value is true.

• billingAddressLineOne string | null

  Billing address line one

• billingAddressLineTwo string | null

  Billing address line two

• billingAddressMessage string | null

  Billing address message

• billingCity string | null

  Billing city

• billingCountry string | null

  Billing country

• billingFirstName string | null

  Billing first name

• billingFullName object | null | array | boolean | integer | number | string

  Billing full name

  Any of:

  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
• billingLastName string | null

  Billing last name

• billingName string | null

  Billing name

• billingState string | null

  Billing state

• billingZip string | null

  Billing zip

• cancellationStatus string Required

  Cancellation status

  Values are none, partial, or full. Default value is none.

• cancelled boolean Required

  Cancelled

  Default value is false.

• cancelledAt string(date-time) | null

  Cancelled at

• cityTaxLocation string | null

  City tax location

• cityTaxRate number(float) | null

  City tax rate

• combinedTaxRate number(float) | null

  Combined tax rate

• countyTaxLocation string | null

  County tax location

• countyTaxRate number(float) | null

  County tax rate

• createdAt string(date-time)

  Created at

• customerReference string | null

  Customer reference

• dateOrdered string(date-time) Required

  Date ordered

  Default value is {} (empty).

• deliveryExpectedAt string(date-time) | null

  Delivery expected at

• discounts number Required

  Discounts

  Default value is 0.

• districtTaxRate number(float) | null

  District tax rate

• dropshipNotes string | null

  Dropship notes

• dropshipProviderAddressId integer(int32) | null

  Dropship provider address

• dropshipProviderId integer(int32) | null

  Dropship provider

• files object | null | array | boolean | integer | number | string

  Files

  Any of:

  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
• finalized boolean Required

  Finalized

  Default value is true.

• id integer(int32)

  Id

• intercomMessageId string | null

  Intercom message

• internalReference string | null

  Internal reference

• invalidBillingAddress string | null

  Invalid billing address

• invalidShippingAddress boolean | null Required

  Invalid shipping address

  Default value is false.

• inventoryStatus string Required

  Inventory status

  Values are notReceived, partiallyReceived, or received. Default value is notReceived.

• invoiceProblem object | null | array | boolean | integer | number | string

  Invoice problem

  Any of:

  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
• invoiceStatus string Required

  Invoice status

  Values are notInvoiced, partiallyInvoiced, or invoiced. Default value is notInvoiced.

• isDropship boolean Required

  Is dropship

• labelProblem object | null | array | boolean | integer | number | string

  Label problem

  Any of:

  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
• lastDropshipmentReference integer(int32) | null Required

  Last dropshipment reference

  Default value is 0.

• lastGoodsReceiptReference integer(int32) | null Required

  Last goods receipt reference

  Default value is 0.

• lastPurchaseInvoiceReference integer(int32) | null Required

  Last purchase invoice reference

  Default value is 0.

• locked boolean Required

  Locked

  Default value is false.

• muteError boolean | null Required

  Mute error

  Default value is false.

• notes string | null

  Notes

• orderProblem object | null | array | boolean | integer | number | string

  Order problem

  Any of:

  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
• orderSplitting string | null Required

  Order splitting

  Values are group, splitTag, splitQuantity, or externalLocationId. Default value is group.

• orderSplittingKey string | null

  Order splitting key

• pauseProblems object | null | array | boolean | integer | number | string

  Pause problems

  Any of:

  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
• paymentExpectedAt string(date-time) | null

  Payment expected at

• paymentStatus string Required

  Payment status

  Values are notPaid, partiallyPaid, or paid. Default value is notPaid.

• priceListId integer(int32) | null

  Price list

• purchaseId integer(int32) | null

  Purchase

• purchaseImportExternalId string | null

  Purchase import external

• purchaseStatusId integer(int32) | null

  Purchase status

• purchaseType string Required

  Purchase type

  Values are replenishment, dropship, automated_dropship, automated_replenishment, or adjusted_dropship. Default value is replenishment.

• quantity integer(int32) Required

  Quantity

  Default value is 0.

• receiverAddressLineOne string | null

  Receiver address line one

• receiverAddressLineTwo string | null

  Receiver address line two

• receiverCity string | null

  Receiver city

• receiverCountry string | null

  Receiver country

• receiverName string | null

  Receiver name

• receiverState string | null

  Receiver state

• receiverZip string | null

  Receiver zip

• reference string Required

  Reference

• reminderLastSent string(date-time) | null

  Reminder last sent

• reminderSent integer(int32) | null Required

  Reminder sent

  Default value is false.

• returnLabelProblem object | null | array | boolean | integer | number | string

  Return label problem

  Any of:

  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
• returnStatus string Required

  Return status

  Values are notReturned, partiallyReturned, or returned. Default value is notReturned.

• saleId integer(int32) | null

  Sale

• sendSource string | null

  Send source

  Values are manual or automatic.

• shipmentRouting string | null Required

  Shipment routing

  Values are customer, consolidated, or consolidatedInternational. Default value is customer.

• shippingAddressLineOne string | null

  Shipping address line one

• shippingAddressLineTwo string | null

  Shipping address line two

• shippingAddressMessage boolean | null Required

  Shipping address message

  Default value is false.

• shippingCity string | null

  Shipping city

• shippingCountry string | null

  Shipping country

• shippingExpectedAt string(date-time) | null

  Shipping expected at

• shippingFirstName string | null

  Shipping first name

• shippingFullName object | null | array | boolean | integer | number | string

  Shipping full name

  Any of:

  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
• shippingLastName string | null

  Shipping last name

• shippingName string | null

  Shipping name

• shippingRateError string | null

  Shipping rate error

  Values are value or weight.

• shippingState string | null

  Shipping state

• shippingZip string | null

  Shipping zip

• splitTag string | null

  Split tag

• stateTaxLocation string | null

  State tax location

• stateTaxRate number(float) | null

  State tax rate

• subtotal number Required

  Subtotal

  Default value is 0.

• tags array[string] | null

  Tags

• tax number Required

  Tax

  Default value is 0.

• taxCalculation string | null Required

  Tax calculation

  Values are default or custom. Default value is default.

• taxIncluded boolean Required

  Tax included

  Default value is false.

• taxShipping boolean | null Required

  Tax shipping

  Default value is true.

• total number Required

  Total

  Default value is 0.

• updatedAt string(date-time)

  Updated at

• userId integer(int32) | null

  User

• vendorEndpointFormat string | null

  Vendor endpoint format

  Values are json, xml, csv, text, email, website, or phone.

• vendorEndpointHeaders object | null | array | boolean | integer | number | string

  Vendor endpoint headers

  Any of:

  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
• vendorEndpointResponse string | null

  Vendor endpoint response

• vendorId integer(int32) | null

  Vendor

• vendorReceivedId string | null

  Vendor received

• vendorReceivedReference string | null

  Vendor received reference

• vendorReceivedStatus string | null Required

  Vendor received status

  Values are notSent, received, or error. Default value is notSent.

• vendorReceivedStatusReason string | null Required

  Vendor received status reason

  Values are sent, shipped, or cancelled. Default value is sent.

• vendorReference string | null

  Vendor reference

• warehouseId integer(int32) | null

  Warehouse

• weight number(float) | null Required

  Weight

  Default value is 0.