Returns

Creates a return line for a specified order line.

post

Authorizations

api-key

api-keystringRequired

API Key

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

appstringRequired

servicestringRequired

warningsobject[]Required

instanceIdstringRequired

requestIdstringRequired

400

Functional Error

application/json

post/v1/om/return-lines

HTTPcURLJavaScriptPython

POST /v1/om/return-lines HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "params": {
    "lineId": "text",
    "orderId": "text",
    "invoiceId": "text",
    "quantity": 1,
    "reasonId": "text",
    "waste": true
  }
}

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "uid": "text"
  }
}

Deletes a return line.

delete

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

appstringRequired

servicestringRequired

warningsobject[]Required

instanceIdstringRequired

requestIdstringRequired

400

Functional Error

application/json

delete/v1/om/return-lines/{uid}

HTTPcURLJavaScriptPython

DELETE /v1/om/return-lines/{uid} HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "succeed": true
  }
}

Updates a return line.

patch

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

appstringRequired

servicestringRequired

warningsobject[]Required

instanceIdstringRequired

requestIdstringRequired

400

Functional Error

application/json

patch/v1/om/return-lines/{uid}

HTTPcURLJavaScriptPython

PATCH /v1/om/return-lines/{uid} HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "params": {
    "uid": "text",
    "waste": true,
    "reasonId": "text",
    "quantity": 1
  }
}

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "succeed": true
  }
}