Skip to main content
ID
The id of the team member to assign the group to.
Who pays the carrier. Omit to bill the shipper.
Who the order is billed to.
String
Your own text, as on the customString1 filter.
String
Your own text, as on the customString2 filter.
String
Your own text, as on the customString3 filter.
Who placed the order. Defaults to the ship-to contact.
Customs details.
How the order reaches the customer.
The day the group must ship by.
String
Retry with the same key to get the first group back instead of creating another. 1 to 400 characters, unique per store. A retry returns that group without changing its order or items, and sets the shipping options it sends on it, so a retry after a rejected option finishes the create.
The items to ship, 1 to 250. Every price uses one currency.
The internal note and the note to the buyer.
Boolean
Whether to send tracking to the sales channel when the label is bought. Omit to use the store’s setting.
String
A second name for the order, such as the buyer’s own order name.
String
A note on the order.
String
The order’s number, such as a buyer’s PO number. Omit to get a generated #REDO number.
[String!]
Tags on the order itself. Unlike tags, these don’t need to exist in the store.
When the order was placed. Defaults to now.
When the order was paid. Defaults to orderedAt.
The parcels the group ships in. Omit to use the store’s default parcel.
String
The shipping service the customer asked for.
Boolean
Rate the destination as residential (true) or commercial (false). Omit to use the address’s classification.
Boolean
Whether to buy a return label with the label.
String
Where the order was sold, such as a marketplace name.
Boolean
Whether to request Saturday delivery.
The rate to buy the label with.
Where the order ships from. Defaults to the store’s ship-from location.
Where the order ships to.
What the customer paid for shipping. Defaults to zero.
Whether a signature is required on delivery.
Discounted rate classes the contents qualify for.
[String!]
Fulfillment group tag names, as on FulfillmentGroup.tags. Each must already exist in the store.
What the customer paid in tax. Defaults to zero.
What the customer paid in all. Defaults to the items, shipping and tax added up.