Overview
This API allows you to:- Set Fulfillment Type: Configure how a shipment will be fulfilled (standard shipping, scheduled delivery, or in-store pickup)
- Set Shipping Method: Select shipping options for standard delivery
- Get Availability: Query available dates and time slots for scheduled delivery
Available Endpoints
Set Fulfillment Type
Configure how each shipment will be fulfilled
Set Shipping Method
Select shipping method for standard delivery
Get Availability
Check available dates for scheduled delivery
Fulfillment Types
Each shipment can be configured with one of these fulfillment types:SHIP_TO_ADDRESS
Standard shipping to customer’s address. Requires shipping method selection.SCHEDULED_DELIVERY
Delivery with appointment scheduling. Supports date and time slot selection via the availability endpoint.IN_STORE_PICKUP
Customer pickup at store location (availability depends on merchant support).Workflow
1
Get Cart
Retrieve the cart to see current shipments and their fulfillment options
2
Set Fulfillment Type
Configure each shipment’s fulfillment type based on available options
3
Configure Delivery
- For
SHIP_TO_ADDRESS: Set shipping method - For
SCHEDULED_DELIVERY: Get availability, then set delivery date/time - For
IN_STORE_PICKUP: Select pickup location (if applicable)
Default Selection Behavior
Automatic Defaults: When a cart is created or shipping information is set, Firmly automatically:
- Selects a default fulfillment type for each shipment
- Chooses the cheapest available shipping method for standard shipping
Important Notes
Shipments are created and grouped by the merchant’s system based on their fulfillment rules. Firmly provides a standardized interface to configure these merchant-defined shipments.