This page was automatically generated from tracezilla’s Swagger API documentation 2026-07-17

GET /order-links/{orderLinkId}

Get link

Description

Returns link

Parameters (path)

Name Required Description Values
orderLinkId required Target order link.  

Responses

200

successful operation

406

not acceptable

500

internal server error

PUT /order-links/{orderLinkId}

Update existing order link

Description

Update the specified resource in storage.

Parameters (path)

Name Required Description Values
orderLinkId required Target link.  

Request body

Description

Target link.

Required

This parameter is required.

Request body JSON schema 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

{
  "properties": {
    "id": {
      "description": "Id of the record",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "inbound_order_id": {
      "description": "No description is available",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "memo": {
      "description": "No description is available",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "mode": {
      "description": "No description is available",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "outbound_order_id": {
      "description": "No description is available",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "created_at": {
      "description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
      "type": "string",
      "format": "date-time",
      "example": "2019-01-01T13:25:32.312Z"
    },
    "updated_at": {
      "description": "The time when the record was last updated in UTC date & time (Iso8601 ZuluString)",
      "type": "string",
      "format": "date-time",
      "example": "2020-01-01T13:25:32.312Z"
    }
  },
  "type": "object"
}

Responses

403

Unauthorized request

406

not acceptable

500

Internal server error

DELETE /order-links/{orderLinkId}

Delete link

Description

Remove the specified resource from storage.

Parameters (path)

Name Required Description Values
orderLinkId required Target link.  

Responses

403

Unauthorized request

406

not acceptable

500

Internal server error