Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PushSalesOrder

Creates an order with all specified data, places it, and raises all follow-up events.

Whenever the order already exists with the same BackendSystemID/BackendID combination, nothing will be modified.

Hierarchy

  • PushSalesOrder

Index

Properties

Optional BackendID

BackendID: undefined | string

A unique identifier for the order, within the context of given BackendSystemID

Optional BackendSystemID

BackendSystemID: undefined | string

A code, free of choice for the calling 3rd party application creating the order

Optional BackfillInformation

Optional BillingAddress

BillingAddress: PushSalesOrderAddress

Optional Coupons

Optional CurrencyID

CurrencyID: undefined | string

ISO code of the currency of the order

Optional CustomData

CustomData: undefined | {}

Optional CustomFields

CustomFields: undefined | {}

Optional Customer

Optional Discounts

Optional FulfillmentMethod

FulfillmentMethod: OrderImportFulfillmentMethod

How this order is fulfilled, this can be overridden on line level. Default to Delivery or Pickup (when a PickupOrganizationUnit is defined)

Optional Lines

Optional Options

Optional Payments

Optional PickupAddress

PickupAddress: PushSalesOrderAddress

Optional PickupOrganizationUnitBackendID

PickupOrganizationUnitBackendID: undefined | string

Identifier for the shop where the order will be picked up, if any (OrganizationUnit.BackendID

Optional Properties

Optional Remark

Remark: undefined | string

Optional ReturnToSupplierReason

ReturnToSupplierReason: undefined | string

The reason for this ReturnToSupplier order, used in combination with Properties.ReturnToSupplier. Required for ReturnToSupplier orders

Optional ShipToOrganizationUnitBackendID

ShipToOrganizationUnitBackendID: undefined | string

Identifier for the shop where the order will be shipped to, if any (OrganizationUnit.BackendID

Optional Shipments

Optional ShippingAddress

ShippingAddress: PushSalesOrderAddress

Optional ShippingInformation

Optional SoldFromOrganizationUnitBackendID

SoldFromOrganizationUnitBackendID: undefined | string

Identifier for the (web)shop that made the sale (OrganizationUnit.BackendID)