Skip to main content

CreatePendingOrderInput

Autogenerated input type of CreatePendingOrder

input CreatePendingOrderInput {
b2bData: V2OrderB2BDataInput
billToAddress: AddressInput
billToCompany: String
billToEmail: String
billToName: String
billToPhone: String
brandId: ID @deprecated
clientMutationId: String
customerId: ID
endShippingDate: ISO8601Date
expectedDeliveryDate: ISO8601Date
expectedShipDate: ISO8601Date
financialStatus: String
giftMessage: String
orderItems: [OrderItemInput!]
orderMetadata: JSON
orderNotes: [NoteInput!]
orderNumber: String
orderTags: [String!]
originOrderId: String
originalCarrierService: String
requestedCarrierServiceId: ID
requestedCarrierServiceName: String
responsibleId: ID
routingStrategy: [String!]
salesChannelId: ID
selectedCarrierId: ID
selectedCarrierServiceId: ID
shipToCompany: String
shipToEmail: String
shipToName: String
shipToPhone: String
shipToSameAsBillTo: Boolean
shippingAddress: AddressInput
shippingCarrierService: String
shippingCost: Decimal
sourceIntegrationId: ID
startShippingDate: ISO8601Date
totalTax: Decimal
}

Fields​

CreatePendingOrderInput.b2bData ● V2OrderB2BDataInput input orders​

B2B data for the order.

CreatePendingOrderInput.billToAddress ● AddressInput input common​

The address where the bill will be sent to.

CreatePendingOrderInput.billToCompany ● String scalar common​

The company of the person who will receive the bill.

CreatePendingOrderInput.billToEmail ● String scalar common​

The email of the person who will receive the bill.

CreatePendingOrderInput.billToName ● String scalar common​

The name of the person who will receive the bill.

CreatePendingOrderInput.billToPhone ● String scalar common​

The phone of the person who will receive the bill.

CreatePendingOrderInput.brandId ● ID deprecated scalar common​

DEPRECATED

This argument will be removed in the future. Brand is becoming a product-only attribute. Use company context instead.

The brand ID. This parameter is optional, but if not provided, you should provide the header 'X-Brand-Id' with the brand ID.

CreatePendingOrderInput.clientMutationId ● String scalar common​

A unique identifier for the client performing the mutation.

CreatePendingOrderInput.customerId ● ID scalar common​

The customer ID to associate with the order.

CreatePendingOrderInput.endShippingDate ● ISO8601Date scalar common​

End of the requested shipping window.

CreatePendingOrderInput.expectedDeliveryDate ● ISO8601Date scalar common​

The expected delivery date for the order.

CreatePendingOrderInput.expectedShipDate ● ISO8601Date scalar common​

The expected ship date for the order.

CreatePendingOrderInput.financialStatus ● String scalar common​

The financial status of the order. Defaults to pending.

CreatePendingOrderInput.giftMessage ● String scalar common​

A gift message for the order.

CreatePendingOrderInput.orderItems ● [OrderItemInput!] list input orders​

The items that are part of the order.

CreatePendingOrderInput.orderMetadata ● JSON scalar common​

The metadata that is part of the order. This metadata can be used to store additional information about the order.

CreatePendingOrderInput.orderNotes ● [NoteInput!] list input common​

The notes that are part of the order.

CreatePendingOrderInput.orderNumber ● String scalar common​

The order number. This order number must be unique in the brand context. If not provided, the system will generate a unique order number.

CreatePendingOrderInput.orderTags ● [String!] list scalar common​

The tags that are part of the order.

CreatePendingOrderInput.originOrderId ● String scalar common​

The order id from the external system. Optional, but if provided must be unique within the company context.

CreatePendingOrderInput.originalCarrierService ● String scalar common​

The original carrier service name.

CreatePendingOrderInput.requestedCarrierServiceId ● ID scalar common​

The requested carrier service ID.

CreatePendingOrderInput.requestedCarrierServiceName ● String scalar common​

The requested carrier service name.

CreatePendingOrderInput.responsibleId ● ID scalar common​

The responsible ID for the order. This parameter is optional, but if provided, it should be a party id and the party must be a person.

CreatePendingOrderInput.routingStrategy ● [String!] list scalar common​

The routing strategy for order fulfillment.

CreatePendingOrderInput.salesChannelId ● ID scalar common​

The sales channel ID for the order. If not provided, the system may use a default channel.

CreatePendingOrderInput.selectedCarrierId ● ID scalar common​

The selected carrier ID for shipping.

CreatePendingOrderInput.selectedCarrierServiceId ● ID scalar common​

The selected carrier service ID for shipping.

CreatePendingOrderInput.shipToCompany ● String scalar common​

The company of the person who will receive the order.

CreatePendingOrderInput.shipToEmail ● String scalar common​

The email of the person who will receive the order.

CreatePendingOrderInput.shipToName ● String scalar common​

The name of the person who will receive the order.

CreatePendingOrderInput.shipToPhone ● String scalar common​

The phone of the person who will receive the order.

CreatePendingOrderInput.shipToSameAsBillTo ● Boolean scalar common​

Indicates if the bill to address is the same as the ship to address.

CreatePendingOrderInput.shippingAddress ● AddressInput input common​

The address where the order will be shipped to.

CreatePendingOrderInput.shippingCarrierService ● String scalar common​

The shipping carrier service name.

CreatePendingOrderInput.shippingCost ● Decimal scalar common​

The shipping cost for the order.

CreatePendingOrderInput.sourceIntegrationId ● ID scalar common​

The integration party id that originated this order. Required for orders attributed to upstream custom integrations so that the source can manage updates and prevent conflicting edits in Endless.

CreatePendingOrderInput.startShippingDate ● ISO8601Date scalar common​

Start of the requested shipping window.

CreatePendingOrderInput.totalTax ● Decimal scalar common​

The total tax amount for the order.

Member Of​

createPendingOrder mutation