The same as state

the same as zip code but more common name in other countires

the street suffix such as "Dr" of "St"

If this address has been verified by USPS

The full string of the address

The formatted address with "\r" breaks for it to be formatted nicely if you render it into a textarea

The same as the city field

The delivery ID

The price of this rate as an integer with discount applied. (e.g., $15.76 would be represented as 1576).

The price of this rate as an integer without discounts applied. (e.g., $15.76 would be represented as 1576). This is the total amount that Dispatch charged your payment information in file.

The discount for this rate as an integer that you have specified. (e.g., $15.76 would be represented as 1576). This gets calculated based on your settings on the Dispatch dashboard.

Specified the branding for this delivery.

If an email will be sent by Dispatch, this determines which logo will be on the email.

Which logo should be placed on the label.

The courier object if the delivery is on demand. This will be deprecated in the future as the same data is found in the Provider object that is attached to the Rate.

Epoch time in seconds when this delivery was created.

A human readable string value for the estimated delivery date and time.

The grace period that an on_demand courier will wait for a delivery. If the sender is not ready, the grace period object explains the fees that will be incurred.

The amount as an integer that this delivery was billed for in the event of a grace period violation.

The grace period fee as an integer This it the fee that is charged per minute.

The amount of minutes that the grace period is good for.

This specifies the status of the payment that was collected

This is the duration in seconds that the courier waited for the delivery.

The status of the delivery intent. An intent can be "created" when rates were generated but not purchased yet, "expired" if the intent was not captured within 15 mins, "captured" which means that the intent was paid for, and "deleted" which is when the intent was removed from the database.

The name of the shipping label as saved in the storage bucket. @deprecated This property will be removed.

The url from which you can download your label. This URL, can be accessed for 48 hours until it expires. Each time that you retrieve a delivery, a new label url is generated for you.

The amount of lead time that was required for this delivery before an on_demand courier can pick it up.

The lat and lon coordinates of the the current location of the delivery. Not every courier supports this.

Key-value pairs of data that you have added to the delivery. When creating or purchasing a delivery, metadata can be passed in the options. You should never store sensitive information in key value pairs. Good uses for metadata would be to store an order ID or a customer ID from your database.

If this delivery is for an on_demand courier.

If this delivery was paid for.

An array of parcel objects, which are the boxes and items that were being transported.

The rate that was purchased by the customer.

If the label has a QR Code, this will be the url that is encoded on it.

An array of rates that are returned when the delivery intent was created.

The recipient object. This is the person who is getting the package.

The refund status if one was requested. Funds will be credited back to the account after the refund status is approved by the carrier. Dispatch couriers refunds are immediate.

The object representing the sender, which is the entity that initially sent that package.

The time in seconds from Epoch in seconds of the shipment date.

The tracking status for the delivery. For a complete list see the github readme.

The tracking substatus for the delivery. This gives much more detail about the package whereabouts. For a complete list see the github readme.

If this was a test delivery.

Indicates if dispatch will send update emails for the delivery. This value is set on your dashboard https://app.getdispatch.app/settings/company/branding.

The tracking number for the delivery.

The current tracking status for this delivery.

An array of all of the tracking updates for this delivery including the current one.

The type of delivery this is: "traditional" or "marketplace".

Epoch time in seconds.

The declared value of this delivery.

The entity ID

The address details of this entity.

The combined address string including city, state, and zipcode.

In most cases this is the same as the city. For U.S. shipment, just ignore this.

The full string of the the state such as "California or New York".

The abbreviation of the the state such as "CA or "NY".

@deprecated This is now just called state.

The name of the street from address_line1.

The number of the street from address_line1.

Will we the last part of the street name like "St" or "Ln".

If you will pre-fill an html textarea with the string, this includes the return values for the address to format into multiple lines.

The tz format for this addresses timezone. https://en.wikipedia.org/wiki/Tz_database

If this address was verified with USPS.

The address zipcode. This is the same value as postal_code.

The email address to contact this entity.

The name of this entity.

The phone number to contact this entity.

The source for the logo. The image is a 256 x 256 square png.

This logo is trimmed by us to remove the white space. Best used in emails. One of the sides is 256px, depending on the logo's shape.

The name of this item.

The item sku.

The item's price as an integer.

The item's declared values as an integer.

The id used to identify this product on your inventory system.

If this is a specific variant of a product id.

The length of the item in inches. Can use this for cheaper return labels if we know the box can be smaller.

The width of the item in inches. Can use this for cheaper return labels if we know the box can be smaller.

The height of the item in inches. Can use this for cheaper return labels if we know the box can be smaller.

The weight of the item in pounds. Can use this for cheaper return labels if we know the box can be lighter.

The street address for this delivery.

The second line of the street address if needed.

The name of the city.

The state. This can be the full state name like California or an abbreviation like NY.

The zipcode. Technically this is optional but highly recommended you add this because it makes the address parser much more accurate.

The type of box you're sending the items in. If you are using a box provided by a carrier, you'll only recieve rates from that carrier plus any on-demand couriers, if avaible.

The length of the parcel in inches.

The width of the parcel in inches.

The height of the parcel in inches.

The weight of the parcel in pounds.

Any special handling instructions that will be placed on the label. Limited to 12 characters. If you add more than 12 characters, we'll just use the first 12 instead of returning an error. The reason for the limit is that this is the most amount of characters that we can fit within the bounds of the current label.

A description of what you're sending like "Coffee". This can prove useful for basic analytics later on and is a nice touch for the tracking email that can let the recipient know what is in the box.

you can optionally include items that are in the box. This can be used for one click returns and custom disposition codes in the future.

The ID for this sender

This describes how branding is used by the user

If this sender has their logo displayed on email. Requires a Pro plan

If this sender has their logo displayed on shipping labels. Requires a Pro plan

If this sender wants dispatch to send tracking updates to recipients

The lead time this sender requires for deliveries

An array of objects that describe the rate cards this user has

The ID of the carrier this rate card is for

If this rate card is currently active

The ID of the rate card. The value is null if this rate card is for a Dispatch provided rate card

the logo url for the sender

the logo url for the sender with the wight space trimmed

Shows which requirements are needed for this sender. Some features may be unavaible if there are outstanding requirements

A list of all of the requirements that are due now. No deliveries can be created if there are requirements due

A list of requirements that are pending verification. These are normally resolved within 24 hours

These are errors that the account has. Accounts with errors could result in features of the account being disabled, such as the ability to purchase shipping labels

These are items that will be due in the future.

= An object that reflects the profile information for this sender

The phone number for this sender to be contacted for support

The email for this sender to be contacted for support

The name of this sender

The website for this sender

The headquarters address for the sender.

The time in seconds from Epoch that this sender was created

The time in seconds from Epoch that this sender was last updated

The preferences this user has for shipping labels

The format the labels will come in for the sender.

The price of this rate as an integer with discount applied. (e.g., $15.76 would be represented as 1576).

The price of this rate as an integer without discounts applied. (e.g., $15.76 would be represented as 1576). This is the total amount that Dispatch charged your payment information in file.

The discount for this rate as an integer that you have specified. (e.g., $15.76 would be represented as 1576). This gets calculated based on your settings on the Dispatch dashboard.

The carrier account / custom rate card that was used to price this rate.

The total cart/checkout value you submitted as an integer (e.g., $15.76 would be represented as 1576). This value is used to determine the free shipping tier that you can set up on the Dispatch dashboard.

Epoch time in seconds.

The currency of this rate card as lowercase ISO 4217 format https://en.wikipedia.org/wiki/ISO_4217

If this rate was originated by dispatch APIs.

Describes how long the delivery will take.

The ID of the service level. Something like "dispatch_same_day".

The human readable name of the service level. Something like "Same Day" or "USPS Overnight".

Epoch time seconds when this delivery is expected to arrive at its destination.

The amount of days that this delivery is estimated to take.

If this delivery is guaranteed by the arrives_by time

Epoch time in seconds when this order will be picked up.

The human readable string for the delivery date and time. For example: "Today by 9pm".

The grace period that an on_demand courier will wait for and the fees for going over it.

The amount that you were charged for going over a courier's grace period.

The amount that you were charged for going over a courier's grace period.

The amount of minutes that the grace period is good for.

The status of your payment.

The amount of seconds the courier waited for.

the id of this rate. This id will be passed to dispatch to purchase the rate.

If the rate is generated by an on demand courier from dispatch, this will be a breakdown of the total cost. Otherwise will be null.

The cost for additional items if the order contained multiple packages and the courier changes this fee.

The fixed dropoff fee that this courier charges.

The rate this courier charges for the distance from pickup location to dropoff location.

If there are any local fees that are charged in the pickup or dropoff city.

The fixed pickup fee that this courier charges.

The rate this courier charges for the distance from to get to the pickup location.

The id of the rate card that was used for this invoice.

The total before taxes.

The tax charged for this delivery.

Any tolls that were charged for this delivery.

The final total for this invoice. This number is the same as the "amount".

The amount of hours that are needed in advance before the courier can get the the pickup destination.

If this rate is an on demand courier.

@deprecated Epoch time in seconds when this order will be picked up. Same as service_level.pickup_at.

The provider is the courier or carrier that will be conducting the delivery.

The ID of this provider.

The logo that of this provider.

The name of this provider.

The email that can be used to contact this provider.

The support phone number that can be used to contact this provider.

The url that this provider has for support.

If this was a test delivery or not.

The message that could be displayed to an end user if the response is successful or ends in an error.

The data that was requested if any. If requesting lots of data like deliveries, the data will be formatted an an Array. If you're just pulling one item by an ID like a specific delivery, the response will be an Object.

The html status code for the response.

If there were errors, the array will be filled with the property names that caused the error.

The server error code.

when pulling multiple object like many deliveries, the pagination will let you know if there are more items that can be pulled from the database.

the limit that was applied to the pagination. The default is 15 and the max is 100.

The current page this pagination is on. If the limit is 15 and the current_page is 3, you know you're looking at items 30 - 45.

Lets you know when you can paginate further.

The amount of items that were returned.

This is a basic address field that gives the general location of the item.

The street address. Many carriers do not support this field and it can often be null.

Name of the city.

Name of the state, not abbreviated.

The zipcode.

If the courier added a comment for this update it will be here. These comments are not filtered by Dispatch at the moment, so it's safer to use the message property for customer notifications.

The human readable message about this status given by Dispatch.

The status string.

The sub_status string.

An array that includes any images that were added to this tracker. If there are no images, the array will be empty.