setting/credit_note_status/edit

This edits a credit note status in the Equotix One account.

Request

Body Params application/json

domain

string

required

The domain you are assigned to authenticate your Equotix One account.

api_key

string

required

The email address assigned to the user account in your Equotix One.

auth_timestamp

integer

required

The unix timestamp used to sign this API request.

auth_signature

string

required

The calculated signature for this API request.

credit_note_status_id

integer

required

The credit note status ID to edit.

name

string

required

The name of the credit note status.

channel_group_id

integer

required

The channel group ID for restriction control. Accepts "0" if none.

restock

integer

required

Indicates if a restock should happen at this credit note status. Accepts "1" or "0".

Example

{
    "domain": "string",
    "api_key": "string",
    "auth_timestamp": 0,
    "auth_signature": "string",
    "credit_note_status_id": 0,
    "name": "string",
    "channel_group_id": 0,
    "restock": 0
}

Responses

🟢200Success

application/json

Body

error

array[string]

optional

Returns only if there is an error.

success

boolean

optional

Returns only if there is no error.

credit_note_status_id

integer

optional

The edited credit note status ID.

Example

{
    "error": [
        "string"
    ],
    "success": true,
    "credit_note_status_id": 0
}