Manage location API processes
Create Location
Preconditions
- For a location owner and delegated partner, if the brand expected to be associated with a location using a
brandIdalready exists and the brand's resource state isPUBLISHED, then you may create a location. Else, the brand must be created first and you must wait until the brand's resource state isPUBLISHED.
Process Description
-
API user requests creation of a location resource
-
The service validates the description of the resource synchronously
-
If no inline validation with severity of
VIOLATIONis triggered, the resource proceeds to asynchronous (offline) validation -
Resource state changes and notifications/feedback are generated in response to recorded events
-
API user polls for notifications every 15 minutes after requesting creation of the resource
Flow Chart - Location Owner & Delegated Partner
Flow Chart - Partner
Flow is similar to owner & delegated partner with the exception that existence of a brand is not required.
Events & Resource State Changes
Resource state changes occur in response to system events and, in certain cases, manual review by Apple Business operations.
Some events trigger the generation of notifications and feedback whose details are described elsewhere in this specification.
Common scenarios are described here so you may better understand how a resource's state changes. Included in these descriptions are the conditions which are necessary to generate notifications and feedback.
| Scenario |
|---|
| No exceptions triggered |
Inline & offline validation triggered (WARNING only) |
Inline validation triggered (VIOLATION) |
Inline validation triggered (WARNING only) & offline validation triggered (VIOLATION) |
No Exceptions
The recording of the event that the resource has gone "live" triggers the generation of a notification and feedback.
Event Table
| Event | Resource State From | Resource State To | Feedback? | Notification? |
|---|---|---|---|---|
| Inline validations pass | 'SUBMITTED' | No | No | |
| Offline validations pass | 'SUBMITTED' | 'PROCESSING' | No | No |
| Internal data processing pass | 'PROCESSING' | 'PROCESSING' | No | No |
| Internal system processing pass | 'PROCESSING' | 'PROCESSING' | No | No |
| Resource is "live" | 'PROCESSING' | 'PUBLISHED' | Yes | Yes |
Contextualized
Inline & Offline Warning
Scenario where one or more inline and offline validations trigger and their associated severities are only WARNING.
The synchronous response to the API user's request is a validation report detailing all WARNING validations that were triggered.
One or more offline validations trigger and their associated severities are WARNING. The recording of this event triggers generation of a notification and feedback. Asynchronous reporting of all inline and offline validations are included in a validation report.
The recording of the event that the resource has gone "live" triggers both generation of a notification and feedback.
Event Table
| Event | Resource State From | Resource State To | Feedback? | Notification? |
|---|---|---|---|---|
| Inline validations (WARNING) | 'SUBMITTED' | No | No | |
| Offline validations (WARNING) | 'SUBMITTED' | 'PROCESSING' | Yes | Yes |
| Internal data processing pass | 'PROCESSING' | 'PROCESSING' | No | No |
| Internal system processing pass | 'PROCESSING' | 'PROCESSING' | No | No |
| Resource is "live" | 'PROCESSING' | 'PUBLISHED' | Yes | Yes |
Contextualized
Inline Violation
One or more inline validations trigger and their associated severities are VIOLATION. The recording of this event does not trigger generation of a notification or feedback.
The synchronous response to the API user's request is a validation report detailing all validations (VIOLATION & WARNING) that triggered.
Event Table
| Event | Resource State From | Resource State To | Feedback? | Notification? |
|---|---|---|---|---|
| Inline validations (VIOLATION) | 'REJECTED' | No | No |
Contextualized
Inline Warning & Offline Violation
One or more inline validations trigger and their associated severities are only WARNING. The synchronous response to the API user's request is a validation report detailing all WARNING validations that were triggered.
One or more offline validations trigger and their associated severities are VIOLATION. The recording of this event triggers generation of a notification and feedback. Asynchronous reporting of all inline and offline validations are included in a validation report.
Event Table
| Event | Resource State From | Resource State To | Feedback? | Notification? |
|---|---|---|---|---|
| Inline validations (WARNING) | 'SUBMITTED' | No | No | |
| Offline validations (VIOLATION) | 'SUBMITTED' | 'REJECTED' | Yes | Yes |
Contextualized