Skip to main content

Collection (Collect)

Collections (or "collects") group fulfillment orders for scheduled carrier pickups. A collection represents a batch of orders ready for a carrier to collect.

Overview​

Collections are the mechanism for organizing fulfillment orders by scheduled pickup time. They allow you to batch multiple orders together for efficient carrier collection and reduce shipping costs through consolidation.

Key Features​

  • Batch Organization - Group fulfillment orders for scheduled pickups
  • Scheduled Pickups - Define pickup dates and times for carriers
  • Carrier Assignment - Assign expeditors (carriers) to collections
  • State Management - Track collection lifecycle from pending to closed
  • Order Management - Add or remove orders from collections dynamically

Collection States​

Collections have different states throughout their lifecycle:

  • Pending - Collecting orders for the next pickup
  • Ready - Awaiting carrier pickup
  • Picked - Orders have been collected by carrier
  • Closed - Collection cycle completed

Common Operations​

  • Query collections with filters and pagination
  • Create or update collection batches
  • Add fulfillment orders to collections
  • Remove fulfillment orders from collections
  • Schedule pickup times for carriers

Related Types​

For detailed type information, see the schema documentation.