Download shipments as CSV

POST/v1/api/store/{team_slug}/shipment/action/export_csv

v1Operation ID v1_public_shipment_export_csv

Returns a CSV file (shipment_export_<time>.csv) with one row per shipment: order number, shipment number (SHIP-...), shipping type, customer name, email and contact, and the full shipping address. Made while you wait.

Permission

Any member of the team, on a plan with data export.

Business rules

• Needs the data export feature on your plan: otherwise 422 "This feature is not available to your team's plan."

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team

Request body

application/json, required.

• itemsarray of stringsrequired

  Shipment hash ids. Send an array, even for one.

  • At least 1 item

Response

200The CSV file, as an attachment.

The answer is a file (text/csv), not JSON. The example saves it with curl -o.

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

• 422The request was refused and changed nothing: validation_failed lists what to fix in error.fields, other codes name a business rule. When the team's plan does not include the feature, the body is only {"message": "This feature is not available to your team's plan."}.

  When

  items is missing, the plan lacks data export, or no id is your team's shipment (shipment_export_error, "Shipment not found").

  Fix

  Send an array of your shipment hash ids.

• 500A business rule refused the request (see the operation's errors), or something failed inside YoPrint. Refusals use the error envelope with a code such as action_not_allowed; an unexpected failure answers {"message": "Server Error"}. Repeating a refusal gets the same answer; after an unexpected failure, read the record back before you retry a change.

  When

  One of the shipments has no shipping type, or its order has no customer: the whole export fails with { "message": "Server Error" }.

  Fix

  Leave incomplete shipments out (is_valid false), or set the shipping type first.

Related

• POSTFilter shipments/v1/api/store/{team_slug}/shipment/filter

Example request

curl

curl -X POST 'https://secure.yoprint.com/v1/api/store/your-team/shipment/action/export_csv' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "items": [      "MQyJUnd3oty75h",      "dNJl954DcXrrND"    ]  }' \  -o export.csv

Example response 200

A text/csv file.