ID Mapping Requirement
PAR Ordering provides SharedId, OrganizationId, and LocationId values. You must map these PAR-provided IDs to your internal business/brand or location identifiers.
Mapping Responsibility:
- When you receive requests from PAR Ordering, they will contain PAR-provided
OrganizationIdandLocationIdvalues - You must maintain a mapping table to translate these PAR IDs to your internal IDs
- This mapping allows PAR Ordering to use its own ID scheme while you use your existing business identifiers
Example Mapping Scenario:
Consider an integrator (Integrator A) with the following setup:
- Customer: YummyTaco
- Internal Customer ID:
YC01 - Location: 12 Nosuch Place, LA
- Internal Location ID:
YC-LC-001
PAR Ordering provides:
- OrganizationId:
IA-YC-01(for the YummyTaco brand) - LocationId:
PAR-LOC-12345(for the "12 Nosuch Place, LA" location)
Required Mapping:
PAR OrganizationId: IA-YC-01 -> Internal Customer ID: YC01 PAR LocationId: PAR-LOC-12345 -> Internal Location ID: YC-LC-001
Implementation:
- When you receive a request with
OrganizationId: "IA-YC-01", you must map it to your internal customer IDYC01 - When you receive a request with
LocationId: "PAR-LOC-12345", you must map it to your internal location IDYC-LC-001 - Use your internal IDs when querying your POS system, database, or business logic
- Return PAR-provided IDs in responses to maintain consistency
Best Practices:
- Maintain a secure mapping table/database for PAR ID -> Internal ID translations
- Validate that the received PAR IDs exist in your mapping table
- Log mapping operations for audit and troubleshooting
- Handle unmapped IDs gracefully with appropriate error responses