Fulfillment Orders

Category: Admin Base URL: /admin/fulfillment Authentication: Required Routes: 21 routes documented

Overview

This section documents 21 API routes for fulfillment orders.

⚠️ These endpoints operate on your live store. POST/PUT/DELETE operations here — including sync, push, resync, and cache operations — modify or delete production data, and some trigger downstream effects such as warehouse orders or customer emails. DELETE operations are generally irreversible. Verify IDs and parameters carefully before calling them from scripts.

Quick Reference

GET Admin Fulfillment

Endpoint: GET /admin/fulfillment Authentication: Admin (Required)

Response

Success:

// Response structure (to be documented)

Example Request

curl -X GET 'https://your-store.omnicart.cc/admin/fulfillment' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Fulfillment :id

Endpoint: GET /admin/fulfillment/:id Authentication: Admin (Required)

URL Parameters

Response

Success:

// Response structure (to be documented)

Example Request

curl -X GET 'https://your-store.omnicart.cc/admin/fulfillment/:id' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Fulfillment Export

Endpoint: GET /admin/fulfillment/export Authentication: Admin (Required)

Response

Success:

// Response structure (to be documented)

Example Request

curl -X GET 'https://your-store.omnicart.cc/admin/fulfillment/export' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Fulfillment Export-csv

Endpoint: GET /admin/fulfillment/export-csv Authentication: Admin (Required)

Response

Success:

// Response structure (to be documented)

Example Request

curl -X GET 'https://your-store.omnicart.cc/admin/fulfillment/export-csv' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Fulfillment Health

Endpoint: GET /admin/fulfillment/health Authentication: Admin (Required)

Response

Success:

// Response structure (to be documented)

Example Request

curl -X GET 'https://your-store.omnicart.cc/admin/fulfillment/health' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

PUT Admin Fulfillment Hold

Endpoint: PUT /admin/fulfillment/hold Authentication: Admin (Required)

Request Body

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

Example Request

curl -X PUT 'https://your-store.omnicart.cc/admin/fulfillment/hold' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Fulfillment Import

Endpoint: POST /admin/fulfillment/import Authentication: Admin (Required)

Request Body

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

Example Request

curl -X POST 'https://your-store.omnicart.cc/admin/fulfillment/import' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Fulfillment Quickbox Push

Endpoint: POST /admin/fulfillment/quickbox/push Authentication: Admin (Required)

Request Body

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

Example Request

curl -X POST 'https://your-store.omnicart.cc/admin/fulfillment/quickbox/push' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Fulfillment Quickbox Sync

Endpoint: POST /admin/fulfillment/quickbox/sync Authentication: Admin (Required)

Request Body

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

Example Request

curl -X POST 'https://your-store.omnicart.cc/admin/fulfillment/quickbox/sync' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Fulfillment Quickbox Sync-status

Endpoint: GET /admin/fulfillment/quickbox/sync-status Authentication: Admin (Required)

Response

Success:

// Response structure (to be documented)

Example Request

curl -X GET 'https://your-store.omnicart.cc/admin/fulfillment/quickbox/sync-status' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Fulfillment Sku-aliases

Endpoint: GET /admin/fulfillment/sku-aliases Authentication: Admin (Required)

Description

GET /admin/fulfillment/sku-aliases List all SKU aliases with optional filters Query params: - stock_location_id: Filter by warehouse/location - warehouse_sku: Filter by warehouse SKU (partial match) - medusa_sku: Filter by OmniCart SKU (partial match) - needs_review: Filter to only show aliases needing review - is_verified: Filter to only show verified aliases - group_bundles: Group by medusa_sku to show bundles with all warehouse SKUs together - limit: Pagination limit (default 50) - offset: Pagination offset (default 0)

Response

Success:

// Response structure (to be documented)

Example Request

curl -X GET 'https://your-store.omnicart.cc/admin/fulfillment/sku-aliases' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Fulfillment Sku-aliases

Endpoint: POST /admin/fulfillment/sku-aliases Authentication: Admin (Required)

Description

POST /admin/fulfillment/sku-aliases Create a new SKU alias Body: - warehouse_sku: The warehouse/3PL SKU (required) - medusa_sku: The OmniCart variant SKU (required) - stock_location_id: The stock location ID (required) - variant_id: Optional variant ID for caching - notes: Optional notes - needs_review: Optional flag for review workflow - is_verified: Optional flag for verified aliases - recommendation: Optional system recommendation - match_confidence: Optional confidence score (0-100) - order_count: Optional order count for reference

Request Body

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

Example Request

curl -X POST 'https://your-store.omnicart.cc/admin/fulfillment/sku-aliases' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Fulfillment Sku-aliases :id

Endpoint: GET /admin/fulfillment/sku-aliases/:id Authentication: Admin (Required)

Description

GET /admin/fulfillment/sku-aliases/:id Get a single SKU alias by ID

URL Parameters

Response

Success:

// Response structure (to be documented)

Example Request

curl -X GET 'https://your-store.omnicart.cc/admin/fulfillment/sku-aliases/:id' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

PUT Admin Fulfillment Sku-aliases :id

Endpoint: PUT /admin/fulfillment/sku-aliases/:id Authentication: Admin (Required)

Description

PUT /admin/fulfillment/sku-aliases/:id Update an existing SKU alias Body: - warehouse_sku: Optional updated warehouse SKU - medusa_sku: Optional updated OmniCart SKU - stock_location_id: Optional updated location ID - variant_id: Optional variant ID - notes: Optional notes - needs_review: Optional review flag - is_verified: Optional verified flag - recommendation: Optional system recommendation - match_confidence: Optional confidence score - order_count: Optional order count

URL Parameters

Request Body

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

Example Request

curl -X PUT 'https://your-store.omnicart.cc/admin/fulfillment/sku-aliases/:id' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

DELETE Admin Fulfillment Sku-aliases :id

Endpoint: DELETE /admin/fulfillment/sku-aliases/:id Authentication: Admin (Required)

Description

DELETE /admin/fulfillment/sku-aliases/:id Delete an SKU alias

URL Parameters

Response

Success:

// Response structure (to be documented)

Example Request

curl -X DELETE 'https://your-store.omnicart.cc/admin/fulfillment/sku-aliases/:id' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Fulfillment Stats

Endpoint: GET /admin/fulfillment/stats Authentication: Admin (Required)

Response

Success:

// Response structure (to be documented)

Example Request

curl -X GET 'https://your-store.omnicart.cc/admin/fulfillment/stats' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Orders :id Activities

Endpoint: GET /admin/orders/:id/activities Authentication: Admin (Required)

Description

GET /admin/orders/:id/activities Fetches all activities for a specific order, ordered by most recent first. Used by the Order Activity Timeline widget.

URL Parameters

Response

Success:

// Response structure (to be documented)

Example Request

curl -X GET 'https://your-store.omnicart.cc/admin/orders/:id/activities' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Orders :id Notes

Endpoint: GET /admin/orders/:id/notes Authentication: Admin (Required)

Description

GET /admin/orders/:id/notes Returns all notes for an order

URL Parameters

Response

Success:

// Response structure (to be documented)

Example Request

curl -X GET 'https://your-store.omnicart.cc/admin/orders/:id/notes' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Orders :id Notes

Endpoint: POST /admin/orders/:id/notes Authentication: Admin (Required)

Description

POST /admin/orders/:id/notes Add a new note to an order

URL Parameters

Request Body

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

Example Request

curl -X POST 'https://your-store.omnicart.cc/admin/orders/:id/notes' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

DELETE Admin Orders :id Notes :noteId

Endpoint: DELETE /admin/orders/:id/notes/:noteId Authentication: Admin (Required)

Description

DELETE /admin/orders/:id/notes/:noteId Delete a specific note from an order

URL Parameters

Response

Success:

// Response structure (to be documented)

Example Request

curl -X DELETE 'https://your-store.omnicart.cc/admin/orders/:id/notes/:noteId' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

PUT Admin Orders :id Notes :noteId

Endpoint: PUT /admin/orders/:id/notes/:noteId Authentication: Admin (Required)

Description

PUT /admin/orders/:id/notes/:noteId Update a specific note (content only)

URL Parameters

Request Body

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

Example Request

curl -X PUT 'https://your-store.omnicart.cc/admin/orders/:id/notes/:noteId' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Orders :id Quickbox-events

Endpoint: GET /admin/orders/:id/quickbox-events Authentication: Admin (Required)

Description

GET /admin/orders/:id/quickbox-events Fetch Quickbox shipment events/history for an order. Returns shipments and their delivery status from Quickbox. Supports both Order Manager and Warehouse Manager APIs.

URL Parameters

Response

Success:

// Response structure (to be documented)

Example Request

curl -X GET 'https://your-store.omnicart.cc/admin/orders/:id/quickbox-events' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Orders :id Quickbox-pull

Endpoint: POST /admin/orders/:id/quickbox-pull Authentication: Admin (Required)

Description

POST /admin/orders/:id/quickbox-pull Safely PULL/REFRESH a single order from QuickBox (WMS API only). - Looks the order up in QuickBox using all known reference formats - Refreshes the QuickBox lifecycle status/metadata - NATIVE orders: pulls tracking + creates the OmniCart fulfillment if it shipped - KONNEKTIVE orders: lifecycle/metadata refresh ONLY — never creates a fulfillment (Konnektive's own sync owns fulfillment; creating one here risks a double-ship/double-email). ⚠️ This NEVER creates the order in QuickBox. For create-if-absent behavior, use POST /admin/orders/:id/quickbox-push instead. ts, which already performs the pull/stamp/fulfill flow WITHOUT creating. ⚠️ Prices are DECIMALS (19.99 = $19.99). Do NOT divide by 100.

URL Parameters

Request Body

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

Example Request

curl -X POST 'https://your-store.omnicart.cc/admin/orders/:id/quickbox-pull' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Orders :id Quickbox-push

Endpoint: POST /admin/orders/:id/quickbox-push Authentication: Admin (Required)

Description

POST /admin/orders/:id/quickbox-push Manually push a single order to QuickBox (WMS API only). - If order exists in QuickBox with tracking → create fulfillment in OmniCart - If order does not exist → create it in QuickBox ⚠️ Prices are DECIMALS (19.99 = $19.99). Do NOT divide by 100.

URL Parameters

Request Body

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

Example Request

curl -X POST 'https://your-store.omnicart.cc/admin/orders/:id/quickbox-push' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Orders :id Resend-email

Endpoint: POST /admin/orders/:id/resend-email Authentication: Admin (Required)

Description

POST /admin/orders/:id/resend-email Resend email notifications for an order Supports: order-placed, order-shipped, order-delivered, refund-processed Note: order-confirmed workflow exists but is not exposed in the widget UI

URL Parameters

Request Body

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

Example Request

curl -X POST 'https://your-store.omnicart.cc/admin/orders/:id/resend-email' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Orders Export

Endpoint: POST /admin/orders/export Authentication: Admin (Required)

Request Body

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

Example Request

curl -X POST 'https://your-store.omnicart.cc/admin/orders/export' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'