Skip to content

Commit a8fff08

Browse files
Update to latest openapi definition
1 parent b80d3e3 commit a8fff08

File tree

4 files changed

+74
-14
lines changed

4 files changed

+74
-14
lines changed

docs/index.html

Lines changed: 11 additions & 9 deletions
Large diffs are not rendered by default.

openapi.json

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"openapi": "3.0.0",
33
"info": {
44
"title": "ShipEngine API",
5-
"version": "1.1.202506060606",
5+
"version": "1.1.202507012007",
66
"termsOfService": "https://www.shipengine.com/terms-of-service/",
77
"x-logo": {
88
"url": "https://shipengine.github.io/img/shipengine-logo-square.png",
@@ -60844,7 +60844,7 @@
6084460844
],
6084560845
"post": {
6084660846
"summary": "Create a return label",
60847-
"description": "Create a return label",
60847+
"description": "Create a return label for an existing outbound label. You can optionally specify a custom RMA (Return Merchandise Authorization) number. If no RMA number is provided, the system will auto-generate one.\n",
6084860848
"tags": [
6084960849
"labels"
6085060850
],
@@ -60952,6 +60952,32 @@
6095260952
}
6095360953
],
6095460954
"description": "The label image resource that was used to create a custom label image."
60955+
},
60956+
"rma_number": {
60957+
"type": "string",
60958+
"nullable": true,
60959+
"description": "An optional Return Merchandise Authorization number. If provided, this value will be used as the return label's RMA number. If omitted, the system will auto-generate an RMA number (current default behavior). You can set it to any string value.\n"
60960+
}
60961+
}
60962+
},
60963+
"examples": {
60964+
"with_custom_rma": {
60965+
"summary": "Return label with custom RMA number",
60966+
"description": "Create a return label with a specific RMA number",
60967+
"value": {
60968+
"label_format": "pdf",
60969+
"label_layout": "4x6",
60970+
"charge_event": "carrier_default",
60971+
"rma_number": "RMA-2024-001234"
60972+
}
60973+
},
60974+
"without_rma": {
60975+
"summary": "Return label with auto-generated RMA",
60976+
"description": "Create a return label using default RMA generation",
60977+
"value": {
60978+
"label_format": "pdf",
60979+
"label_layout": "4x6",
60980+
"charge_event": "carrier_default"
6095560981
}
6095660982
}
6095760983
}
@@ -193556,6 +193582,11 @@
193556193582
}
193557193583
],
193558193584
"description": "The label image resource that was used to create a custom label image."
193585+
},
193586+
"rma_number": {
193587+
"type": "string",
193588+
"nullable": true,
193589+
"description": "An optional Return Merchandise Authorization number. If provided, this value will be used as the return label's RMA number. If omitted, the system will auto-generate an RMA number (current default behavior). You can set it to any string value.\n"
193559193590
}
193560193591
}
193561193592
},

openapi.yaml

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
openapi: 3.0.0
22
info:
33
title: ShipEngine API
4-
version: 1.1.202506060606
4+
version: 1.1.202507012007
55
termsOfService: 'https://www.shipengine.com/terms-of-service/'
66
x-logo:
77
url: 'https://shipengine.github.io/img/shipengine-logo-square.png'
@@ -2073,7 +2073,10 @@ paths:
20732073
description: Label ID
20742074
post:
20752075
summary: Create a return label
2076-
description: Create a return label
2076+
description: >
2077+
Create a return label for an existing outbound label. You can optionally
2078+
specify a custom RMA (Return Merchandise Authorization) number. If no
2079+
RMA number is provided, the system will auto-generate one.
20772080
tags:
20782081
- labels
20792082
operationId: create_return_label
@@ -2083,6 +2086,22 @@ paths:
20832086
application/json:
20842087
schema:
20852088
$ref: '#/components/schemas/create_return_label_request_body'
2089+
examples:
2090+
with_custom_rma:
2091+
summary: Return label with custom RMA number
2092+
description: Create a return label with a specific RMA number
2093+
value:
2094+
label_format: pdf
2095+
label_layout: 4x6
2096+
charge_event: carrier_default
2097+
rma_number: RMA-2024-001234
2098+
without_rma:
2099+
summary: Return label with auto-generated RMA
2100+
description: Create a return label using default RMA generation
2101+
value:
2102+
label_format: pdf
2103+
label_layout: 4x6
2104+
charge_event: carrier_default
20862105
responses:
20872106
'200':
20882107
description: The request was a success.
@@ -10639,6 +10658,14 @@ components:
1063910658
description: >-
1064010659
The label image resource that was used to create a custom label
1064110660
image.
10661+
rma_number:
10662+
type: string
10663+
nullable: true
10664+
description: >
10665+
An optional Return Merchandise Authorization number. If provided,
10666+
this value will be used as the return label's RMA number. If
10667+
omitted, the system will auto-generate an RMA number (current
10668+
default behavior). You can set it to any string value.
1064210669
create_return_label_response_body:
1064310670
title: create_return_label_response_body
1064410671
type: object

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "shipengine-openapi",
3-
"version": "1.20.0",
3+
"version": "1.20.1",
44
"description": "The official OpenAPI 3.0 definitions for ShipEngine™",
55
"main": "openapi.json",
66
"repository": {

0 commit comments

Comments
 (0)