|
2 | 2 | "openapi": "3.0.0",
|
3 | 3 | "info": {
|
4 | 4 | "title": "ShipEngine API",
|
5 |
| - "version": "1.1.202410032110", |
| 5 | + "version": "1.1.202410081510", |
6 | 6 | "termsOfService": "https://www.shipengine.com/terms-of-service/",
|
7 | 7 | "x-logo": {
|
8 | 8 | "url": "https://shipengine.github.io/img/shipengine-logo-square.png",
|
|
5619 | 5619 | "example": "Body of request cannot be null.",
|
5620 | 5620 | "minLength": 1,
|
5621 | 5621 | "description": "An error message associated with the failed API call"
|
| 5622 | + }, |
| 5623 | + "carrier_id": { |
| 5624 | + "readOnly": true, |
| 5625 | + "allOf": [ |
| 5626 | + { |
| 5627 | + "$ref": "#/components/schemas/se_id" |
| 5628 | + } |
| 5629 | + ], |
| 5630 | + "description": "A string that uniquely identifies the carrier that generated the error." |
| 5631 | + }, |
| 5632 | + "carrier_code": { |
| 5633 | + "readOnly": true, |
| 5634 | + "allOf": [ |
| 5635 | + { |
| 5636 | + "$ref": "#/components/schemas/carrier_code" |
| 5637 | + } |
| 5638 | + ], |
| 5639 | + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n" |
| 5640 | + }, |
| 5641 | + "field_name": { |
| 5642 | + "type": "string", |
| 5643 | + "readOnly": true, |
| 5644 | + "example": "shipment.ship_to.phone_number", |
| 5645 | + "description": "The name of the field that caused the error" |
5622 | 5646 | }
|
5623 | 5647 | }
|
5624 | 5648 | },
|
|
5703 | 5727 | ],
|
5704 | 5728 | "description": "The error code specified for the failed API Call"
|
5705 | 5729 | },
|
| 5730 | + "se_id": { |
| 5731 | + "title": "se_id", |
| 5732 | + "type": "string", |
| 5733 | + "minLength": 1, |
| 5734 | + "maxLength": 25, |
| 5735 | + "pattern": "^se(-[a-z0-9]+)+$", |
| 5736 | + "example": "se-28529731", |
| 5737 | + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc." |
| 5738 | + }, |
| 5739 | + "carrier_code": { |
| 5740 | + "title": "carrier_code", |
| 5741 | + "type": "string", |
| 5742 | + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", |
| 5743 | + "example": "dhl_express", |
| 5744 | + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n" |
| 5745 | + }, |
5706 | 5746 | "list_account_settings_images_response_body": {
|
5707 | 5747 | "title": "list_account_settings_images_response_body",
|
5708 | 5748 | "allOf": [
|
|
6876 | 6916 | ],
|
6877 | 6917 | "description": "The possible file formats in which shipping labels can be downloaded. We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats.\n\n|Label Format | Supported Carriers\n|--------------|-----------------------------------\n|`pdf` | All carriers\n|`png` | `fedex` <br> `stamps_com` <br> `ups` <br> `usps`\n|`zpl` | `access_worldwide` <br> `apc` <br> `asendia` <br> `dhl_global_mail` <br> `dhl_express` <br> `dhl_express_australia` <br> `dhl_express_canada` <br> `dhl_express_worldwide` <br> `dhl_express_uk` <br> `dpd` <br> `endicia` <br> `fedex` <br> `fedex_uk` <br> `firstmile` <br> `imex` <br> `newgistics` <br> `ontrac` <br> `rr_donnelley` <br> `stamps_com` <br> `ups` <br> `usps`\n"
|
6878 | 6918 | },
|
6879 |
| - "se_id": { |
6880 |
| - "title": "se_id", |
6881 |
| - "type": "string", |
6882 |
| - "minLength": 1, |
6883 |
| - "maxLength": 25, |
6884 |
| - "pattern": "^se(-[a-z0-9]+)+$", |
6885 |
| - "example": "se-28529731", |
6886 |
| - "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc." |
6887 |
| - }, |
6888 | 6919 | "label_download": {
|
6889 | 6920 | "title": "label_download",
|
6890 | 6921 | "type": "object",
|
|
7462 | 7493 | }
|
7463 | 7494 | }
|
7464 | 7495 | },
|
7465 |
| - "carrier_code": { |
7466 |
| - "title": "carrier_code", |
7467 |
| - "type": "string", |
7468 |
| - "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", |
7469 |
| - "example": "dhl_express", |
7470 |
| - "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n" |
7471 |
| - }, |
7472 | 7496 | "service": {
|
7473 | 7497 | "title": "service",
|
7474 | 7498 | "type": "object",
|
|
0 commit comments