Shipping and fulfillment APIs
Show custom shipping rates at checkout, or register your app as a store's fulfillment service and then manage its fulfillments.
In this section
CountriesInShippingZones — Countries that have been defined in shipping zones for the shop.
DeliveryAvailableService — The service and the countries they are available for.
DeliveryCarrierService — Information about a carrier or service provider.
DeliveryCarrierServiceAndLocations — A carrier services and their set of shop locations that can be used.
DeliveryCondition — A condition that must pass for a method definition to be applied to an order.
DeliveryConditionCriteria — The criteria (weight or price) that the field must meet based on the operator.
DeliveryConditionField — The field type that the condition will be applied to.
DeliveryConditionOperator — The operator to use to determine if the condition passes.
DeliveryCountry — A country that is used to define a zone.
DeliveryCountryAndZone — A country with the name of the zone.
DeliveryCountryCodeOrRestOfWorld — The ISO 3166-1 alpha-2 country code and a flag indicating Rest Of World.
DeliveryCountryCodesOrRestOfWorld — A list of ISO 3166-1 alpha-2 country codes or the ’Rest of World’.
DeliveryCountryInput — Input fields to specify a country.
DeliveryLegacyModeBlocked — Whether the shop is blocked from converting to full multi-location delivery profiles mode. If the shop is blocked, then the blocking reasons are also returned.
DeliveryLegacyModeBlockedReason — Reasons the shop is blocked from converting to full multi-location delivery profiles mode.
DeliveryLocationGroup — A location group is a collection of active locations that share zone and delivery methods across delivery profiles.
DeliveryLocationGroupZone — Links a location group and zone with the associated method definitions in a delivery profile.
DeliveryLocationGroupZoneInput — Input fields for a delivery zone associated to a location group and profile.
DeliveryMethod — Delivery method.
DeliveryMethodDefinition — A method definition describes the delivery rate and the conditions that must be met for the method to be applied.
DeliveryMethodDefinitionCounts — Then number of method definitions in a zone, separated into merchant-owned and participant definitions.
DeliveryMethodDefinitionInput — Input fields for a method definition.
DeliveryMethodDefinitionType — The different types of method definitions to filter by.
DeliveryMethodType — Possible method types that a delivery method can have.
DeliveryParticipant — A carrier-defined rate with possible merchant-defined fixed fee or percentage-of-rate fee.
DeliveryParticipantInput — Input fields for a participant.
DeliveryParticipantService — A service provided by a participant.
DeliveryParticipantServiceInput — Input fields for a service provided by a participant.
DeliveryPriceConditionInput — Input fields for the price-based conditions of a method definition.
DeliveryProductVariantsCount — How many product variants are in a profile. This count is capped at 500.
DeliveryProfile — A profile for multi-location, per-product delivery.
DeliveryProfileInput — Input fields for a delivery profile.
DeliveryProfileItem — A product and the subset of associated variants that are part of this delivery profile.
DeliveryProfileLocationGroup — Links a location group with zones associated to a delivery profile.
DeliveryProfileLocationGroupInput — Input fields for a delivery location group associated to a profile.
DeliveryProvince — A region that is used to define a zone.
DeliveryProvinceInput — The input fields to specify a region.
DeliveryRateDefinition — The merchant-defined rate of the DeliveryMethodDefinition.
DeliveryRateDefinitionInput — Input fields for a rate definition.
DeliveryRateProvider — Rate provided by a rate definition or a participant.
DeliverySetting — Delivery shop-level settings.
DeliverySettingInput — Input fields for shop-level delivery settings.
DeliveryUpdateConditionInput — Input fields for updating the conditions of a method definition.
DeliveryWeightConditionInput — Input fields for the weight-based conditions of a method definition.
DeliveryZone — A zone is a geographical area that contains delivery methods within a delivery profile.
DraftFulfillment — Returns unfulfilled line items grouped by their ful