Skip to main content

OrderPostageData

Shipping and delivery information.

Comprehensive shipping details including method, costs, carrier information, and delivery preferences.

IMPORTANT - tax semantics: in the Propeller API gross is the amount EXCLUDING tax and net is the amount INCLUDING tax (net = gross + tax). This is the REVERSE of common accounting usage, where gross means tax-inclusive. Do not map gross to a tax-inclusive field.

type OrderPostageData {
  method: String!
  taxPercentage: Float!
  requestDate: DateTime
  gross: Float!
  net: Float!
  tax: Float!
  partialDeliveryAllowed: YesNo
  pickUpLocationId: Int
  carrier: String
  overruled: YesNo
  warehouse: Warehouse
}

Fields

`OrderPostageData.method` ● `String!` non-null scalar

The chosen shipping method

`OrderPostageData.taxPercentage` ● `Float!` non-null scalar

The shipping costs tax percentage

`OrderPostageData.requestDate` ● `DateTime` scalar

The preferred delivery date for the Order

`OrderPostageData.gross` ● `Float!` non-null scalar

The shipping costs excluding tax

`OrderPostageData.net` ● `Float!` non-null scalar

The shipping costs including tax

`OrderPostageData.tax` ● `Float!` non-null scalar

The tax on the shipping costs

`OrderPostageData.partialDeliveryAllowed` ● `YesNo` enum

Is partial delivery allowed for this Order

`OrderPostageData.pickUpLocationId` ● `Int` scalar

ID of the pick up location when the Order's shipping method is PICKUP

`OrderPostageData.carrier` ● `String` scalar

The selected carrier for this Order

`OrderPostageData.overruled` ● `YesNo` enum

Whether the shipping costs for this order are overruled, if N, the shipping costs will be recalculated on every mutation

`OrderPostageData.warehouse` ● `Warehouse` object

Complete warehouse information for the order pickup location.

Detailed warehouse object including address, business hours, and contact information for the customer order pickup location.

Member Of

Order object

Fields
Member Of