EventsShipments

Shipments

Retrieve a Single Shipment by ID #

Method
GET
Endpoint
Sample Object

Retrieves a single Shipment by its ID.

Parameters
Name Type Required? Description Details
id Number Yes
The ID of the Shipment.
Use the id from Retrieve Shipments (GET /v1/events/shipments) or from the add response. You don't send the Event ID; the record's Event is found automatically.
$result_format String No
By default, the response is a single object. Send array to get it inside a one-item array.
Allowed values: array | object
$include_record_revision Boolean No
Whether to include record_revision in the response.
Default: false. Send true to get record_revision, then send that value as expected_revision when you update this Shipment. See What $include_record_revision covers below.
$on_error_return_empty_result Boolean No
Whether an invalid or unavailable Shipment should return an empty result.
Default: false. True returns HTTP 200 with {} (or [] for array format) for invalid IDs or an unavailable Shipment. API key errors, ambiguous headers, conflicts with a change in progress, inconsistent invoice information and unexpected errors keep their normal status.
If-None-Match String No
An ETag from an earlier response to this GET.
Optional HTTP header. If the successful response is unchanged, the API returns HTTP 304 with no body.

Good to know

The response includes carrier, pickup and delivery details, components, costs and payment information.

What $include_record_revision covers

Setting $include_record_revision=true returns record_revision for use as expected_revision on a later update.

record_revision covers saved Shipment details, payment fields, component identities and values, cost allocations, related-item links and Event binding. File Attachment and Invoice Attachment metadata/contents are not included.

Components, files and access

Each Shipment includes its components and the workspace measurement units: dimensions_unit is in or cm, and weight_unit is lb or kg. Invoice Attachment metadata is included as invoice_attachment, or null if no invoice is attached. Supporting File Attachments use their own collection and download operation.

The Event's Shipments tab must be visible. A locked tab can still be read. Inconsistent invoice information returns HTTP 409 instead of exposing another record's file.

Formatted text in the response

Notes and other rich-text values in the response contain the stored HTML, including encoded characters and line breaks such as <br />.

Open in ExhibitDay

Each record includes exhibitday_url, the record's page in ExhibitDay. It opens the record in view mode on its Event's tab. Sign in with an account that can view the record; ExhibitDay checks access when the link is opened.

Code Samples
curl -X GET "https://api.exhibitday.com/v1/events/shipments/info?id=12345" -H "Authorization: Bearer YOUR_API_KEY"

Example response

{
  "id": 12345,
  "event_id": 23456,
  "event_name": "Sample Event",
  "carrier": null,
  "tracking_url": null,
  "shipment_status": "Not Specified",
  "payment_status": {
    "id": 0,
    "name": "N/A"
  },
  "dimensions_unit": "in",
  "weight_unit": "lb",
  "components": [
    {
      "id": 17346,
      "component_type_id": null,
      "component_type": "Not Specified",
      "description": "Display stand case",
      "tracking_number": "EXAMPLE-1001",
      "dimensions_length": 48.0,
      "dimensions_width": 24.0,
      "dimensions_height": 18.0,
      "weight": 65.0
    },
    {
      "id": 17347,
      "component_type_id": null,
      "component_type": "Not Specified",
      "description": "Brochure carton",
      "tracking_number": "EXAMPLE-1002",
      "dimensions_length": 20.0,
      "dimensions_width": 16.0,
      "dimensions_height": 12.0,
      "weight": 18.50
    }
  ],
  "cost": {
    "amount": 125.50,
    "cost_center_breakdown": [
      {
        "cost_center_id": 34567,
        "cost_center": "Marketing",
        "charge": 75.50
      },
      {
        "cost_center_id": 34568,
        "cost_center": "Operations",
        "charge": 50.00
      }
    ]
  },
  "name": "Exhibit freight",
  "tracking_number": null,
  "carrier_id": null,
  "other_carrier_name": null,
  "pickup_date": null,
  "delivery_date": null,
  "pickup_location": null,
  "delivery_location": null,
  "notes": "",
  "payment_status_id": 0,
  "payment_due_date": null,
  "next_payment_due_date": null,
  "payment_notes": null,
  "invoice_attachment": {
    "id": 482345,
    "filename": "shipment-invoice.pdf",
    "attachment_created_timestamp": "2027-01-30T12:00:00Z"
  },
  "shipment_status_id": null,
  "service_level": null,
  "shipment_reference_number": null,
  "pickup_contact_name": null,
  "pickup_contact_email": null,
  "pickup_contact_phone": null,
  "pickup_instructions": null,
  "delivery_contact_name": null,
  "delivery_contact_email": null,
  "delivery_contact_phone": null,
  "delivery_instructions": null,
  "packing_handling_requirements": null,
  "received_by": null,
  "delivery_exception_notes": null,
  "exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=23456&riType=4&riSub=0&riId=12345",
  "related_items": [
    {
      "id": 5551,
      "related_item_id": 67890,
      "related_item_exhibitday_url": "https://www.exhibitday.com/Workspace/TaskView/98765?tid=67890",
      "related_item_type_id": 1,
      "related_item_type": "Task",
      "related_item_asset_type_id": null,
      "related_item_name": "Confirm booth graphics with the printer",
      "related_item_created_timestamp": "2030-01-10T14:03:00Z"
    },
    {
      "id": 5552,
      "related_item_id": 45678,
      "related_item_exhibitday_url": "https://www.exhibitday.com/Workspace/RelatedItemView/98765?typeId=4&subTypeId=0&rid=45678",
      "related_item_type_id": 4,
      "related_item_type": "Shipment",
      "related_item_asset_type_id": null,
      "related_item_name": "Booth crates to convention center",
      "related_item_created_timestamp": "2030-01-10T14:03:00Z"
    }
  ]
}
Note: IDs are illustrative; use IDs from your workspace. The filename is an example.

Retrieve Shipments #

Method
GET
Endpoint

Retrieves Shipments across the Events you can read.

Parameters
Name Type Required? Description Details
filter_by_event_id Number No
Return records for this Event only. Omit for all readable Events in your workspace.
$limit Number No
The most Shipments to return, as a whole number of 1 or more. Omit it to return all remaining matching Shipments.
$offset Number No
How many Shipments to skip, as a whole number of 0 or more; 0 by default.
$result_format String No
By default, the response is an object containing list_data and the paging totals (records_found, total_records, has_more). Send array to get just a JSON array of the records, or wrapped_in_array to get the default object inside a one-item array.
Allowed values: array | wrapped_in_array
hydrate_related_items Boolean No
Set to true to include each record's related_items: the Tasks and items linked to it, with the key to use when adding or removing a link. Omit it or send false to leave related_items out of list results. Single-record GETs always include related_items.
Default: false.

Good to know

Retrieves records across your workspace's readable Event tabs. Use filter_by_event_id to narrow the results to one Event, or omit it for the workspace list. Each record includes its event_id and Event name.

Choosing Events

Omit filter_by_event_id to retrieve records across readable Event tabs, or supply one Event ID to narrow the list. Each result retains its own event_id and Event name.

Hidden or unavailable Event tabs are not included. A locked tab can still be read. If no records match, the response is an empty list.

Reading pages

The Event filter and any people filter are applied before the total count and paging. Results are ordered by Event start date ascending, Event ID ascending, then record ID ascending.

Use $limit and $offset for successive pages. Omit $limit to return all remaining matches. total_records and X-Total-Count describe all matches; records_found counts this response.

Omit $result_format for the normal list wrapper. array returns only the records; wrapped_in_array places the normal wrapper in a one-item array.

Handling input and changes

Unrecognized parameters are ignored and listed in the X-API-Warnings response header. Conflicting or malformed filter values return HTTP 400; send arrays in JSON, query parameters or form fields rather than comma-bearing headers.

Current API access is checked even when the list is empty. A concurrent change can return HTTP 409; retrieve the list again. These filters retrieve records and do not change tags, assignments or notification settings.

Related items

Set hydrate_related_items=true to include each record's related_items: the Tasks and items linked to it. Add or remove links with POST and DELETE /v1/related_items. It is left out by default to keep lists fast. Retrieving one record always includes related_items.

Formatted text in the response

Notes and other rich-text values in the response contain the stored HTML, including encoded characters and line breaks such as <br />.

Events with a hidden Shipments tab

Records on Events whose Shipments tab is hidden are not listed. If filter_by_event_id names such an Event, the response is HTTP 200 with no records for it and a warning that names the tab and the Event.

Open in ExhibitDay

Each record includes exhibitday_url, the record's page in ExhibitDay. It opens the record in view mode on its Event's tab. Sign in with an account that can view the record; ExhibitDay checks access when the link is opened.

Code Samples
curl -X GET "https://api.exhibitday.com/v1/events/shipments" -H "Authorization: Bearer YOUR_API_KEY"

Example response

{
  "records_found": 1,
  "total_records": 1,
  "has_more": false,
  "list_type": "shipment",
  "list_data": [
    {
      "id": 12345,
      "event_id": 23456,
      "event_name": "Sample Event",
      "carrier": null,
      "tracking_url": null,
      "shipment_status": "Not Specified",
      "payment_status": {
        "id": 0,
        "name": "N/A"
      },
      "dimensions_unit": "in",
      "weight_unit": "lb",
      "components": [],
      "cost": {
        "amount": 0.00,
        "cost_center_breakdown": []
      },
      "name": "Exhibit freight",
      "tracking_number": null,
      "carrier_id": null,
      "other_carrier_name": null,
      "pickup_date": null,
      "delivery_date": null,
      "pickup_location": null,
      "delivery_location": null,
      "notes": "",
      "payment_status_id": 0,
      "payment_due_date": null,
      "next_payment_due_date": null,
      "payment_notes": null,
      "invoice_attachment": {
        "id": 482345,
        "filename": "shipment-invoice.pdf",
        "attachment_created_timestamp": "2027-01-30T12:00:00Z"
      },
      "shipment_status_id": null,
      "service_level": null,
      "shipment_reference_number": null,
      "pickup_contact_name": null,
      "pickup_contact_email": null,
      "pickup_contact_phone": null,
      "pickup_instructions": null,
      "delivery_contact_name": null,
      "delivery_contact_email": null,
      "delivery_contact_phone": null,
      "delivery_instructions": null,
      "packing_handling_requirements": null,
      "received_by": null,
      "delivery_exception_notes": null,
      "exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=23456&riType=4&riSub=0&riId=12345"
    }
  ]
}
Note: IDs are illustrative; use IDs from your workspace. The filename is an example.

Add a Shipment #

Method
POST
Endpoint

Adds a Shipment to an Event.

Parameters
Name Type Required? Description Details
event_id Number Yes
The ID of the Event.
The Shipment will be added to this Event.
name String Yes
A name describing what is being sent.
Up to 200 characters. Required; enter a nonblank name.
tracking_number String No
The carrier's tracking number for the Shipment.
Up to 125 characters. Omit for no value.
carrier_id Number No
The carrier handling the Shipment.
Use a current ID from GET /v1/references/shipment_carriers. Null means Not Specified. other_carrier_name applies only to Other (1); choosing another carrier clears that custom name.
other_carrier_name String No
The carrier's name when carrier_id is Other (1).
Literal text, trimmed to the first 200 characters without splitting a Unicode surrogate pair. For any other carrier, the custom name is cleared. Omit for no value.
pickup_date String No
The planned or recorded pickup date.
Use a calendar date in YYYY-MM-DD format, without a time or time zone. Omit for no value. This does not automatically change Shipment status.
delivery_date String No
The planned or recorded delivery date.
Use a calendar date in YYYY-MM-DD format, without a time or time zone. Omit for no value. This does not automatically change Shipment status.
pickup_location String No
Where the Shipment will be picked up.
Up to 400 characters. Omit for no value.
delivery_location String No
Where the Shipment should be delivered.
Up to 400 characters. Omit for no value.
notes String No
General notes about this Shipment.
Send plain text; line breaks are kept. If you send HTML, only its text is saved. Both the saved text and the ExhibitDay editor's character count must fit within 30,000 characters; line breaks and characters such as & and < take extra space when saved. Omit for no value. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
payment_status_id Number No
The Shipment's payment status. Omit for N/A. A status other than Partially Paid clears the next partial payment due date.
Allowed values: 0 (N/A) | 1 (Paid in Full) | 2 (Partially Paid) | 3 (Not Paid Yet)
payment_due_date String No
The Shipment payment due date.
Use a calendar date in YYYY-MM-DD format, without a time or time zone. Omit for no value.
next_payment_due_date Date No
The next partial payment due date.
Use a calendar date in YYYY-MM-DD format, without a time or time zone. Applies only to Partially Paid (2). Supplying it with another payment status clears the date; choosing another status also clears it. Omit for no value.
payment_notes String No
Notes about the Shipment payment.
Up to 200 characters. Omit for no value.
shipment_status_id Number No
The Shipment's current status. Omit or send null for Not Specified. Pickup/delivery dates, costs and tracking do not automatically change this status.
Allowed values: 1 (Not Shipped Yet) | 2 (Shipped) | 3 (Delivered) | 4 (Canceled)
service_level String No
The carrier service or delivery speed, such as overnight.
Up to 200 characters. Omit for no value.
shipment_reference_number String No
Your reference number for the Shipment.
Up to 200 characters. Omit for no value.
pickup_contact_name String No
The name of the person arranging pickup.
Up to 200 characters. Omit for no value.
pickup_contact_email String No
The pickup contact's email address.
Up to 200 characters. Omit for no value.
pickup_contact_phone String No
The pickup contact's phone number.
Up to 200 characters. Omit for no value.
pickup_instructions String No
Instructions for collecting the Shipment.
Send plain text; line breaks are kept. If you send HTML, only its text is saved. Both the saved text and the ExhibitDay editor's character count must fit within 30,000 characters; line breaks and characters such as & and < take extra space when saved. Omit for no value. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
delivery_contact_name String No
The name of the person receiving delivery.
Up to 200 characters. Omit for no value.
delivery_contact_email String No
The delivery contact's email address.
Up to 200 characters. Omit for no value.
delivery_contact_phone String No
The delivery contact's phone number.
Up to 200 characters. Omit for no value.
delivery_instructions String No
Instructions for delivering the Shipment.
Send plain text; line breaks are kept. If you send HTML, only its text is saved. Both the saved text and the ExhibitDay editor's character count must fit within 30,000 characters; line breaks and characters such as & and < take extra space when saved. Omit for no value. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
packing_handling_requirements String No
Packing, handling, temperature, equipment or documentation requirements.
Send plain text; line breaks are kept. If you send HTML, only its text is saved. Both the saved text and the ExhibitDay editor's character count must fit within 30,000 characters; line breaks and characters such as & and < take extra space when saved. Omit for no value. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
received_by String No
The name of the person who received the Shipment.
Up to 200 characters. Omit for no value.
delivery_exception_notes String No
Problems or exceptions to record about the delivery.
Send plain text; line breaks are kept. If you send HTML, only its text is saved. Both the saved text and the ExhibitDay editor's character count must fit within 30,000 characters; line breaks and characters such as & and < take extra space when saved. Omit for no value. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
components JSON object/list No
The complete list of packages or other items in this Shipment.
View value format and limits

File uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.

{
  "type": "array",
  "items": {
    "type": "object",
    "additionalProperties": false,
    "properties": {
      "id": {
        "type": "integer",
        "format": "int64",
        "description": "The existing component id, only on PATCH. It must belong to this Shipment. Omit it for a new component, or to match an unchanged component by all its values.",
        "nullable": true
      },
      "component_type_id": {
        "type": "integer",
        "format": "int32",
        "description": "An optional Shipment component type id (Shipment Item Type) from GET /v1/references/shipment_component_types. Null means Not Specified.",
        "nullable": true
      },
      "description": {
        "type": "string",
        "description": "Optional literal text up to 100 characters. At least one component detail must be supplied.",
        "maxLength": 100,
        "minLength": 0,
        "nullable": true
      },
      "tracking_number": {
        "type": "string",
        "description": "Optional literal tracking number up to 125 characters.",
        "maxLength": 125,
        "minLength": 0,
        "nullable": true
      },
      "dimensions_length": {
        "type": "number",
        "description": "Optional nonnegative length with at most two decimal places, in the workspace measurement units returned with the Shipment.",
        "minimum": 0.0,
        "maximum": 99999999999999999.99,
        "nullable": true
      },
      "dimensions_width": {
        "type": "number",
        "description": "Optional nonnegative width with at most two decimal places, in the workspace measurement units returned with the Shipment.",
        "minimum": 0.0,
        "maximum": 99999999999999999.99,
        "nullable": true
      },
      "dimensions_height": {
        "type": "number",
        "description": "Optional nonnegative height with at most two decimal places, in the workspace measurement units returned with the Shipment.",
        "minimum": 0.0,
        "maximum": 99999999999999999.99,
        "nullable": true
      },
      "weight": {
        "type": "number",
        "description": "Optional nonnegative weight with at most two decimal places, in the workspace measurement units returned with the Shipment.",
        "minimum": 0.0,
        "maximum": 99999999999999999.99,
        "nullable": true
      }
    },
    "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants are rejected"
  },
  "maxItems": 500,
  "nullable": true,
  "x-maximum-depth": 3,
  "x-empty-create-means-omitted": true,
  "example": [
    {
      "component_type_id": null,
      "description": "Exhibit crate",
      "weight": 125.5
    }
  ]
}
A JSON array of up to 500 objects. Each object may contain id, component_type_id (an ID from GET /v1/references/shipment_component_types), description (literal text, up to 100 characters), tracking_number (literal text, up to 125 characters), and dimensions_length, dimensions_width, dimensions_height and weight. Measurements must be nonnegative, at most 99999999999999999.99, with no more than two decimal places. Use the dimensions_unit and weight_unit returned by GET /v1/events/shipments/info. At least one component detail must be present. To keep or change an existing component, send its id; an id that is not one of this Shipment's components is refused with 400 (invalid_request, error_params components). Leave id out to add a new component. component_type_id is a Shipment Item Type ID, shown with its name as component_type in Shipment reads; null means Not Specified. Omit for no components. Existing component IDs are not accepted on add.
cost Number or cost object No
The full cost, as a number or an object with amount and/or cost_center_breakdown. Record Costs and Split Them Across Cost Centers.
View value format and limits

File uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.

{
  "anyOf": [
    {
      "type": "number",
      "minimum": 0,
      "description": "Shorthand for an object with amount. The amount is rounded to cents before the supported storage range is checked.",
      "nullable": true
    },
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "amount": {
          "type": "number",
          "minimum": 0.0,
          "maximum": 79228162514264337593543950335.0
        },
        "cost_center_breakdown": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "cost_center_id": {
                "type": "integer",
                "format": "int64",
                "nullable": true
              },
              "charge": {
                "type": "number",
                "minimum": 0.0,
                "maximum": 79228162514264337593543950335.0
              },
              "cost_center": {
                "type": "string",
                "description": "Optional and read-only: the cost center name a read returns, so a cost can be sent back unchanged. It is ignored; the line is saved by cost_center_id, and a name that doesn't match that cost center is explained in a warning.",
                "nullable": true
              }
            },
            "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants are rejected",
            "required": [
              "charge"
            ]
          },
          "maxItems": 2147483647
        }
      },
      "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants are rejected",
      "anyOf": [
        {
          "required": [
            "amount"
          ]
        },
        {
          "required": [
            "cost_center_breakdown"
          ]
        }
      ],
      "nullable": true
    }
  ],
  "x-numeric-shorthand": "A number is equivalent to {amount:number}.",
  "nullable": true,
  "x-maximum-depth": 3,
  "x-empty-create-means-omitted": true,
  "example": {
    "amount": 125.50
  }
}
Optional; defaults to zero.
$result_format String No
By default, the response is a single object. Send array to get it inside a one-item array.
Allowed values: array | object
Idempotency-Key String No
A unique key for safely retrying this add request.
Optional HTTP header: 1 to 255 visible ASCII characters without spaces or commas. Retry the identical request with the same key to replay its first saved response. Use a new key for a different request.
$ignore_params_with_empty_values Boolean No
Whether supplied JSON null values should be omitted.
Default: false. With true, actual JSON null fields and component lists are omitted. Ordinary null or blank add fields are already omitted; the required name must still be supplied.

Good to know

Adds a Shipment to an Event. Record what is being sent, its carrier and delivery plans, and any packages or other components.

Carrier, status and dates

Choose the carrier from the current reference list. Only Other (1) uses other_carrier_name. The optional custom name is literal text; only its first 200 characters are kept.

Shipment status is a choice you make. Recording pickup/delivery dates, tracking numbers or costs does not change it or contact a carrier. Dates are calendar dates with no time or time zone conversion. Linking an asset reservation records the connection without reserving stock or changing inventory.

Adding components

Use components for the packages, crates or other items in this Shipment. Each object needs at least a type, description, tracking number or measurement. Omit id for new components; existing IDs are not accepted when adding a Shipment.

Dimensions and weight use this workspace's units. Component descriptions and tracking numbers are literal text; commas can be supplied in JSON or form/query fields.

After the add

The response includes the new Shipment, its components and its id. The change is recorded in Event history. File Attachments and the Invoice Attachment are uploaded separately.

Recording costs does not attach an invoice, mark a payment complete or change the Event's planned Shipments budget. If a save outcome cannot be confirmed, retrieve the current Shipment before deciding whether to retry.

Access

The Event's Shipments tab must be available, visible and unlocked, and your current access must allow the change.

Sending values

Use JSON, query parameters or form fields for text containing commas and components.

Sending text

Send plain text for Notes and other rich-text fields. Characters such as &, < and quotes, along with line breaks, are encoded for storage.

Notes and other rich-text values in the response contain the stored HTML, including encoded characters and line breaks such as <br />.

Hidden or locked tab

If the Event's Shipments tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first. An Event that is not in your workspace returns HTTP 404.

Open in ExhibitDay

The created record includes exhibitday_url, the record's page in ExhibitDay. It is the same link that GET /v1/events/shipments/info returns for this record and opens the record in view mode on its Event's tab. Sign in with an account that can view the record; ExhibitDay checks access when the link is opened.

Code Samples
curl -X POST "https://api.exhibitday.com/v1/events/shipments" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"event_id\":12345,\"name\":\"Exhibit materials to Annual Expo\"}"

Example response

{
  "id": 12345,
  "event_id": 12345,
  "event_name": "Sample Event",
  "carrier": null,
  "tracking_url": null,
  "shipment_status": "Not Specified",
  "payment_status": {
    "id": 0,
    "name": "N/A"
  },
  "dimensions_unit": "in",
  "weight_unit": "lb",
  "components": [],
  "cost": {
    "amount": 0.00,
    "cost_center_breakdown": []
  },
  "name": "Exhibit materials to Annual Expo",
  "tracking_number": null,
  "carrier_id": null,
  "other_carrier_name": null,
  "pickup_date": null,
  "delivery_date": null,
  "pickup_location": null,
  "delivery_location": null,
  "notes": "",
  "payment_status_id": 0,
  "payment_due_date": null,
  "next_payment_due_date": null,
  "payment_notes": null,
  "invoice_attachment": null,
  "shipment_status_id": null,
  "service_level": null,
  "shipment_reference_number": null,
  "pickup_contact_name": null,
  "pickup_contact_email": null,
  "pickup_contact_phone": null,
  "pickup_instructions": null,
  "delivery_contact_name": null,
  "delivery_contact_email": null,
  "delivery_contact_phone": null,
  "delivery_instructions": null,
  "packing_handling_requirements": null,
  "received_by": null,
  "delivery_exception_notes": null,
  "exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=12345&riType=4&riSub=0&riId=12345"
}
Note: IDs are illustrative; use IDs from your workspace.

Update a Shipment #

Method
PATCH
Endpoint

Updates an existing Shipment.

Parameters
Name Type Required? Description Details
id Number Yes
The ID of the Shipment.
Use its id from the list, single-record read or add response. This identifies the Shipment, rather than a component or file.
name String No
A name describing what is being sent.
Up to 200 characters. Omit or leave blank to keep it; null cannot clear it. Renaming also updates an existing valid Invoice Attachment's label.
tracking_number String No
The carrier's tracking number for the Shipment.
Up to 125 characters. Omit or leave blank to keep it; null clears it.
carrier_id Number No
The carrier handling the Shipment.
Use a current ID from GET /v1/references/shipment_carriers. Null means Not Specified. other_carrier_name applies only to Other (1); choosing another carrier clears that custom name. Omit or leave blank to keep it.
other_carrier_name String No
The carrier's name when carrier_id is Other (1).
Literal text, trimmed to the first 200 characters without splitting a Unicode surrogate pair. For any other carrier, the custom name is cleared. Omit or leave blank to keep it; null clears it.
pickup_date String No
The planned or recorded pickup date.
Use a calendar date in YYYY-MM-DD format, without a time or time zone. Omit or leave blank to keep it; null clears it. This does not automatically change Shipment status.
delivery_date String No
The planned or recorded delivery date.
Use a calendar date in YYYY-MM-DD format, without a time or time zone. Omit or leave blank to keep it; null clears it. This does not automatically change Shipment status.
pickup_location String No
Where the Shipment will be picked up.
Up to 400 characters. Omit or leave blank to keep it; null clears it.
delivery_location String No
Where the Shipment should be delivered.
Up to 400 characters. Omit or leave blank to keep it; null clears it.
notes String No
General notes about this Shipment.
Send plain text; line breaks are kept. If you send HTML, only its text is saved. Both the saved text and the ExhibitDay editor's character count must fit within 30,000 characters; line breaks and characters such as & and < take extra space when saved. Omit or leave blank to keep it; null clears it. Existing over-limit content can stay unchanged or be shortened, but neither count may grow. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
payment_status_id Number No
The Shipment's payment status. Omit or leave blank to keep it; null resets it to N/A. A status other than Partially Paid clears the next partial payment due date.
Allowed values: 0 (N/A) | 1 (Paid in Full) | 2 (Partially Paid) | 3 (Not Paid Yet)
payment_due_date String No
The Shipment payment due date.
Use a calendar date in YYYY-MM-DD format, without a time or time zone. Omit or leave blank to keep it; null clears it.
next_payment_due_date Date No
The next partial payment due date.
Use a calendar date in YYYY-MM-DD format, without a time or time zone. Applies only to Partially Paid (2). Supplying it with another payment status clears the date; choosing another status also clears it. Omit or leave blank to keep it; null clears it.
payment_notes String No
Notes about the Shipment payment.
Up to 200 characters. Omit or leave blank to keep it; null clears it.
shipment_status_id Number No
The Shipment's current status. Omit or leave blank to keep it; null means Not Specified. Pickup/delivery dates, costs and tracking do not automatically change this status.
Allowed values: 1 (Not Shipped Yet) | 2 (Shipped) | 3 (Delivered) | 4 (Canceled)
service_level String No
The carrier service or delivery speed, such as overnight.
Up to 200 characters. Omit or leave blank to keep it; null clears it.
shipment_reference_number String No
Your reference number for the Shipment.
Up to 200 characters. Omit or leave blank to keep it; null clears it.
pickup_contact_name String No
The name of the person arranging pickup.
Up to 200 characters. Omit or leave blank to keep it; null clears it.
pickup_contact_email String No
The pickup contact's email address.
Up to 200 characters. Omit or leave blank to keep it; null clears it.
pickup_contact_phone String No
The pickup contact's phone number.
Up to 200 characters. Omit or leave blank to keep it; null clears it.
pickup_instructions String No
Instructions for collecting the Shipment.
Send plain text; line breaks are kept. If you send HTML, only its text is saved. Both the saved text and the ExhibitDay editor's character count must fit within 30,000 characters; line breaks and characters such as & and < take extra space when saved. Omit or leave blank to keep it; null clears it. Existing over-limit content can stay unchanged or be shortened, but neither count may grow. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
delivery_contact_name String No
The name of the person receiving delivery.
Up to 200 characters. Omit or leave blank to keep it; null clears it.
delivery_contact_email String No
The delivery contact's email address.
Up to 200 characters. Omit or leave blank to keep it; null clears it.
delivery_contact_phone String No
The delivery contact's phone number.
Up to 200 characters. Omit or leave blank to keep it; null clears it.
delivery_instructions String No
Instructions for delivering the Shipment.
Send plain text; line breaks are kept. If you send HTML, only its text is saved. Both the saved text and the ExhibitDay editor's character count must fit within 30,000 characters; line breaks and characters such as & and < take extra space when saved. Omit or leave blank to keep it; null clears it. Existing over-limit content can stay unchanged or be shortened, but neither count may grow. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
packing_handling_requirements String No
Packing, handling, temperature, equipment or documentation requirements.
Send plain text; line breaks are kept. If you send HTML, only its text is saved. Both the saved text and the ExhibitDay editor's character count must fit within 30,000 characters; line breaks and characters such as & and < take extra space when saved. Omit or leave blank to keep it; null clears it. Existing over-limit content can stay unchanged or be shortened, but neither count may grow. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
received_by String No
The name of the person who received the Shipment.
Up to 200 characters. Omit or leave blank to keep it; null clears it.
delivery_exception_notes String No
Problems or exceptions to record about the delivery.
Send plain text; line breaks are kept. If you send HTML, only its text is saved. Both the saved text and the ExhibitDay editor's character count must fit within 30,000 characters; line breaks and characters such as & and < take extra space when saved. Omit or leave blank to keep it; null clears it. Existing over-limit content can stay unchanged or be shortened, but neither count may grow. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
components JSON object/list No
The complete list of packages or other items in this Shipment.
View value format and limits

File uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.

{
  "type": "array",
  "items": {
    "type": "object",
    "additionalProperties": false,
    "properties": {
      "id": {
        "type": "integer",
        "format": "int64",
        "description": "The existing component id, only on PATCH. It must belong to this Shipment. Omit it for a new component, or to match an unchanged component by all its values.",
        "nullable": true
      },
      "component_type_id": {
        "type": "integer",
        "format": "int32",
        "description": "An optional Shipment component type id (Shipment Item Type) from GET /v1/references/shipment_component_types. Null means Not Specified.",
        "nullable": true
      },
      "description": {
        "type": "string",
        "description": "Optional literal text up to 100 characters. At least one component detail must be supplied.",
        "maxLength": 100,
        "minLength": 0,
        "nullable": true
      },
      "tracking_number": {
        "type": "string",
        "description": "Optional literal tracking number up to 125 characters.",
        "maxLength": 125,
        "minLength": 0,
        "nullable": true
      },
      "dimensions_length": {
        "type": "number",
        "description": "Optional nonnegative length with at most two decimal places, in the workspace measurement units returned with the Shipment.",
        "minimum": 0.0,
        "maximum": 99999999999999999.99,
        "nullable": true
      },
      "dimensions_width": {
        "type": "number",
        "description": "Optional nonnegative width with at most two decimal places, in the workspace measurement units returned with the Shipment.",
        "minimum": 0.0,
        "maximum": 99999999999999999.99,
        "nullable": true
      },
      "dimensions_height": {
        "type": "number",
        "description": "Optional nonnegative height with at most two decimal places, in the workspace measurement units returned with the Shipment.",
        "minimum": 0.0,
        "maximum": 99999999999999999.99,
        "nullable": true
      },
      "weight": {
        "type": "number",
        "description": "Optional nonnegative weight with at most two decimal places, in the workspace measurement units returned with the Shipment.",
        "minimum": 0.0,
        "maximum": 99999999999999999.99,
        "nullable": true
      }
    },
    "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants are rejected"
  },
  "maxItems": 500,
  "nullable": true,
  "x-maximum-depth": 3,
  "x-empty-create-means-omitted": true,
  "example": [
    {
      "component_type_id": null,
      "description": "Exhibit crate",
      "weight": 125.5
    }
  ]
}
A JSON array of up to 500 objects. Each object may contain id, component_type_id (an ID from GET /v1/references/shipment_component_types), description (literal text, up to 100 characters), tracking_number (literal text, up to 125 characters), and dimensions_length, dimensions_width, dimensions_height and weight. Measurements must be nonnegative, at most 99999999999999999.99, with no more than two decimal places. Use the dimensions_unit and weight_unit returned by GET /v1/events/shipments/info. At least one component detail must be present. To keep or change an existing component, send its id; an id that is not one of this Shipment's components is refused with 400 (invalid_request, error_params components). Leave id out to add a new component. component_type_id is a Shipment Item Type ID, shown with its name as component_type in Shipment reads; null means Not Specified. Omit or leave blank to keep the list; null or [] clears it. With $ignore_params_with_empty_values=true, a JSON null is ignored instead. See Replacing components below.
cost Number or cost object No
The full cost, as a number or an object with amount and/or cost_center_breakdown. Record Costs and Split Them Across Cost Centers.
View value format and limits

File uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.

{
  "anyOf": [
    {
      "type": "number",
      "minimum": 0,
      "description": "Shorthand for an object with amount. The amount is rounded to cents before the supported storage range is checked.",
      "nullable": true
    },
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "amount": {
          "type": "number",
          "minimum": 0.0,
          "maximum": 79228162514264337593543950335.0
        },
        "cost_center_breakdown": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "cost_center_id": {
                "type": "integer",
                "format": "int64",
                "nullable": true
              },
              "charge": {
                "type": "number",
                "minimum": 0.0,
                "maximum": 79228162514264337593543950335.0
              },
              "cost_center": {
                "type": "string",
                "description": "Optional and read-only: the cost center name a read returns, so a cost can be sent back unchanged. It is ignored; the line is saved by cost_center_id, and a name that doesn't match that cost center is explained in a warning.",
                "nullable": true
              }
            },
            "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants are rejected",
            "required": [
              "charge"
            ]
          },
          "maxItems": 2147483647
        }
      },
      "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants are rejected",
      "anyOf": [
        {
          "required": [
            "amount"
          ]
        },
        {
          "required": [
            "cost_center_breakdown"
          ]
        }
      ],
      "nullable": true
    }
  ],
  "x-numeric-shorthand": "A number is equivalent to {amount:number}.",
  "nullable": true,
  "x-maximum-depth": 3,
  "x-empty-create-means-omitted": true,
  "example": {
    "amount": 125.50
  }
}
Omit to keep the saved cost. A supplied value replaces its full allocation.
expected_revision String No
The record_revision from an earlier read of this Shipment.
Optional. Obtain it from GET /v1/events/shipments/info with $include_record_revision=true. A changed Shipment returns HTTP 409 without saving this update. Omission skips the check; blank, null and malformed values are refused, even with $ignore_params_with_empty_values=true.
$ignore_params_with_empty_values Boolean No
Whether supplied JSON null values should be omitted.
Default: false. With true, actual JSON null fields and component lists are omitted. Nonempty top-level text null still requests clearing where supported. Nonclearable fields and expected_revision validation still apply.

Good to know

Updates a Shipment's carrier, pickup and delivery plans, components or payment information. Send only the fields you want to change.

Carrier, status and dates

Choose the carrier from the current reference list. Only Other (1) uses other_carrier_name. The optional custom name is literal text; only its first 200 characters are kept.

Shipment status is a choice you make. Recording pickup/delivery dates, tracking numbers or costs does not change it or contact a carrier. Dates are calendar dates with no time or time zone conversion. Linking an asset reservation records the connection without reserving stock or changing inventory.

Replacing components

A supplied components array is the entire desired list. Include every component you want to keep; any current component omitted from that array is removed. Omit the whole parameter to leave the list alone. Null or [] clears it, except actual JSON null is omitted under true ignore-empty.

Use an existing component's id to update that component in this Shipment. Omit id to add a component or match an unchanged component by all its values. Identical unchanged components keep their IDs and creation times even if the list order changes. Each supplied object is complete: omitted optional members become empty.

Choosing what to change

Omitted or blank top-level fields keep their values. Null clears or resets supported fields; name cannot be cleared. Clearing payment_status_id resets it to N/A. With ignore-empty true, actual JSON null is omitted instead.

An unchanged request saves no business data or history and keeps its revision, component IDs, creation times and invoice label. File Attachments and the Invoice Attachment are managed separately.

Using expected_revision

  1. Retrieve this Shipment with GET /v1/events/shipments/info and $include_record_revision=true.
  2. Send the returned record_revision unchanged as expected_revision with this update.
  3. If the API reports a change, read the current Shipment and decide what to update.

After the update

A real change is recorded in Event history. Renaming also updates an existing valid Invoice Attachment's label without replacing its contents.

Recording costs does not attach an invoice, mark a payment complete or change the Event's planned Shipments budget. If a save outcome cannot be confirmed, retrieve the current Shipment before deciding whether to retry.

Access

The Event's Shipments tab must be available, visible and unlocked, and your current access must allow the change.

Sending values

Use JSON, query parameters or form fields for text containing commas and components.

Sending text

Send plain text for Notes and other rich-text fields. Characters such as &, < and quotes, along with line breaks, are encoded for storage.

Hidden or locked tab

If the Event's Shipments tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first. An Event that is not in your workspace returns HTTP 404.

Code Samples
curl -X PATCH "https://api.exhibitday.com/v1/events/shipments" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"id\":12345,\"name\":\"Exhibit materials to Annual Expo\"}"

Example response

{
  "status_code": 200,
  "status": "OK",
  "message": "Shipment updated.",
  "errors": []
}

Delete a Shipment #

Method
DELETE
Endpoint

Deletes an existing Shipment.

Note: Inputs that do not apply to this operation, including the ignore-empty option, are ignored and reported in the X-API-Warnings response header.

Parameters
Name Type Required? Description Details
id Number Yes
The ID of the Shipment.
Use its id from the list, single-record read or add response. This identifies the Shipment, rather than a component or file.

Good to know

Deletes a Shipment and its components, saved costs, related-item links, File Attachments and Invoice Attachment. Linked Tasks, asset reservations and other records remain in place.

After the deletion

The Shipment, its components, costs, related-item links and attachment records are removed together. Only its files are scheduled for physical cleanup after the save. Linked Tasks, asset reservations and other records remain.

The deletion is recorded in Event history. An unavailable Shipment returns HTTP 404. If the save outcome cannot be confirmed, retrieve the current Shipments before deciding whether to retry.

Access

The Event's Shipments tab must be available, visible and unlocked, and your current access must allow the change.

Hidden or locked tab

If the Event's Shipments tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first. An Event that is not in your workspace returns HTTP 404.

Code Samples
curl -X DELETE "https://api.exhibitday.com/v1/events/shipments?id=12345" -H "Authorization: Bearer YOUR_API_KEY"

Example response

{
  "status_code": 200,
  "status": "OK",
  "message": "Shipment removed.",
  "errors": []
}

Download Shipment Invoice Attachment #

Method
GET
Endpoint

Downloads the Invoice Attachment for a Shipment.

Parameters
Name Type Required? Description Details
shipment_id Number Yes
The ID of the Shipment, from Retrieve Shipments (GET /v1/events/shipments) or its add response.

Good to know

Downloads the original Invoice Attachment for this Shipment. Use this method to retrieve the file itself.

Finding the file

In the web app, this is the invoice control beside the Shipment's cost and payment details. Each cost has one Invoice Attachment even when its amount is split among cost centers.

For file metadata, retrieve the parent record with GET /v1/events/shipments/info and read invoice_attachment. Use this download method for the contents. No attachment ID or invoice flag is needed.

Download response

A successful response contains the original uploaded file, with a safe download filename. API errors use the usual JSON response. If no invoice is attached, this method returns HTTP 404.

Current record, financial and invoice permissions apply. A locked tab can still be read. Permitted downloads remain available on the Free plan.

Files still being copied

If this file is still being copied, the download returns HTTP 409 with file_copy_pending. Try the download again in a few minutes.

Hidden tab

If the Event's Shipments tab is hidden, this request returns HTTP 400 (not_allowed), and the message says the tab is hidden. Show the tab in ExhibitDay first. A locked tab can still be read.

Code Samples
# bash; inspect an error body instead of saving it as the requested file.
status=$(curl --silent --show-error -X GET "https://api.exhibitday.com/v1/events/shipments/invoice_attachment/download?shipment_id=12345" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}")
if [ "$status" != 200 ]; then cat response-body.tmp; exit 1; fi
mv response-body.tmp 'invoice.pdf'

Example response

File: invoice.pdf
Content type: application/octet-stream
Note: The response body contains file bytes.

Add Shipment Invoice Attachment #

Method
POST
Endpoint

Adds an Invoice Attachment to a Shipment.

Parameters
Name Type Required? Description Details
shipment_id Number Yes
The ID of the Shipment, from Retrieve Shipments (GET /v1/events/shipments) or its add response.
file File (multipart) Yes
The Invoice Attachment to upload.

Maximum size per file: 25 MiB (26,214,400 bytes).

Allowed file types: .png, .jpg, .jpeg, .bmp, .gif, .pdf, .msg, .eml, .doc, .docx, .ppt, .pptx, .xls, .xlsx, .csv, .rtf, .odp, .odt, .ods, .txt, .wks, .zip.

Maximum files per request: 1.

View value format and limits

File uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.

{
  "type": "string",
  "format": "binary",
  "x-maximum-bytes": 26214400,
  "x-allowed-extensions": [
    "png",
    "jpg",
    "jpeg",
    "bmp",
    "gif",
    "pdf",
    "msg",
    "eml",
    "doc",
    "docx",
    "ppt",
    "pptx",
    "xls",
    "xlsx",
    "csv",
    "rtf",
    "odp",
    "odt",
    "ods",
    "txt",
    "wks",
    "zip"
  ]
}
Send exactly one complete, nonempty multipart/form-data file part named file. The supported extensions and current per-file limit are shown below; the complete request limit also includes multipart overhead. A missing or null file is invalid and does not remove an existing invoice.
Idempotency-Key String No
A unique key for safely retrying this upload.
Optional HTTP header: 1 to 255 visible ASCII characters without spaces or commas. Retry the identical request with the same key to replay its first saved response. Use a new key for a different upload.

Good to know

Adds one Invoice Attachment to this Shipment. You can attach an invoice, receipt or other payment document when no invoice file is currently attached.

Before you upload

POST requires an empty invoice slot. If an invoice is already attached, the API returns HTTP 409; use PATCH to replace it.

An Invoice Attachment is separate from the record's supporting File Attachments. Use the invoice control beside the Shipment's cost and payment details in the web app.

After the upload

The response's invoice_attachment contains the attached file's id, filename and attachment_created_timestamp. The amount, payment fields, cost-center breakdown and other files are unchanged.

The upload is recorded in Event history. Attaching an invoice does not mark the record as paid.

Access and retries

A current upload-enabled plan, record and financial permissions, and an editable applicable tab are required. Each uploaded file must fit its supported type and size limits.

expected_revision is not supported by this file method. If the save outcome cannot be confirmed, retrieve the current parent record with GET /v1/events/shipments/info and inspect invoice_attachment before deciding whether to retry.

Hidden or locked tab

If the Event's Shipments tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first.

Code Samples
# bash; inspect an error body instead of saving it as the requested file.
status=$(curl --silent --show-error -X POST "https://api.exhibitday.com/v1/events/shipments/invoice_attachment" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}" --form-string "shipment_id=12345" --form "file=@invoice.pdf;type=application/octet-stream")
if [ "$status" != 200 ]; then cat response-body.tmp; exit 1; fi
cat response-body.tmp

Example response

{
  "invoice_attachment": {
    "id": 12345,
    "filename": "invoice.pdf",
    "attachment_created_timestamp": "2027-01-30T12:00:00Z"
  }
}
Note: IDs are illustrative; use IDs from your workspace. The filename is an example.

Replace Shipment Invoice Attachment #

Method
PATCH
Endpoint

Replaces a Shipment's Invoice Attachment.

Parameters
Name Type Required? Description Details
shipment_id Number Yes
The ID of the Shipment, from Retrieve Shipments (GET /v1/events/shipments) or its add response.
file File (multipart) Yes
The Invoice Attachment to upload.

Maximum size per file: 25 MiB (26,214,400 bytes).

Allowed file types: .png, .jpg, .jpeg, .bmp, .gif, .pdf, .msg, .eml, .doc, .docx, .ppt, .pptx, .xls, .xlsx, .csv, .rtf, .odp, .odt, .ods, .txt, .wks, .zip.

Maximum files per request: 1.

View value format and limits

File uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.

{
  "type": "string",
  "format": "binary",
  "x-maximum-bytes": 26214400,
  "x-allowed-extensions": [
    "png",
    "jpg",
    "jpeg",
    "bmp",
    "gif",
    "pdf",
    "msg",
    "eml",
    "doc",
    "docx",
    "ppt",
    "pptx",
    "xls",
    "xlsx",
    "csv",
    "rtf",
    "odp",
    "odt",
    "ods",
    "txt",
    "wks",
    "zip"
  ]
}
Send exactly one complete, nonempty multipart/form-data file part named file. The supported extensions and current per-file limit are shown below; the complete request limit also includes multipart overhead. A missing or null file is invalid and does not remove an existing invoice.

Good to know

Replaces this Shipment's current Invoice Attachment with one uploaded file. Use this method when an invoice file is already attached.

Replacing the current file

PATCH requires a current invoice file. If none is attached, the API returns HTTP 404. Upload exactly one file; the previous attachment ID is not needed.

If another request changes the current invoice during your upload, the API refuses this request instead of replacing a different file. Even identical replacement contents receive a new attachment ID.

After the replacement

The response's invoice_attachment contains the attached file's id, filename and attachment_created_timestamp. The amount, payment fields, cost-center breakdown and other files are unchanged.

The previous file is scheduled for physical cleanup after a confirmed save; cleanup may finish later. The replacement is recorded in Event history.

Access and retries

A current upload-enabled plan, record and financial permissions, and an editable applicable tab are required. Each uploaded file must fit its supported type and size limits.

expected_revision is not supported by this file method. PATCH does not use Idempotency-Key replay. If the save outcome cannot be confirmed, retrieve the current parent record with GET /v1/events/shipments/info and inspect invoice_attachment before deciding whether to retry.

Hidden or locked tab

If the Event's Shipments tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first.

Code Samples
# bash; inspect an error body instead of saving it as the requested file.
status=$(curl --silent --show-error -X PATCH "https://api.exhibitday.com/v1/events/shipments/invoice_attachment" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}" --form-string "shipment_id=12345" --form "file=@invoice.pdf;type=application/octet-stream")
if [ "$status" != 200 ]; then cat response-body.tmp; exit 1; fi
cat response-body.tmp

Example response

{
  "invoice_attachment": {
    "id": 12345,
    "filename": "invoice.pdf",
    "attachment_created_timestamp": "2027-01-30T12:00:00Z"
  }
}
Note: IDs are illustrative; use IDs from your workspace. The filename is an example.

Remove Shipment Invoice Attachment #

Method
DELETE
Endpoint

Deletes a Shipment's Invoice Attachment.

Note: Inputs that do not apply to this operation, including the ignore-empty option, are ignored and reported in the X-API-Warnings response header.

Parameters
Name Type Required? Description Details
shipment_id Number Yes
The ID of the Shipment, from Retrieve Shipments (GET /v1/events/shipments) or its add response.

Good to know

Removes this Shipment's Invoice Attachment. The cost, payment details and other File Attachments stay in place.

After the removal

The Invoice Attachment is cleared and the removal is recorded in Event history. Its physical file is scheduled for cleanup after a confirmed save; cleanup may finish later. Costs, payment fields, cost-center allocations and supporting files stay unchanged.

If no invoice is attached, DELETE returns HTTP 404 Not Found with the message "This Shipment has no invoice to remove." No saved data or history is changed. Current access and the record's binding are still checked. Do not send file parts with this request.

Access and retries

Current record, financial and invoice permissions and applicable tab-edit access are required. Permitted removals remain available on the Free plan.

expected_revision is not supported, and DELETE does not use Idempotency-Key replay. If the save outcome cannot be confirmed, retrieve the current parent record with GET /v1/events/shipments/info and inspect invoice_attachment before deciding whether to retry.

Hidden or locked tab

If the Event's Shipments tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first.

Code Samples
curl -X DELETE "https://api.exhibitday.com/v1/events/shipments/invoice_attachment?shipment_id=12345" -H "Authorization: Bearer YOUR_API_KEY"

Example response

{
  "status_code": 200,
  "status": "OK",
  "message": "Attachment removed.",
  "errors": []
}

Retrieve Shipment General File Attachments #

Method
GET
Endpoint

Retrieves the General File Attachments on a Shipment.

Parameters
Name Type Required? Description Details
shipment_id Number Yes
The ID of the Shipment, from Retrieve Shipments (GET /v1/events/shipments) or its add response.
$limit Number No
The most File Attachments to return.
A positive whole number. Omit for all remaining matching files.
$offset Number No
The number of matching File Attachments to skip.
A whole number of 0 or more. Default: 0.
$result_format String No
By default, the response is an object containing list_data and the paging totals (records_found, total_records, has_more). Send array to get just a JSON array of the records.
Allowed values: array
If-None-Match String No
An ETag from an earlier response to this GET.
Optional HTTP header. If the successful response is unchanged, the API returns HTTP 304 with no body.

Good to know

Retrieves the General File Attachments on this Shipment. Each result includes the file's ID, name and added time; use the download method for its contents.

Reading the file list

Files are ordered by added time, then attachment ID, lowest first. Only files available under your current access are included.

Paging totals and X-Total-Count count all matching files before $limit and $offset are applied. A record with no files you can view returns an empty list. This list does not return edit revisions or support changed-since filtering.

Supporting files and invoices

These are the record's General File Attachments. Its cost Invoice Attachment is separate and has its own download and upload methods. Use this list's id values for these supporting-file downloads and removals.

Access

The record's Event and tab must be available, and the tab must not be hidden. A locked tab can still be read.

Hidden tab

If the Event's Shipments tab is hidden, this request returns HTTP 400 (not_allowed), and the message says the tab is hidden. Show the tab in ExhibitDay first. A locked tab can still be read.

Code Samples
curl -X GET "https://api.exhibitday.com/v1/events/shipments/attachments?shipment_id=12345" -H "Authorization: Bearer YOUR_API_KEY"

Example response

{
  "records_found": 1,
  "total_records": 1,
  "has_more": false,
  "list_type": "attachment",
  "list_data": [
    {
      "id": 12345,
      "filename": "attachment.pdf",
      "attachment_created_timestamp": "2027-01-30T12:00:00Z"
    }
  ]
}
Note: IDs are illustrative; use IDs from your workspace. The filename is an example.

Add Shipment General File Attachments #

Method
POST
Endpoint

Adds General File Attachments to a Shipment.

Parameters
Name Type Required? Description Details
shipment_id Number Yes
The ID of the Shipment, from Retrieve Shipments (GET /v1/events/shipments) or its add response.
file File (multipart) Yes
The File Attachments to upload.

Maximum size per file: 25 MiB (26,214,400 bytes).

Allowed file types: .png, .jpg, .jpeg, .bmp, .gif, .pdf, .msg, .eml, .doc, .docx, .ppt, .pptx, .xls, .xlsx, .csv, .rtf, .odp, .odt, .ods, .txt, .wks, .zip.

View value format and limits

File uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.

{
  "type": "array",
  "items": {
    "type": "string",
    "format": "binary",
    "x-maximum-bytes": 26214400,
    "x-allowed-extensions": [
      "png",
      "jpg",
      "jpeg",
      "bmp",
      "gif",
      "pdf",
      "msg",
      "eml",
      "doc",
      "docx",
      "ppt",
      "pptx",
      "xls",
      "xlsx",
      "csv",
      "rtf",
      "odp",
      "odt",
      "ods",
      "txt",
      "wks",
      "zip"
    ]
  }
}
Send one or more complete, nonempty multipart/form-data parts, each named file. Supported types and the current per-file limit are shown below. The complete request limit includes all files and multipart overhead; split larger batches. A missing or null upload is not a removal request.
Idempotency-Key String No
A unique key for safely retrying this upload.
Optional HTTP header: 1 to 255 visible ASCII characters without spaces or commas. Retry the identical request with the same key to replay its first saved response. Use a new key for a different upload.

Good to know

Adds one or more General File Attachments to this Shipment. Send each file as a multipart upload part named file.

After the upload

The response's list_data contains the newly attached files, including each id, filename and attachment_created_timestamp. Existing files are kept. Use each returned id to download or remove that file.

Identical repeated files in one request are attached once when their cleaned filename, length and contents match. Files with different contents remain separate even when their names match. This does not remove or replace files already attached to the record.

Choosing the right file method

These uploads add General File Attachments. Use this record's Invoice Attachment methods for its cost invoice or receipt. Adding supporting files does not change amounts, payments or cost-center allocations.

Access

Current record and file-change permissions and applicable Event/tab locks must allow this upload. An upload-enabled paid plan is required.

History and retries

A confirmed file change is recorded in history. expected_revision is not supported by these file methods. If the save outcome cannot be confirmed, retrieve the current file list before deciding whether to retry; the API does not automatically repeat an uncertain change.

Supporting File Attachments have no PATCH replacement. To replace one, add the new file and remove the old one using their separate requests; each request has its own outcome.

Hidden or locked tab

If the Event's Shipments tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first.

Code Samples
# bash; inspect an error body instead of saving it as the requested file.
status=$(curl --silent --show-error -X POST "https://api.exhibitday.com/v1/events/shipments/attachments" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}" --form-string "shipment_id=12345" --form "file=@attachment.pdf;type=application/octet-stream")
if [ "$status" != 200 ]; then cat response-body.tmp; exit 1; fi
cat response-body.tmp

Example response

{
  "records_found": 1,
  "total_records": 1,
  "has_more": false,
  "list_type": "attachment",
  "list_data": [
    {
      "id": 12345,
      "filename": "attachment.pdf",
      "attachment_created_timestamp": "2027-01-30T12:00:00Z"
    }
  ]
}
Note: IDs are illustrative; use IDs from your workspace. The filename is an example.

Remove a Shipment General File Attachment #

Method
DELETE
Endpoint

Deletes a General File Attachment from a Shipment.

Note: Inputs that do not apply to this operation, including the ignore-empty option, are ignored and reported in the X-API-Warnings response header.

Parameters
Name Type Required? Description Details
id Number Yes
The ID of the File Attachment.
Use the id from the attachment list. The API finds the record the file belongs to, so no record ID is sent. An Invoice Attachment is not selected by this method.

Good to know

Removes one General File Attachment from this Shipment. Other attached files and the record's details stay in place.

After the removal

Only the selected file association is removed. Its physical file is scheduled for cleanup after a confirmed save; cleanup may finish later. Other attached files stay in place.

Send only the file's id; the API finds the record it belongs to. A missing, already removed or unavailable attachment returns HTTP 404 Not Found. Do not send file parts with DELETE.

Access

Current record and file-removal permissions and applicable Event/tab locks must allow this change. Permitted removals remain available on the Free plan.

History and retries

A confirmed file change is recorded in history. expected_revision is not supported by these file methods. DELETE does not use Idempotency-Key replay. If the save outcome cannot be confirmed, retrieve the current file list before deciding whether to retry; the API does not automatically repeat an uncertain change.

Supporting File Attachments have no PATCH replacement. To replace one, add the new file and remove the old one using their separate requests; each request has its own outcome.

Hidden or locked tab

If the Event's Shipments tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first.

Code Samples
curl -X DELETE "https://api.exhibitday.com/v1/events/shipments/attachments?id=12345" -H "Authorization: Bearer YOUR_API_KEY"

Example response

{
  "status_code": 200,
  "status": "OK",
  "message": "Attachment removed.",
  "errors": []
}

Download a Shipment General File Attachment #

Method
GET
Endpoint

Downloads a General File Attachment from a Shipment.

Parameters
Name Type Required? Description Details
id Number Yes
The ID of the File Attachment.
Use the id from the attachment list. The API finds the record the file belongs to, so no record ID is sent. An Invoice Attachment is not selected by this method.

Good to know

Downloads one original General File Attachment from this Shipment. Select the file using its ID from the attachment list.

Download response

A successful response contains the original uploaded file with a safe download filename. API errors use the usual JSON response. A missing or unavailable file returns HTTP 404.

Send only the file's id from the attachment list to download that one file; the API finds the record it belongs to. The download leaves the record unchanged.

Access

The record's Event and tab must be available, and the tab must not be hidden. A locked tab can still be read.

Files still being copied

If this file is still being copied, the download returns HTTP 409 with file_copy_pending. Try the download again in a few minutes.

Hidden tab

If the Event's Shipments tab is hidden, this request returns HTTP 400 (not_allowed), and the message says the tab is hidden. Show the tab in ExhibitDay first. A locked tab can still be read.

Code Samples
# bash; inspect an error body instead of saving it as the requested file.
status=$(curl --silent --show-error -X GET "https://api.exhibitday.com/v1/events/shipments/attachments/download?id=12345" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}")
if [ "$status" != 200 ]; then cat response-body.tmp; exit 1; fi
mv response-body.tmp 'attachment.pdf'

Example response

File: attachment.pdf
Content type: application/octet-stream
Note: The response body contains file bytes.