Create transfer template

Create a transfer template for use by the license_number provided.

SecurityApiKeyAuth and CustomAuth
Request
path Parameters
state
required
string

Lower case ANSI standard 38:2009 USPS codes of the US state where licensee is operating.

Enum: "ca" "il" "wa" "ma" "md" "mi" "wv" "co" "ok" "oh"
header Parameters
x-api-key
required
string

Trace API key header

Example: b123x21wbHlkYXBpa2V5
Authorization
required
string

Company and user credentials authentication

Example: KMP-JSON token=dmVuZG9yLWFwaS1rZXk6dX12312sdfs2V5
Request Body schema: application/json
required
object
name
required
string

master transfer template name. describes the manifests contained within this transfer

object

totals of all shipments contained within this transfer template

object

master manifest contains summary of all shipment manifests

required
object

originator of the transfer.

Array of objects

Array containing information pertaining to the individual shipments in the transfer.

required
object

transfer transporter

Responses
200

OK

400

Bad Request

post/{state}/v1/transfers/template
Request samples
application/json
{
  • "license": {
    },
  • "name": "Trace transfers 2199",
  • "totals": {
    },
  • "master_manifest": {
    },
  • "shipper": {
    },
  • "transfers": [
    ],
  • "transporter": {
    }
}
Response samples
application/json
{
  • "results": {
    },
  • "warnings": [ ]
}