Skip to main content

OrderInput

No description

input OrderInput {
  businessSlug: String!
  facilitySlug: String!
  orderNumber: String
  direction: OrderDirection!
  orderType: String
  purchaseOrder: String
  requestedShipDate: String
  requestedDeliveryDate: String
  shipperName: String
  shipperAddress: AddressInput
  shipperEmail: String
  consigneeName: String
  consigneePhoneNumber: String
  carrier: String
  carrierService: String
  bolNumber: String
  sealNumber: String
  items: [OrderItemInput!]!
  shipmentId: Int
  expectedQuantity: Int
  appendItems: Boolean
  isASN: Boolean
}

Fields​

OrderInput.businessSlug ● String! non-null scalar​

OrderInput.facilitySlug ● String! non-null scalar​

OrderInput.orderNumber ● String scalar​

The unique identifier for this Order. It can be provided and used by customer to identify the specific order. This orderNumber is usually the same as customer's internal order number.

OrderInput.direction ● OrderDirection! non-null enum​

OrderInput.orderType ● String scalar​

OrderInput.purchaseOrder ● String scalar​

OrderInput.requestedShipDate ● String scalar​

OrderInput.requestedDeliveryDate ● String scalar​

OrderInput.shipperName ● String scalar​

OrderInput.shipperAddress ● AddressInput input​

OrderInput.shipperEmail ● String scalar​

OrderInput.consigneeName ● String scalar​

OrderInput.consigneePhoneNumber ● String scalar​

OrderInput.carrier ● String scalar​

OrderInput.carrierService ● String scalar​

OrderInput.bolNumber ● String scalar​

OrderInput.sealNumber ● String scalar​

OrderInput.items ● [OrderItemInput!]! non-null input​

OrderInput.shipmentId ● Int scalar​

OrderInput.expectedQuantity ● Int scalar​

OrderInput.appendItems ● Boolean scalar​

If true, this mutation will append items to an existing order. This is similar to the AddItemsToOrder mutation, but not equivalent. There are three key differences:

  • It will overwrite any of the order's fields that are provided
  • This mutation match to an order based on orderNumber
  • This mutation will create an order if one does not exist

OrderInput.isASN ● Boolean scalar​

If true, indicates this order object has been created from an ASN.

Member Of​

createOrder mutation ● createOrUpdateOrder mutation