> ## Documentation Index
> Fetch the complete documentation index at: https://developers.redo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# FulfillmentGroupCreateInput

> A manual order to ship as a new fulfillment group.

**assigneeId** `ID`

The id of the team member to assign the group to.

**billing** `[ShipmentBillingInput](/docs/api-reference/v3/reference/shipping/shipment-billing-input)`

Who pays the carrier. Omit to bill the shipper.

**fields**

**account** `String`

The payer's carrier account number. Never returned.

**carrier** `String`

The carrier billed, for third-party or receiver billing.

**country** `String`

The payer's country, for third-party or receiver billing.

**postalCode** `String`

The payer's postal code, for third-party or receiver billing.

**type** `[ShipmentBillingType!](/docs/api-reference/v3/reference/shipping/shipment-billing-type)` *required*

Who pays.

**billingAddress** `[ShippingAddressInput](/docs/api-reference/v3/reference/shipping/shipping-address-input)`

Who the order is billed to.

**fields**

**address1** `String!` *required*

The first line of the address (street and number).

**address2** `String`

The second line of the address (apartment, suite, unit).

**city** `String`

The city, town, or village.

**company** `String`

The recipient's company.

**countryCode** `[CountryCode!](/docs/api-reference/v3/reference/common/country-code)` *required*

The country.

**email** `String`

The recipient's email address.

**name** `String!` *required*

The recipient's name.

**phone** `String`

The recipient's phone number.

**postalCode** `String`

The postal or ZIP code.

**provinceCode** `String`

The state or province code, e.g. CA.

**residential** `Boolean`

Whether the address is a residence. Omit when unknown.

**customString1** `String`

Your own text, as on the customString1 filter.

**customString2** `String`

Your own text, as on the customString2 filter.

**customString3** `String`

Your own text, as on the customString3 filter.

**customer** `[FulfillmentGroupCustomerInput](/docs/api-reference/v3/reference/shipping/fulfillment-group-customer-input)`

Who placed the order. Defaults to the ship-to contact.

**fields**

**email** `String`

The customer's email. Defaults to the ship-to email.

**name** `String`

The customer's name. Defaults to the ship-to name.

**customs** `[FulfillmentGroupCustomsInput](/docs/api-reference/v3/reference/shipping/fulfillment-group-customs-input)`

Customs details.

**fields**

**comments** `String`

Extra comments for customs.

**contentsExplanation** `String`

A description of the contents, when the type needs one.

**contentsType** `[CustomsContentsType](/docs/api-reference/v3/reference/shipping/customs-contents-type)`

What kind of contents the shipment holds.

**declarations** `[\[CustomsDeclarationInput!\]](/docs/api-reference/v3/reference/shipping/customs-declaration-input)`

The declared items, replacing the current ones.

**fields**

**countryOfOrigin** `[CountryCode!](/docs/api-reference/v3/reference/common/country-code)` *required*

Where the item was made.

**description** `String!` *required*

What the item is.

**hsCode** `String`

The Harmonized System tariff code.

**quantity** `Int!` *required*

Units declared.

**value** `[MoneyInput!](/docs/api-reference/v3/reference/common/money-input)` *required*

The declared value of one unit.

**weight** `[WeightInput!](/docs/api-reference/v3/reference/catalog/weight-input)` *required*

The weight of one unit.

**exportFiling** `[ExportFilingInput](/docs/api-reference/v3/reference/shipping/export-filing-input)`

The US export filing.

**fields**

**exemptionCode** `[AesExemptionCode](/docs/api-reference/v3/reference/shipping/aes-exemption-code)`

Why no export filing is needed.

**itn** `String`

The AES internal transaction number.

**incoterm** `[Incoterm](/docs/api-reference/v3/reference/shipping/incoterm)`

Who pays duties and import taxes. Null uses the store's setting.

**nonDeliveryOption** `[CustomsNonDeliveryOption](/docs/api-reference/v3/reference/shipping/customs-non-delivery-option)`

What happens to the shipment if it can't be delivered.

**deliveryMethod** `[DeliveryMethodKind](/docs/api-reference/v3/reference/shipping/delivery-method-kind)`

How the order reaches the customer.

**fulfillBy** `[Date](/docs/api-reference/v3/reference/common/date)`

The day the group must ship by.

**idempotencyKey** `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.

**items** `[\[FulfillmentGroupItemInput!\]!](/docs/api-reference/v3/reference/shipping/fulfillment-group-item-input)` *required*

The items to ship, 1 to 250. Every price uses one currency.

**fields**

**attributes** `[\[FulfillmentGroupItemAttributeInput!\]](/docs/api-reference/v3/reference/shipping/fulfillment-group-item-attribute-input)`

Details on the item, such as engraving text.

**fields**

**key** `String!` *required*

The detail's name.

**value** `String!` *required*

The detail's value.

**custom** `[FulfillmentGroupCustomItemInput](/docs/api-reference/v3/reference/shipping/fulfillment-group-custom-item-input)`

An item that isn't one of your products.

**fields**

**barcode** `String`

The barcode to scan when packing the item.

**countryOfOrigin** `[CountryCode](/docs/api-reference/v3/reference/common/country-code)`

Where the item was made, for customs.

**customsDescription** `String`

What the item is, for customs. Defaults to the title.

**hsCode** `String`

The item's Harmonized System code, for customs.

**imageUrl** `String`

A URL of the item's image.

**title** `String!` *required*

The item's name, as shown on the packing slip.

**variantTitle** `String`

The item's variant, such as a size or color.

**productId** `ID`

The id of one of your products.

**quantity** `Int!` *required*

How many units to ship, at least 1.

**unitPrice** `[MoneyInput](/docs/api-reference/v3/reference/common/money-input)`

What the customer paid for one unit. Defaults to the product's price; required for a custom item and for a product with no price.

**fields**

**amount** `[Decimal!](/docs/api-reference/v3/reference/common/decimal)` *required*

The amount as an exact decimal string (e.g. "19.99").

**currency** `String!` *required*

ISO 4217 currency code (e.g. USD).

**weight** `[WeightInput](/docs/api-reference/v3/reference/catalog/weight-input)`

The weight of one unit. Defaults to the product's weight, or zero for a custom item.

**fields**

**unit** `[WeightUnit!](/docs/api-reference/v3/reference/catalog/weight-unit)` *required*

The unit the value is expressed in.

**value** `Float!` *required*

The numeric magnitude of the weight.

**notes** `[FulfillmentGroupNotesInput](/docs/api-reference/v3/reference/shipping/fulfillment-group-notes-input)`

The internal note and the note to the buyer.

**fields**

**internal** `String`

A note for the warehouse that the customer never sees.

**toBuyer** `String`

A note printed for the customer, such as on the slip. Only while the group is open: it is printed by then, so a later change returns FULFILLMENT\_GROUP\_LOCKED.

**notifyMarketplace** `Boolean`

Whether to send tracking to the sales channel when the label is bought. Omit to use the store's setting.

**orderName** `String`

A second name for the order, such as the buyer's own order name.

**orderNote** `String`

A note on the order.

**orderNumber** `String`

The order's number, such as a buyer's PO number. Omit to get a generated #REDO number.

**orderTags** `[String!]`

Tags on the order itself. Unlike tags, these don't need to exist in the store.

**orderedAt** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

When the order was placed. Defaults to now.

**paidAt** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

When the order was paid. Defaults to orderedAt.

**parcels** `[\[FulfillmentGroupParcelInput!\]](/docs/api-reference/v3/reference/shipping/fulfillment-group-parcel-input)`

The parcels the group ships in. Omit to use the store's default parcel.

**fields**

**dimensions** `[FulfillmentGroupParcelDimensionsInput!](/docs/api-reference/v3/reference/shipping/fulfillment-group-parcel-dimensions-input)` *required*

The parcel's outside dimensions.

**fields**

**height** `Float!` *required*

The height.

**length** `Float!` *required*

The length.

**unit** `[DimensionUnit!](/docs/api-reference/v3/reference/catalog/dimension-unit)` *required*

The unit of all three.

**width** `Float!` *required*

The width.

**dryIceWeight** `[WeightInput](/docs/api-reference/v3/reference/catalog/weight-input)`

The weight of dry ice in the parcel.

**fields**

**unit** `[WeightUnit!](/docs/api-reference/v3/reference/catalog/weight-unit)` *required*

The unit the value is expressed in.

**value** `Float!` *required*

The numeric magnitude of the weight.

**hazmat** `[HazmatType](/docs/api-reference/v3/reference/shipping/hazmat-type)`

The dangerous goods class the parcel ships as.

**insurance** `[MoneyInput](/docs/api-reference/v3/reference/common/money-input)`

The amount to insure the parcel for, in the group's currency. Omit for none.

**fields**

**amount** `[Decimal!](/docs/api-reference/v3/reference/common/decimal)` *required*

The amount as an exact decimal string (e.g. "19.99").

**currency** `String!` *required*

ISO 4217 currency code (e.g. USD).

**name** `String`

The packaging's name.

**packagingWeight** `[WeightInput!](/docs/api-reference/v3/reference/catalog/weight-input)` *required*

The weight of the empty packaging.

**fields**

**unit** `[WeightUnit!](/docs/api-reference/v3/reference/catalog/weight-unit)` *required*

The unit the value is expressed in.

**value** `Float!` *required*

The numeric magnitude of the weight.

**totalWeight** `[WeightInput](/docs/api-reference/v3/reference/catalog/weight-input)`

The weight of the packed parcel. Omit to derive it from the items.

**fields**

**unit** `[WeightUnit!](/docs/api-reference/v3/reference/catalog/weight-unit)` *required*

The unit the value is expressed in.

**value** `Float!` *required*

The numeric magnitude of the weight.

**type** `[ParcelType!](/docs/api-reference/v3/reference/shipping/parcel-type)` *required*

The kind of packaging. CARRIER\_PACKAGE can't be set through the API.

**requestedShippingService** `String`

The shipping service the customer asked for.

**residentialOverride** `Boolean`

Rate the destination as residential (true) or commercial (false). Omit to use the address's classification.

**returnLabel** `Boolean`

Whether to buy a return label with the label.

**salesChannel** `String`

Where the order was sold, such as a marketplace name.

**saturdayDelivery** `Boolean`

Whether to request Saturday delivery.

**selectedRate** `[FulfillmentGroupSelectedRateInput](/docs/api-reference/v3/reference/shipping/fulfillment-group-selected-rate-input)`

The rate to buy the label with.

**fields**

**carrier** `String!` *required*

The carrier.

**carrierAccountId** `String`

The carrier account the rate is on, `carrierAccountId` on the group's rate quotes. Optional when exactly one account quotes this carrier and service; AMBIGUOUS\_RATE when several do, RATE\_NOT\_QUOTED when none does.

**service** `String!` *required*

The carrier service level.

**shipFrom** `[FulfillmentGroupShipFromInput](/docs/api-reference/v3/reference/shipping/fulfillment-group-ship-from-input)`

Where the order ships from. Defaults to the store's ship-from location.

**fields**

**address** `[ShippingAddressInput](/docs/api-reference/v3/reference/shipping/shipping-address-input)`

An address that isn't one of your locations.

**fields**

**address1** `String!` *required*

The first line of the address (street and number).

**address2** `String`

The second line of the address (apartment, suite, unit).

**city** `String`

The city, town, or village.

**company** `String`

The recipient's company.

**countryCode** `[CountryCode!](/docs/api-reference/v3/reference/common/country-code)` *required*

The country.

**email** `String`

The recipient's email address.

**name** `String!` *required*

The recipient's name.

**phone** `String`

The recipient's phone number.

**postalCode** `String`

The postal or ZIP code.

**provinceCode** `String`

The state or province code, e.g. CA.

**residential** `Boolean`

Whether the address is a residence. Omit when unknown.

**locationId** `ID`

The id of one of your locations, as on `Location.id`. It must have an address.

**shipTo** `[ShippingAddressInput!](/docs/api-reference/v3/reference/shipping/shipping-address-input)` *required*

Where the order ships to.

**fields**

**address1** `String!` *required*

The first line of the address (street and number).

**address2** `String`

The second line of the address (apartment, suite, unit).

**city** `String`

The city, town, or village.

**company** `String`

The recipient's company.

**countryCode** `[CountryCode!](/docs/api-reference/v3/reference/common/country-code)` *required*

The country.

**email** `String`

The recipient's email address.

**name** `String!` *required*

The recipient's name.

**phone** `String`

The recipient's phone number.

**postalCode** `String`

The postal or ZIP code.

**provinceCode** `String`

The state or province code, e.g. CA.

**residential** `Boolean`

Whether the address is a residence. Omit when unknown.

**shippingPaid** `[MoneyInput](/docs/api-reference/v3/reference/common/money-input)`

What the customer paid for shipping. Defaults to zero.

**fields**

**amount** `[Decimal!](/docs/api-reference/v3/reference/common/decimal)` *required*

The amount as an exact decimal string (e.g. "19.99").

**currency** `String!` *required*

ISO 4217 currency code (e.g. USD).

**signature** `[SignatureRequirement](/docs/api-reference/v3/reference/shipping/signature-requirement)`

Whether a signature is required on delivery.

**specialRates** `[\[SpecialRate!\]](/docs/api-reference/v3/reference/shipping/special-rate)`

Discounted rate classes the contents qualify for.

**tags** `[String!]`

Fulfillment group tag names, as on `FulfillmentGroup.tags`. Each must already exist in the store.

**taxPaid** `[MoneyInput](/docs/api-reference/v3/reference/common/money-input)`

What the customer paid in tax. Defaults to zero.

**fields**

**amount** `[Decimal!](/docs/api-reference/v3/reference/common/decimal)` *required*

The amount as an exact decimal string (e.g. "19.99").

**currency** `String!` *required*

ISO 4217 currency code (e.g. USD).

**totalPaid** `[MoneyInput](/docs/api-reference/v3/reference/common/money-input)`

What the customer paid in all. Defaults to the items, shipping and tax added up.

**fields**

**amount** `[Decimal!](/docs/api-reference/v3/reference/common/decimal)` *required*

The amount as an exact decimal string (e.g. "19.99").

**currency** `String!` *required*

ISO 4217 currency code (e.g. USD).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.