Add Client Order States

1 min

POST

https://api.upstartcommerce.com/v1/order/client-state/batch

This endpoint allows administrators to add multiple new client order state. It includes details such as the client state ID, name, internal state, color and audit information.

Authorized permissions:

client.order.create

acceptstringGenerated from available response content types

x-upstart-tenantstringTenant identifier associated with the site this call is for.

bodyarrayThe request body must include all necessary details for the new client order state.

201<p>Success-New client order state created.</p>

207<p>Partial Success - request partially processed with some error</p>

400The request contained information that the server was unable to process. Appropriate errors are provided in the response body.

401The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.

403The provided credentials were not valid for this endpoint. It may be that the user's roles are insufficient.

500Internal server error.

curl --request POST \
     --url https://api.upstartcommerce.com/v1/order/client-state/batch \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-upstart-tenant: string' \
     --data '[
     {
     "siteIds": [],
     "name": "",
     "color": "",
     "internalState": ""
     }
     ]'