Ship API Response

Ship API Response

The response is sent to indicate whether the request has been successfully completed or to indicate failure and a description of the error.

Status Codes

Status codes are issued by a server in response to a client's request made to the server. The following table lists the status codes supported by Site Flow. For the response to be configured successfully, please use only these codes in the response.

Response Headers

function createSignature(partnerId, apiKey) {
     const hmac = createHmac('sha256', apiKey)
     const nonce = randomBytes(48).toString('hex') hmac.update(nonce)
     const signature = hmac.digest('base64')
     const authorization = `${partnerId}:${signature}`

     return { nonce: nonce, authorization: authorization }
}
     const auth = createSignature(partnerId, 'PARTNER_API_KEY')
     res.setHeader('X-Siteflow-Nonce', auth.nonce)
     res.setHeader('X-Siteflow-Signature', auth.authorization)

Note: The headers x-siteflow-nonce and x-siteflow-signature should always be set on response.

Shipping response payload

{
	"status": {
		"code": "ok",
		"message": "INSERT MESSAGE HERE"
	},
	"shipmentId": "5976029c770e36a13e25a85e",
	"charges": {
		"value": 0,
		"currency": "GBP"
	},
	"documents": [
		{
			"sendersReference": "20170720122153-0-1",
			"payload": " payload for label ",
			"type": "pdf",
			"encoding": "base64"
		}
	],
	"labels": [
		{
			"trackingNumber": "1Z3X3F910305063713",
			"sendersReference": "20170720122153-0-1",
			"payload": " payload for label ",
			"type": "pdf",
			"encoding": "base64"
		}
	]
}