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 fulfillment service. Each draft fulfillment contains additional information, such as whether the fulfillment requires shipping and whether a shipping label can be printed for it.
• EditableProperty — The attribute editable information.
• Fulfillment — Represents a fulfillment. In Shopify, a fulfillment represents a shipment of one or more items in an order. When an order has been completely fulfilled, it means that all the items that are included in the order have been sent to the customer. There can be more than one fulfillment for an order.
• FulfillmentDisplayStatus — The display status of a fulfillment.
• FulfillmentEvent — An event that describes a fulfillment at a time.
• FulfillmentEventSortKeys — The set of valid sort keys for the FulfillmentEvent query.
• FulfillmentEventStatus — Event status’ describe the status of a fulfillment.
• FulfillmentInput — The input fields used to create a fulfillment.
• FulfillmentLineItem — Represents a line item from an order that’s included in a fulfillment.
• FulfillmentLineItemInput — The input fields used to include a line item from an order in a fulfillment.
• FulfillmentOrder — Represents a fulfillment order. In Shopify, a fulfillment order represents a group of one or more items in an order that are to be fulfilled from the same location. There can be more than one fulfillment order for an order at a given location.
• FulfillmentOrderAction — The actions that can be taken on a fulfillment order.
• FulfillmentOrderAssignedLocation — Represents the assigned location of a fulfillment order, which is a snapshot of the location at which the fulfillment order was created. The assigned location is expected to perform fulfillment.
• FulfillmentOrderAssignmentStatus — The assigment status to be used to filter fulfillment orders.
• FulfillmentOrderDestination — Represents the destination where the items should be sent upon fulfillment.
• FulfillmentOrderLineItem — Represents a line item belonging to a fulfillment order.
• FulfillmentOrderLineItemInput — The input fields used to include a line item from a fulfillment order.
• FulfillmentOrderLineItemsInput — The input fields used to include the line items of a specified fulfillment order that should be fulfilled.
• FulfillmentOrderLocationForMove — A location that a fulfillment order can potentially move to.
• FulfillmentOrderMerchantRequest — Represents a request made by the merchant to a fulfillment service for a fulfillment order.
• FulfillmentOrderMerchantRequestKind — The kinds of request merchants can make to a fulfillment service.
• FulfillmentOrderRequestStatus — The request status of a fulfillment order.
• FulfillmentOrderSortKeys — The set of valid sort keys for the FulfillmentOrder query.
• FulfillmentOrderStatus — The status of a fulfillment order.
• FulfillmentOrderSupportedAction — Represents one of the methods that the fulfillment order supports.
• FulfillmentService — Represents a fulfillment service. A fulfillment service is a third-party service that prepares and ships orders on behalf of the store owner.
• FulfillmentServiceType — The type of a fulfillment service.
• FulfillmentStatus — The status of a fulfillment.
• FulfillmentTrackingInfo — Represents the tracking information for a fulfillment.
• FulfillmentTrackingInput — The input fields used to specify all possible fields for tracking information.
• FulfillmentV2Input — The input fields used to create a fulfillment from fulfillment orders.
• MethodDefinitionSortKeys — The set of valid sort keys for the MethodDefinition query.
• ProfileItemSortKeys — The set of valid sort keys for the ProfileItem query.
• ShippingMethod — The shipping method for the delivery.
• ShippingRate — A shipping rate to be applied to an order.
• TrackingInfoInput — Specifies the fields for tracking information.
• TrackingInfoUpdateInput — Specifies all possible fields for updating tracking information.
• deliveryProfileCreate — Creates a delivery profile.
• deliveryProfileRemove — Enqueues the deletion/removal of a delivery profile.
• deliveryProfileUpdate — Updates a delivery profile.
• deliverySettingUpdate — Set the delivery settings for a shop.
• deliveryShippingOriginAssign — Assign a location as the shipping origin while in legacy compatibility mode profiles.
• fulfillmentCancel — Cancels a fulfillment.
• fulfillmentCreate — Creates a fulfillment for an order.
• fulfillmentCreateV2 — Creates a fulfillment for one or many fulfillment orders. The fulfillment orders are associated with the same order and are assigned to the same location.
• fulfillmentOrderAcceptCancellationRequest — Accept a cancellation request sent to a fulfillment service for a fulfillment order.
• fulfillmentOrderAcceptFulfillmentRequest — Accepts a fulfillment request sent to a fulfillment service for a fulfillment order.
• fulfillmentOrderCancel — Marks a fulfillment order as canceled.
• fulfillmentOrderClose — Marks an in-progress fulfillment order as incomplete, indicating the fulfillment service is unable to ship any remaining items and intends to close the fulfillment order.
• fulfillmentOrderMove — Moves a fulfillment order to a new location.
• fulfillmentOrderOpen — Marks a scheduled fulfillment order as open.
• fulfillmentOrderRejectCancellationRequest — Rejects a cancellation request sent to a fulfillment service for a fulfillment order.
• fulfillmentOrderRejectFulfillmentRequest — Rejects a fulfillment request sent to a fulfillment service for a fulfillment order.
• fulfillmentOrderReschedule — Reschedules a scheduled fulfillment order.
• fulfillmentOrderSubmitCancellationRequest — Sends a cancellation request to the fulfillment service of a fulfillment order.
• fulfillmentOrderSubmitFulfillmentRequest — Sends a fulfillment request to the fulfillment service of a fulfillment order.
• fulfillmentServiceCreate — Creates a fulfillment service.
• fulfillmentServiceDelete — Deletes a fulfillment service.
• fulfillmentServiceUpdate — Updates a fulfillment service.
• fulfillmentTrackingInfoUpdate — Updates tracking information for a fulfillment.
• fulfillmentTrackingInfoUpdateV2 — Updates tracking information for a fulfillment.
• shippingPackageDelete — Deletes a shipping package.
• shippingPackageMakeDefault — Sets a Shipping Package as the default shipping package. The default shipping package is the one used to calculate shipping costs on checkout.
• shippingPackageUpdate — Updates a custom shipping package.