# Order status

## POST

Try it

Inform of updates to the status of an order, including payment authorization, fulfillment, shipping details, and compensation granted. For pre-authorization flows, use this endpoint to supply Forter with authorization results from your payment processor. While no decision is provided on this request, it is a required input that improves the decision model.

### Credentials

- **HTTP Basic** basicAuth

### Path Parameters

- `id` (string) *

### Header Parameters

- `api-version` (string) *
- `x-forter-siteid` (string) *

### Body Parameters

- **body** (statusRequest) *
  - `additionalInformation` (object)  
    - All Of: GeneralPayloadMap + additionalOrderId (string, nullable)
    - `cartItems` (Item[], nullable)
    - `compensationStatus` (object)
    - `correlationId` (string, nullable)
    - `deliveryStatusInfo` (object)
    - `endPointLocation` (object)
    - `eventId` (string, nullable)
    - `eventTime` (number) *
    - `itemIds` (string[], nullable)
    - `orderId` (string) *
    - `payment` (Payment[], nullable)
    - `refundInformation` (object)
    - `returnedCartItems` (Item[], nullable)
    - `statusChangeReason` (string, nullable)
    - `updatedMerchantStatus` (string, nullable)
    - `updatedStatus` (string <PROCESSING | SENT | COMPLETED | CANCELED_BY_MERCHANT | CANCELED_BY_CUSTOMER | RETURNED | NO_SHOW | REPLACED>) *
    - `updatedTotalAmount` (object)
    - `updatedTotalDiscount` (object)
    - `updatedTryOutStatus` (string <NONE | EMAIL_SENT_TO_CUSTOMER | CALLED_TO_CUSTOMER | CUSTOMER_VISITED_PAGE | CUSTOMER_DECLARED_SEND_BACK | SHIPPING_REPORTED_SEND_BACK | RETURNED_ITEMS_ARRIVED_PENDING | MISSING_ITEMS | MANUAL_RESOLUTION | CHARGE_ATTEMPT | FORFEIT | COMPLETED>, nullable)
    - `verificationResults` (object)

### Responses

- **200**  
  Example statusResponse  
  ```json
  {"message":"Transaction #:id status received","status":"success"}
  ```
- **400** Bad Request (Often missing a required parameter)
- **401** Unauthorized (No valid API key provided)
- **404** Not Found (The requested item doesn't exist)
- **500** Server Error (Something went wrong on Forter's end)

## Request

### Curl
```bash
curl --request POST \ 
--url https://api.forter-secure.com/v2/status/{id} \ 
--header 'accept: application/json' \ 
--header 'content-type: application/json' \ 
--header 'api-version: 10.1' \ 
--header 'x-forter-siteid: a1b2c3d4e5f6' \ 
--data '{...}'
```

### Example statusRequest

```json
{
  "additionalInformation": {},
  "cartItems": [...],
  "statusChangeReason": "...",
  "updatedStatus": "PROCESSING"
}
```