TRtrackstarhq

Create Order File

Changed on

Create a file for the specified order.

post/wms/orders/{order_id}/file

Request

  • Base URL
    https://production.trackstarhq.com
  • URL
    https://production.trackstarhq.com/wms/orders/{order_id}/file
  • Auth
    none required

Path parameters

order_idstring required

Headers

x-trackstar-api-keystring required
Example:<x-trackstar-api-key>

Your organization-level Trackstar API key.

x-trackstar-access-tokenstring required
Example:<x-trackstar-access-token>

Your user's access token for a specific integration (ShipHero, Extensiv, etc).

Idempotency-Keystring
Example:9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00

Optional key that makes this request safe to retry. Send the same key on a retry and Trackstar returns the first attempt's response instead of writing again; if the first attempt failed, the retry runs the write again. Reusing a key with a different request is rejected. Keys expire after 24 hours.

Request body multipart/form-data

file_urlstring

The URL of the file to attach.

file_namestring

The name of the file to attach.

filestring binary

Example request

{
  "file_url": "file_url",
  "file_name": "file_name"
}

Response

Successful response

data'success' required

Status of the file attachment

idstring required

The ID of the object that has been created or modified

unused_fieldsstring[] required

Unused fields

Example response

{
  "data": "success",
  "id": "id",
  "unused_fields": [
    "unused_fields"
  ]
}

Changes