Outlet certifications

List outlet certifications

Scopes

• certifications:read

Parameters

• cursorquerystring
• limitqueryinteger
• qquerystringFull-text search on names and titles.
• statusquerypending | no_expiry | valid | expiring | expired | renewed | archived

Responses

• 200OK
  OutletCertificationPageFields (2)

  • dataarray of OutletCertificationRequired
  • next_cursorstring | nullRequiredPass as cursor for the next page; null on the last page.
• 401Missing, revoked, or expired API key.
• 403The key lacks the scope.
• 429Rate limited: 60 requests per minute per key.

Create

Scopes

• certifications:write

Parameters

• Idempotency-KeyheaderstringRequiredStored 24 h per company and key. Same key with a different body returns 422.

Request body

Responses

• 201Created
  OutletCertificationFields (16)

  • idstring
  • versionintegerIncrements on every write. Send it back in If-Match.
  • created_atstring (date-time)
  • updated_atstring (date-time)
  • deleted_atstring | null
  • external_idstring | nullYour system's id, unique per company.
  • statuspending | no_expiry | valid | expiring | expired | renewed | archived
  • outlet_idstringRequired
  • certification_numberstringRequired
  • halal_scheme_idstringRequired
  • issuing_countrystringRequiredISO 3166-1 alpha-2.
  • lifecyclepending | active | renewed | archived
  • start_datestring | nullCalendar date in the organization's timezone (YYYY-MM-DD).
  • end_datestring | nullCalendar date in the organization's timezone (YYYY-MM-DD).
  • renewal_of_idstring | null
  • reminder_daysarray of integer | nullDays before end_date to remind; replaces the category rule and the default. Null follows them.
• 400Validation failed.
• 409Version conflict, external_id taken, or a secret that cannot be replayed.
• 422Semantically invalid, or an Idempotency-Key reused with a different body.
• 401Missing, revoked, or expired API key.
• 403The key lacks the scope.
• 429Rate limited: 60 requests per minute per key.

Get

Scopes

• certifications:read

Parameters

• idpathstringRequired

Responses

• 200OK
  OutletCertificationFields (16)

  • idstring
  • versionintegerIncrements on every write. Send it back in If-Match.
  • created_atstring (date-time)
  • updated_atstring (date-time)
  • deleted_atstring | null
  • external_idstring | nullYour system's id, unique per company.
  • statuspending | no_expiry | valid | expiring | expired | renewed | archived
  • outlet_idstringRequired
  • certification_numberstringRequired
  • halal_scheme_idstringRequired
  • issuing_countrystringRequiredISO 3166-1 alpha-2.
  • lifecyclepending | active | renewed | archived
  • start_datestring | nullCalendar date in the organization's timezone (YYYY-MM-DD).
  • end_datestring | nullCalendar date in the organization's timezone (YYYY-MM-DD).
  • renewal_of_idstring | null
  • reminder_daysarray of integer | nullDays before end_date to remind; replaces the category rule and the default. Null follows them.
• 404Not found. Records of other companies are also reported as not found.
• 401Missing, revoked, or expired API key.
• 403The key lacks the scope.
• 429Rate limited: 60 requests per minute per key.

Update (partial)

Scopes

• certifications:write

Parameters

• idpathstringRequired
• Idempotency-Keyheaderstring
• If-MatchheaderintegerThe version you last read; 409 version_conflict when it changed.

Request body

Responses

• 200OK
  OutletCertificationFields (16)

  • idstring
  • versionintegerIncrements on every write. Send it back in If-Match.
  • created_atstring (date-time)
  • updated_atstring (date-time)
  • deleted_atstring | null
  • external_idstring | nullYour system's id, unique per company.
  • statuspending | no_expiry | valid | expiring | expired | renewed | archived
  • outlet_idstringRequired
  • certification_numberstringRequired
  • halal_scheme_idstringRequired
  • issuing_countrystringRequiredISO 3166-1 alpha-2.
  • lifecyclepending | active | renewed | archived
  • start_datestring | nullCalendar date in the organization's timezone (YYYY-MM-DD).
  • end_datestring | nullCalendar date in the organization's timezone (YYYY-MM-DD).
  • renewal_of_idstring | null
  • reminder_daysarray of integer | nullDays before end_date to remind; replaces the category rule and the default. Null follows them.
• 400Validation failed.
• 404Not found. Records of other companies are also reported as not found.
• 409Version conflict, external_id taken, or a secret that cannot be replayed.
• 422Semantically invalid, or an Idempotency-Key reused with a different body.
• 401Missing, revoked, or expired API key.
• 403The key lacks the scope.
• 429Rate limited: 60 requests per minute per key.

Delete (soft; restorable for 30 days)

Scopes

• certifications:write

Parameters

• idpathstringRequired
• Idempotency-Keyheaderstring

Responses

• 204Deleted
• 404Not found. Records of other companies are also reported as not found.
• 401Missing, revoked, or expired API key.
• 403The key lacks the scope.
• 429Rate limited: 60 requests per minute per key.

Restore within 30 days of deletion

Scopes

• certifications:write

Parameters

• idpathstringRequired
• Idempotency-Keyheaderstring

Responses

• 200OK
  OutletCertificationFields (16)

  • idstring
  • versionintegerIncrements on every write. Send it back in If-Match.
  • created_atstring (date-time)
  • updated_atstring (date-time)
  • deleted_atstring | null
  • external_idstring | nullYour system's id, unique per company.
  • statuspending | no_expiry | valid | expiring | expired | renewed | archived
  • outlet_idstringRequired
  • certification_numberstringRequired
  • halal_scheme_idstringRequired
  • issuing_countrystringRequiredISO 3166-1 alpha-2.
  • lifecyclepending | active | renewed | archived
  • start_datestring | nullCalendar date in the organization's timezone (YYYY-MM-DD).
  • end_datestring | nullCalendar date in the organization's timezone (YYYY-MM-DD).
  • renewal_of_idstring | null
  • reminder_daysarray of integer | nullDays before end_date to remind; replaces the category rule and the default. Null follows them.
• 404Not found. Records of other companies are also reported as not found.
• 401Missing, revoked, or expired API key.
• 403The key lacks the scope.
• 429Rate limited: 60 requests per minute per key.

Create or replace by your external id

Scopes

• certifications:write

Parameters

• external_idpathstringRequired
• Idempotency-Keyheaderstring
• If-MatchheaderintegerThe version you last read; 409 version_conflict when it changed.

Request body

Responses

• 200Updated
  OutletCertificationFields (16)

  • idstring
  • versionintegerIncrements on every write. Send it back in If-Match.
  • created_atstring (date-time)
  • updated_atstring (date-time)
  • deleted_atstring | null
  • external_idstring | nullYour system's id, unique per company.
  • statuspending | no_expiry | valid | expiring | expired | renewed | archived
  • outlet_idstringRequired
  • certification_numberstringRequired
  • halal_scheme_idstringRequired
  • issuing_countrystringRequiredISO 3166-1 alpha-2.
  • lifecyclepending | active | renewed | archived
  • start_datestring | nullCalendar date in the organization's timezone (YYYY-MM-DD).
  • end_datestring | nullCalendar date in the organization's timezone (YYYY-MM-DD).
  • renewal_of_idstring | null
  • reminder_daysarray of integer | nullDays before end_date to remind; replaces the category rule and the default. Null follows them.
• 201Created
  OutletCertificationFields (16)

  • idstring
  • versionintegerIncrements on every write. Send it back in If-Match.
  • created_atstring (date-time)
  • updated_atstring (date-time)
  • deleted_atstring | null
  • external_idstring | nullYour system's id, unique per company.
  • statuspending | no_expiry | valid | expiring | expired | renewed | archived
  • outlet_idstringRequired
  • certification_numberstringRequired
  • halal_scheme_idstringRequired
  • issuing_countrystringRequiredISO 3166-1 alpha-2.
  • lifecyclepending | active | renewed | archived
  • start_datestring | nullCalendar date in the organization's timezone (YYYY-MM-DD).
  • end_datestring | nullCalendar date in the organization's timezone (YYYY-MM-DD).
  • renewal_of_idstring | null
  • reminder_daysarray of integer | nullDays before end_date to remind; replaces the category rule and the default. Null follows them.
• 400Validation failed.
• 409Version conflict, external_id taken, or a secret that cannot be replayed.
• 422Semantically invalid, or an Idempotency-Key reused with a different body.
• 401Missing, revoked, or expired API key.
• 403The key lacks the scope.
• 429Rate limited: 60 requests per minute per key.