Common Types

This page lists the valid values for some of the common types that are used throughout a ShipEngine Connect application.

Charge Types

This is the list of values for charge types. You will use one of these values in the type property of a charges array. For example, the rateShipment returns a rate object that includes a charges array since the total shipping charges are a large factor in selecting a rate.

Name	Description
`shipping`	The charge is for shipping.
`handling`	The charge is for handling of the item.
`oversize`	The charge is accessed because the packaging is a non-standard size.
`special_goods`	The charge is for special goods.
`delivery_confirmation`	The charge is for a delivery confirmation, such as requiring an adult signature.
`insurance`	The charge is for insurance.
`discount`	The charge is for a discount. This would be reflected by a negative value.
`fuel`	The charge is for fuel.
`location_fee`	The charge is because of the location of the origin or destination address.
`fee`	This charge is for a general purpose fee.
`pickup`	The charge is for a package pickup.
`return`	The charge is for a return.
`notification`	The charge is for a notification.
`duty`	The charge is for a foreign duty.
`tax`	The charge is for a tax.
`adjustment`	The charge is for an adjustment. This can happen if the package dimensions or weight are different from what was used when the label was generated. It would be negative for a refund.
`coupon`	The charge is because a coupon was applied. This would be reflected by a negative value.
`credit`	The charge is because a credit was applied. This would be reflected by a negative value.
`debit`	The charge is because of a debit.
`gift_certificate`	The charge is because a gift certificate was applied. This would be reflected by a negative value.
`gift_wrapping`	The charge is for gift wrapping.
`promotion`	The charge is because of a promotion. This would be reflected by a negative value.
`refund`	The charge is for a refund. This would be reflected by a negative value.
`uncategorized`	The charge is for something that does not fit into any of the other categories.

Notes Types

This is the list of values for note types. You will use one of these values in the type property of a notes array. For example, the createShipment method receives a new shipment object that includes a notes array. Most of the objects passed to and from your methods will contain a notes array.

Name	Description
`gift_message`	The note contains a gift message.
`message_to_buyer`	The note contains a message to the buyer.
`message_from_buyer`	The not contains a message from the buyer.
`internal`	The note is for internal use.