CreateNotification

Request
Request Body schema: application/json
object (ShippedShipment)

This model represents a shipment that has already been shipped, and contains summary information about the shipment.

create_label_request
object (CreateLabelRequest) Recursive
object (AdvancedOptions)

This is a schemaless object. It is for open ended customizations unique to particular carriers. The documented keys are some common options shared by many carriers, but are not definitive. Advanced options you support will be defined in ShipEngine. If the field is absent it should be interpreted as the default value for any applicable options, e.g. false for booleans.

transaction_id
required
string <uuid>

The transaction ID uniquely represents this request. If the request is retried then this transaction ID will be the same. You should only perform the requested action once per given transaction ID.

object (Authorization)
object or null
Responses
200

This object model represents the response from a successful create notification request.

post/CreateNotification
Request samples
application/json
{
  • "shipment_information": {
    },
  • "create_label_request": {
    },
  • "advanced_options": {
    },
  • "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
  • "authorization": {
    },
  • "metadata": {
    }
}
Response samples
application/json
{
  • "notification_id": "string",
  • "billing_line_items": [
    ],
  • "metadata": {
    }
}