Header Field Description / Business Case Required Type Default value Example
Authorization Request's authorization. Must be a valid JWT token. Yes String N/A Bearer token
requestTraceId Request's unique identifier in BEES ecosystem Yes String N/A traceIdTHRAQ5129801840
Content-Type application/json Yes String N/A -
country Must contain the country code of the business operation to which the request refers, following ISO 3166. For example: If the request refers to a brazilian business operation data, inform "BR" Yes String N/A BR
x-timestamp Timestamp is used to order ingestion requests in several internal services. BEES Sync Generic Relay accepts requests with or without timestamp data:
  • If not provided by partner/vendor, timestamp is generated according to the internal processing order
  • If provided, and if the country and partner/vendor have been enabled for this behaviour, it will be used as the official ingestion timestamp. Contact us if it is needed to be enabled to your company.
If so, this data must be provided in milliseconds elapsed since the Unix Epoch (1st January 1970 00:00:00 UTC), all timestamps must be in UTC timezone, as per ISO 8601 standards.
No Long N/A 1717523728076
x-bees-origin An additional identifier, more specifically describing the system from which the request was originated. Depending on the entity, it is necessary to provide String N/A ERP-1, CRM-b
content-encoding Send it if it is needed to compress the request. It is recommended to use gzip encoding. Other encodings may not be supported internally No String N/A gzip