Skip to main content
PATCH
/
api
/
v1
/
:team_slug
/
:app_slug
/
orders
/
:order_id
/
lines
/
:line_id
Error
A valid request URL is required to generate request examples
{
  "data": {
    "base_price_amount": 123,
    "created_at": "<string>",
    "currency_code": "<string>",
    "first_image_path": "<string>",
    "id": "<string>",
    "order_id": "<string>",
    "product_id": "<string>",
    "product_name": "<string>",
    "product_number": "<string>",
    "quantity": 123,
    "short_description": "<string>",
    "tax_group_id": "<string>",
    "total_discount_amount": 123,
    "total_price_amount": 123,
    "total_sale_price": 123,
    "total_tax_amount": 123,
    "updated_at": "<string>",
    "variant_id": "<string>",
    "variant_name": "<string>",
    "variant_number": "<string>"
  },
  "details": [
    "<string>"
  ],
  "success": true
}

Path Parameters

app_slug
string
required

App slug

team_slug
string
required

Team slug

order_id
string
required

Order ID (UUID)

line_id
string
required

Order line ID (UUID)

Body

application/json

Order line update data

base_price_amount
number
required
Required range: x >= 0
currency_code
string
required
product_id
string
required
quantity
integer
required
Required range: x >= 1
total_price_amount
number
required
Required range: x >= 0
variant_id
string
required
tax_group_id
string
total_discount_amount
number
Required range: x >= 0
total_tax_amount
number
Required range: x >= 0

Response

Order line updated successfully

data
object
details
string[]

Other information which can be relative to the response. This field is used to give additional information then the main data we want to return. For instance if a product do not match the publishing rules will the product status be set to Incomplete and this field will include why

success
boolean