Skip to main content

Request Payload Structure

This section describes the JSON payload format required when calling the vendor number assignment endpoint.

JSON Payload Format​

{
  "Id": "550e8400-e29b-41d4-a716-446655440000",
  "ErpVendorNumber": "VENDOR-12345"
}

Field Descriptions​

FieldTypeRequiredDescription
IdGUID (string)YesThe onboarding request ERP event ID. Must match the id path parameter.
ErpVendorNumberstringYesThe vendor number assigned by your ERP system. This is the identifier that will be stored in B1Link.

Validation Rules​

  • Id must be a valid GUID format
  • Id must match the path parameter id
  • ErpVendorNumber cannot be null or empty
  • ErpVendorNumber should be a meaningful identifier from your ERP system

Important Notes​

⚠️ JSON Serialization Order Matters

The signature verification uses the exact JSON string representation. The JSON must be serialized with:

  • No extra whitespace
  • Properties in the order: Id first, then ErpVendorNumber
  • Standard JSON formatting (no trailing commas, proper escaping)

The exact format used by B1Link for signature verification is:

{"Id":"<guid>","ErpVendorNumber":"<vendor-number>"}

Common Mistakes​

❌ DO NOT:

  • Add extra whitespace or indentation
  • Change property order
  • Use pretty-printed JSON
  • Include trailing commas

✅ DO:

  • Use compact JSON format
  • Maintain property order: Id, then ErpVendorNumber
  • Use UTF-8 encoding

Next Steps​