In the Soul marketplace platform, order states and statuses help categorize and track the lifecycle of an order.
States #
States represent broad and fixed categories that define the general condition of an order. Each state has specific characteristics that apply to all its associated statuses. For example, a state may indicate that an order has been canceled, is being processed, or is completed.
Statuses #
Statuses are subcategories within a state and provide greater specificity about the condition of an order. While multiple statuses can be associated with the same state, they share the same general characteristics of the main state.
Example: #
State: Canceled
Description: The order will not be processed as it has been canceled.
Status: Refunded
Description: The amount paid by the customer has been refunded.
Status: Canceled
Description: The order was canceled with no refund required.
In the example above, both statuses belong to the Canceled state and share the main characteristic that the order will no longer be processed.
Below is the complete list of states and statuses used in the Soul marketplace. Each state represents a broad category that defines the general condition of an order within the platform. The statuses associated with a state provide more details about the specific situation of the order, but they share the main characteristics of the state they belong to.
This structure allows for greater flexibility in tracking and managing orders, ensuring that all stages are clearly identified and understood.
Status: Pending #
State: New
Description: The order has just been added to the store by a customer, marking the beginning of the processing flow.
Status: Payment_Review #
State: Payment_Review
Description: The order is under payment review for the administrator to assess whether it should be approved or not. This status is exclusive to orders processed through Pagar.me.
Status: Processing #
State: Processing
Description: The order has been paid by the customer, and the delivery process for the items can now begin.
Status: Awaiting_Invoice #
State: Awaiting_Invoice
Description: The order has been paid by the customer, and the delivery process for the items can now begin. This status is used in scenarios with order integration, where the integration systems fetch orders in the Pending status and update them to this status, ensuring that the order is not captured again in the next read.
Status: Invoice_Issued #
State: Processing
Description: The invoice for the order has been issued, and it is awaiting the shipping process to the carrier
Status: Awaiting_Shipping #
State: Awaiting_Shipping
Description: This status is used when the order does not have an invoice. In this case, instead of being updated to the Invoice_Issued status, it is updated to Awaiting_Shipping.
Status: Delivered_to_Carrier #
State: Processing
Description: This status indicates that the tracking information for the order has been provided to the customer.
Status: Awaiting_Confirmation #
State: Awaiting_Confirmation
Description: This status is used when the customer has received the product, and the order is awaiting confirmation that the customer has received it.
Status: Delivery_Confirmed #
State: Complete
Description: This status is used for orders where the customer selected the “pickup in store” shipping method.
Status: Complete #
State: Complete
Description: This status is used when the order is finalized, the products are with the customer, and no further action is required.
Status: Refunded #
State: Canceled
Description: This status is used when the order has been fully refunded to the customer.
Status: Partially_Refunded #
State: Canceled
Description: This status is used when the order has been partially refunded to the customer.
Status: Canceled #
State: Canceled
Description: This status is used when the order has been canceled by the customer.
If you have any questions or difficulties during the process, please contact support.