Skip to main content

Get Dropship Batch

GET 
/api/portal/dropship/batches/:batch

Gets one batch with every staged order, its lines, problems and preview totals. After Submit, poll this endpoint to follow progress: status moves from submitting to completed (or completed_with_errors), totals.processed / created / failed count up, and each order gains a result with the created sales order number or the reason it failed.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Auth: a portal session bearer token, or a portal API key (pfk_…) with the dropship:read scope, sent as Authorization: Bearer. Requires an enabled dropship program; 60 requests a minute.

Batch fields: id, original_filename, format (sku_template or shopify_export) with format_label, status (staged → submitting → completed or completed_with_errors; or discarded) with status_label, totals (rows, orders, lines, ready, warning, error, to_create, and once submitted processed, created, failed, repriced — orders whose price changed since the dry run — and repriced_delta), submittable_count, can_submit, can_discard, tracked_job_log_id (the background job creating the orders, once submitted), uploaded_by, created_at, updated_at.

Staged orders (orders): one entry per order in the file — index, order_number, rows (CSV row numbers, header = row 1), status (ready, warning — will be created, e.g. backordered stock or an address format warning — or error — will not be created), consumer (name, city, state, country_code), ship_to (the address columns as uploaded), service, gift_message, item_count, lines (row, sku, quantity as uploaded, and once matched product_id, name, unit_price, line_total), issues (each with level, code, row, field — the CSV column — message and an optional SKU suggestion), preview totals (subtotal, dropship_fee, shipping, total, currency; null for an order with errors), and after submit result (status: created, duplicate, pending_approval or failed, plus sales_order_id, sales_order_number, approval_id, and code/error when it failed).

Issue codes include missing_order_number, duplicate_order (you already sent that order number), duplicate_in_file, address_conflict, address_incomplete, international_not_allowed, unsupported_service, gift_message_too_long, missing_sku, invalid_quantity, empty_order, unknown_sku, not_dropship_eligible, unpriced, insufficient_stock (errors) and low_stock plus address format codes (warnings).

Errors: 404 not_found when the id is not one of your account's batches.

Request​

Responses​

OK

Response Headers
    Content-Type