setting/credit_note_status/get

This returns the list of credit note statuses available 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

optional

The credit note status ID to search for specifically.

filter_date_modified

string

optional

Filter the list of credit note statuses modified after the spcified date.

filter_deleted

boolean

optional

Filter the list of credit note statuses to include deleted records.

filter_channel_group_id

string

optional

Filter the list of credit note statuses by channel group ID, comma separated values.

page

integer

optional

Page number of the results.

sort

string

optional

The key for the ordering of the results. Accepts "name", "date_modified"

order

string

optional

The direction for the ordering of the results. Accepts "ASC", "DESC"

limit

integer

optional

The number of results per page. Accepts 1 to 100.

Example

{
  "domain": "string",
  "api_key": "string",
  "auth_timestamp": 0,
  "auth_signature": "string",
  "credit_note_status_id": 0,
  "filter_date_modified": "string",
  "filter_deleted": true,
  "filter_channel_group_id": "string",
  "page": 0,
  "sort": "string",
  "order": "string",
  "limit": 0
}

Responses

🟢200Success

application/json

Body

error

array[string]

optional

Returns only if there is an error.

total

integer

optional

The total number of results available.

credit_note_statuses

array [object {6}]

optional

The list of credit note statuses.

credit_note_status_id

integer

required

The channel group ID.

channel_group_id

integer

required

The channel group ID assigned to the credit note status.

name

string

required

The credit note status name.

restock

boolean

required

Indicates if the credit note status will restock items.

date_modified

string

required

The date time this credit note status was last modified.

deleted

boolean

optional

Indicates if the credit note status has been deleted. Only returned if filter_deleted is "1".

Example

{
  "error": [
    "string"
  ],
  "total": 0,
  "credit_note_statuses": [
    {
      "credit_note_status_id": 0,
      "channel_group_id": 0,
      "name": "string",
      "restock": true,
      "date_modified": "string",
      "deleted": true
    }
  ]
}