shippingProduct
Find a single shipping product.
Arguments
idIDSearch by primary key.
Returns
cursorString!A unique cursor that can be used for pagination.
createdAtDateTimeTz!When the shipping product base was created.
idID!Unique primary key.
listPricePriceList price for this base
The shipping product size
updatedAtDateTimeTz!When the shipping product base was last updated.
The shipping product zone
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
cursorString!A unique cursor that can be used for pagination.
appliedPrices[AppliedPrice!]!Prices billing applies to this client on a date for the rules and tiers of a fulfillment service and/or the bases and options of a shipping product.
billingChargesBillingChargeConnection!Billing charges prepared for this client.
contactsClientContactConnection!Contacts for this tenant–client relationship. Contact roles do not grant application access.
features[OrganizationFeature!]!The features associated with this client.
DEMOSUPPORT_AUTOMATIONSUPPORT_TICKETSfulfillmentServicesFulfillmentServiceConnection!List fulfillment services provided by tenant
fulfillmentsInvoiceLineBillableFulfillmentConnection!Shipped fulfillments of the client in a warehouse of the tenant.
goodsReceiptsInvoiceLineBillableGoodsReceiptConnection!Completed goods receipts of the client in a warehouse of the tenant.
idID!Unique primary key.
invoiceContactsInvoiceContactConnection!Invoice contacts of the client.
invoicesInvoiceConnection!Invoices issued for this client.
nameString!Name of the client
Orders of the client.
priceListsPriceListConnection!Price lists attached to this client
returnReceiptsInvoiceLineBillableReturnReceiptConnection!Completed return receipts of the client in a warehouse of the tenant.
Shipped shipments of the client, to find the resource a support ticket is about.
shippingProductsTenantShippingProductConnection!List shipping products provided by tenant
usersUserConnection!Users with active access to the client organization.
warehousesWarehouseConnection!List warehouses provided by tenant
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
cursorString!A unique cursor that can be used for pagination.
fromCountryCodeString!From country code of the tenant shipping product country.
toCountryCodeString!To country code of the tenant shipping product country.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
createdAtDateTimeTz!When the shipping product was created.
cursorString!A unique cursor that can be used for pagination.
createdAtDateTimeTz!When the shipping product fuel surcharge was created.
idID!Unique primary key.
invoiceLineAggregationModeCarrierInvoiceLineAggregationMode!Invoice line aggregation mode of the shipping product fuel surcharge.
AVERAGE_AMOUNTGROUP_BY_AMOUNTTOTAL_AMOUNTledgerLedgerLedger of the shipping product fuel surcharge.
nameStringName of the shipping product fuel surcharge.
percentageFloat!Percentage of the shipping product fuel surcharge.
periodEndAtDate!End of the billing period.
periodStartAtDate!Start of the billing period.
shippingProductTenantShippingProduct!Shipping product of the shipping product fuel surcharge.
updatedAtDateTimeTz!When the shipping product fuel surcharge was last updated.
vatProfileVatProfileVAT profile of the shipping product fuel surcharge.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
idID!Unique primary key.
cursorString!A unique cursor that can be used for pagination.
createdAtDateTimeTz!When the shipping product matrix was created.
idID!Unique primary key.
invoiceLineNameString!Invoice line name of the shipping product matrix.
isComposableBoolean!Whether this shipping product matrix is composable.
isFuelSurchargeApplicableBoolean!Whether a fuel surcharge applies to this shipping product matrix.
isLargestSizeFallbackEnabledBoolean!Whether largest-size fallback is enabled for this shipping product matrix.
ledgerLedgerLedger of the shipping product matrix.
nameString!Name of the shipping product matrix.
pricingModelShippingProductMatrixPricingModel!Pricing model of the shipping product matrix.
PER_KILOGRAMSIZE_BASEDshippingProductTenantShippingProduct!Shipping product of the shipping product matrix.
The sizes associated with this shipping product matrix.
sortInt!Sort of the shipping product matrix.
updatedAtDateTimeTz!When the shipping product matrix was last updated.
vatProfileVatProfileVAT profile of the shipping product matrix.
volumetricWeightFactorIntVolumetric weight factor of the shipping product matrix.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
nameString!Name of the warehouse
cursorString!A unique cursor that can be used for pagination.
createdAtDateTimeTz!When the shipping product option was created.
idID!Unique primary key.
isFuelSurchargeApplicableBoolean!Whether a fuel surcharge applies to this shipping product option.
ledgerLedgerLedger of the shipping product option.
nameString!Name of the shipping product option.
shippingProductTenantShippingProduct!The shipping product that owns the option.
shippingProductServiceMethodsTenantShippingProductMethodConnection!Shipping product service methods linked to this option.
updatedAtDateTimeTz!When the shipping product option was last updated.
vatProfileVatProfileVAT profile of the shipping product option.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
cursorString!A unique cursor that can be used for pagination.
amountMoney!Amount of the price.
contextableIdIDThe contextable ID
createdAtDateTimeTz!When the price was created.
idID!Unique primary key.
priceableIdID!The priceable ID
priceableTypePriceableType!The priceable type
FULFILLMENT_SERVICE_RULEFULFILLMENT_SERVICE_RULE_TIERSHIPPING_PRODUCT_BASESHIPPING_PRODUCT_OPTIONupdatedAtDateTimeTz!When the price was last updated.
validFromDate!The date from which the price is valid
validToDateThe date until which the price is valid
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
cursorString!A unique cursor that can be used for pagination.
addressAddress!Address of the tenant shipping product sender address.
countryCodeString!Country code of the tenant shipping product sender address.
createdAtDateTimeTz!When the tenant shipping product sender address was created.
idID!Unique primary key.
shippingProductTenantShippingProduct!Shipping product of the tenant shipping product sender address.
updatedAtDateTimeTz!When the tenant shipping product sender address was last updated.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
cursorString!A unique cursor that can be used for pagination.
fromCountryCodeString!From country code of the tenant shipping product country.
toCountryCodeString!To country code of the tenant shipping product country.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
cursorString!A unique cursor that can be used for pagination.
idID!Unique primary key.
isEnabledBoolean!Is the country enabled by default
shippingServiceMethodCountryShippingServiceMethodCountry!Shipping service method country of the tenant shipping product method country.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
cursorString!A unique cursor that can be used for pagination.
idID!Unique primary key.
isEnabledBoolean!Is the method enabled by default
The options associated with this tenant shipping product method.
shippingProductMethodCountriesTenantShippingProductMethodCountryConnection!The shipping product method countries associated with this tenant shipping product method.
shippingProductMethodCountriesCountInt!Shipping product method countries count of the tenant shipping product method.
shippingServiceMethodShippingServiceMethod!Shipping service method of the tenant shipping product method.
The sizes associated with this tenant shipping product method.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
cursorString!A unique cursor that can be used for pagination.
idID!Unique primary key.
shippingProductServiceMethodsTenantShippingProductMethodConnection!The shipping product service methods associated with this tenant shipping product service.
shippingServiceShippingService!Shipping service of the tenant shipping product service.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
idID!Unique primary key.
idID!Unique primary key.
isEnabledBoolean!Whether synchronization is enabled.
nameString!Name of the integration.
autoSendTimeString!Local time (HH:mm, in the timezone) of the daily automatic send.
billingRunTimeString!Local time (HH:mm, in the timezone) of the daily billing run that bills inventory, fixed fees and minimums of closed periods.
frequencyBillingFrequencyInvoice cycle; null while nothing is saved, in which case every day is its own billing cycle.
MONTHLYWEEKLYintegrationIntegrationInvoicing integration that receives the invoices.
isAutoSendEnabledBoolean!Whether invoices are sent automatically once a day after their period ended; invoices with charges that need attention are held.
isEnabledBoolean!Whether invoicing is enabled.
isFreeLineFilterEnabledBoolean!Whether lines with a zero amount are left out of the invoices.
isSendToClientEnabledBoolean!Whether invoices are sent to the client after they are created in the invoicing system.
monthdayIntDay of the month that starts a monthly cycle.
timezoneString!Timezone of the invoice cycles.
weekdayIntISO day of the week (1 = Monday) that starts a weekly cycle.
edges[LedgerEdge!]!A list of Ledger edges.
pageInfoPageInfo!Pagination information about the list of edges.
nameString!Name of the organization
createdAtDateTimeTz!When the shipping service was created.
idID!Unique primary key.
isEnabledBoolean!Enabled
nameString!Name of the shipping service
A list of ShippingServiceMethodCountry edges.
pageInfoPageInfo!Pagination information about the list of edges.
createdAtDateTimeTz!When the shipping service was created.
ageCheckBooleanb2bBooleanb2cBooleandeliveryTimeShippingDeliveryTimeBEST_EFFORTHOURS_24HOURS_48HOURS_72NEXT_DAYSAME_DAYeveningDeliveryBooleanfirstMileShippingFirstMileDROP_OFF_POINTDROP_OFF_POINT_AND_PICKUPPICKUPinsuranceAmountShippingMethodInsuranceCapabilitylastMileShippingLastMileHOME_DELIVERYPICKUP_POINTmulticolloBooleannoNeighborDeliveryBooleanprinterlessBooleansaturdayDeliveryBooleanserviceLevelShippingServiceLevelECONOMYEXPRESSPRIORITYSTANDARDsignatureBooleansundayDeliveryBooleantrackedBooleanidID!Unique primary key.
isCancelableBoolean!Whether or not shipment (labels) are cancelable
isEnabledBoolean!Enabled
nameString!Name of the shipping service method
shippingServiceShippingService!Shipping service that contains this method
typeString!Type type
updatedAtDateTimeTz!When the shipping service was last updated.
cursorString!A unique cursor that can be used for pagination.
The ShippingServiceMethod node.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
typeString!Type of shipping service
updatedAtDateTimeTz!When the shipping service was last updated.
cursorString!A unique cursor that can be used for pagination.
businessUnitBusinessUnit!Business unit of the shipping service.
createdAtDateTimeTz!When the shipping service was created.
idID!Unique primary key.
isEnabledBoolean!Enabled
nameString!Name of the shipping service
shippingServiceMethodShippingServiceMethodFind a single shipping service method
shippingServiceMethodsShippingServiceMethodConnection!List shipping service methods
typeString!Type of shipping service
updatedAtDateTimeTz!When the shipping service was last updated.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
cursorString!A unique cursor that can be used for pagination.
createdAtDateTimeTz!When the shipping product size was created.
idID!Unique primary key.
matrixShippingProductMatrix!The shipping product matrix that owns the size.
maxDimensionsDimensionsMax dimensions of the shipping product size.
maxVolumeInLitersFloatMax volume in liters for the shipping product size.
nameString!Name of the shipping product size.
shippingProductTenantShippingProduct!The shipping product that owns the size.
sortInt!Sort order of the shipping product size.
tenantShippingProductServiceMethodsTenantShippingProductMethodConnection!Tenant shipping product service methods linked to this size.
updatedAtDateTimeTz!When the shipping product size was last updated.
weightWeightMax weight of the shipping product size.
Zones for the shipping product size.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
updatedAtDateTimeTz!When the shipping product was last updated.
cursorString!A unique cursor that can be used for pagination.
createdAtDateTimeTz!When the shipping product zone was created.
idID!Unique primary key.
Locations for the shipping product zone.
methodTypeShippingProductZoneMethodTypeShipping method type this zone applies to.
DELIVERYLOCAL_PICKUPRETURNnameString!Name of the shipping product zone.
shippingProductTenantShippingProduct!The shipping product that owns the zone.
Sizes for the shipping product zone.
updatedAtDateTimeTz!When the shipping product zone was last updated.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.