2025-09 New sale state and attributes fields

Sale object has been updated to include the new state and attributes fields. A new States and attributes page has been added to show the mapping between legacy status and new state and attributes fields.

List of updated endpoints

API 2.0:

• GET /api/2.0/sales/{sale_id}
• PUT /api/2.0/sales/{sale_id}/actions/return
• GET /api/2.0/sales
• GET /api/2.0/search

API 0.9:

Note: in API 0.9 attributes field is called register_sale_attributes

• GET /api/register_sales
• POST /api/register_sales
• GET /api/register_sales/{sale_id}

Migration Guide

For backward compatibility:

• Both sale status and sale state fields are currently supported
• Existing integrations will continue to work without changes
• New integrations should use sale state and attributes

Example Migration:

❌ Old approach (deprecated):

{
  "status": "ONACCOUNT"
}

✅ New approach (recommended):

{
  "state": "pending",
  "attributes": ["onaccount"]
}