/v1/workspaces/{workspace_id}/data/refund_line_items

post

https://data.getangler.ai/v1/workspaces/{workspace_id}/data/refund_line_items

Path Params

workspace_id

string

required

Body Params

src

string

enum

Allowed:

dataset_id

string

load_id

string

data

array of objects

required

length between 1 and 500

data*

string

required

length ≥ 1

The ID of the refund line item.

refund_id

string | null

The ID of the refund this line belongs to.

order_id

string | null

The ID of the order.

line_item_id

string | null

The ID of the line item that was refunded.

location_id

string | null

The ID of the location where the items were returned to.

quantity

number | null

The number of units refunded. Not the number of units originally ordered.

restock_type

string | null

How the refund was restocked: no_restock, cancel, return, or legacy_restock.

subtotal

string | null

The subtotal of the refunded line, in the shop currency.

total_tax

string | null

The total tax refunded on the line, in the shop currency.

additional_fields

array of objects | null

Extra properties.

additional_fields

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Default Response

202Default Response