@shipengine/connect-carrier-api 2.4.7 → 2.5.1

package/spec.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "ShipEngine Connect Carrier API",
     "description": "This API specification describes the canonical ShipEngine Carrier API connector module. A module which implements one or more endpoints from this specification can be integrated with the ShipEngine Carrier Platform.",
-    "version": "1.15.4"
+    "version": "1.16.0"
   },
   "paths": {
     "/Register": {
@@ -31,11 +31,44 @@
               "schema": {
                 "$ref": "#/components/schemas/ExampleRegisterRequest"
               },
-              "example": {"registration_info":{"username":"auctane-next-day","password":"password!","meter_number":"8675309"},"transaction_id":"00000000-0000-0000-0000-000000000000","metadata":{"username":"auctane-next-day","password":"password!","meter_number":"8675309"}}
+              "example": {
+                "registration_info": {
+                  "username": "auctane-next-day",
+                  "password": "password!",
+                  "meter_number": "8675309"
+                },
+                "transaction_id": "00000000-0000-0000-0000-000000000000",
+                "metadata": {
+                  "username": "auctane-next-day",
+                  "password": "password!",
+                  "meter_number": "8675309"
+                }
+              }
             }
           }
         },
         "responses": {
+          "200": {
+            "description": "The Register method returns the result of the carrier's authentication process. This information will be included in the metadata of every subsequent request to your application.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/RegisterResponse"
+                },
+                "example": {
+                  "credentials": {
+                    "username": "auctane-next-day",
+                    "password": "password!"
+                  },
+                  "metadata": {
+                    "username": "auctane-next-day",
+                    "password": "password!",
+                    "meter_number": "8675309"
+                  }
+                }
+              }
+            }
+          },
           "400": {
             "description": "Can be an internal or external error indicating an issue with the request that must be corrected.",
             "content": {
@@ -56,6 +89,9 @@
               }
             }
           },
+          "404": {
+            "description": "Use this when the behavior is not supported or the behavior is not available for the user."
+          },
           "500": {
             "description": "An unexpected error occurred in the carrier app.",
             "content": {
@@ -75,20 +111,6 @@
                 }
               }
             }
-          },
-          "404": {
-            "description": "Use this when the behavior is not supported or the behavior is not available for the user."
-          },
-          "200": {
-            "description": "The Register method returns the result of the carrier's authentication process. This information will be included in the metadata of every subsequent request to your application.",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/RegisterResponse"
-                },
-                "example": {"credentials":{"username":"auctane-next-day","password":"password!"},"metadata":{"username":"auctane-next-day","password":"password!","meter_number":"8675309"}}
-              }
-            }
           }
         }
       }
@@ -122,6 +144,16 @@
           }
         },
         "responses": {
+          "200": {
+            "description": "This object model represents the response from a successful create label request.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/CreateLabelResponse"
+                }
+              }
+            }
+          },
           "400": {
             "description": "Can be an internal or external error indicating an issue with the request that must be corrected.",
             "content": {
@@ -142,6 +174,9 @@
               }
             }
           },
+          "404": {
+            "description": "Use this when the behavior is not supported or the behavior is not available for the user."
+          },
           "500": {
             "description": "An unexpected error occurred in the carrier app.",
             "content": {
@@ -161,16 +196,88 @@
                 }
               }
             }
+          }
+        }
+      }
+    },
+    "/CreateLabelPayment": {
+      "post": {
+        "tags": [
+          "Labels"
+        ],
+        "description": "This method creates a label payment before creating the label itself. This may be necessary in situations\r\nwhere labels must be paid for prior to creating them. Accepts an array of label payments, which may contain\r\none or many items, depending on whether we are purchasing a single label or processing a batch. In that\r\nscenario this method will be called once before making all the individual `CreateLabel` calls for the batch.\r\nIn order for this method to be called the carrier must have the `RequiresLabelPayment` flag.",
+        "operationId": "Create Label Payment",
+        "parameters": [
+          {
+            "name": "ShipStation-TransactionID",
+            "in": "header",
+            "description": "The transaction ID uniquely represents this request.",
+            "schema": {
+              "type": "string",
+              "format": "uuid"
+            }
+          }
+        ],
+        "requestBody": {
+          "description": "An object containing information about the labels that require payments.",
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/CreateLabelPaymentRequest"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "This object model represents the response from a successful create label payment request.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/CreateLabelPaymentResponse"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Can be an internal or external error indicating an issue with the request that must be corrected.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/BadRequestResponse"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Use this to indicate an authentication or authorization error.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/UnauthorizedResponse"
+                }
+              }
+            }
           },
           "404": {
             "description": "Use this when the behavior is not supported or the behavior is not available for the user."
           },
-          "200": {
-            "description": "This object model represents the response from a successful create label request.",
+          "500": {
+            "description": "An unexpected error occurred in the carrier app.",
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/CreateLabelResponse"
+                  "$ref": "#/components/schemas/InternalServerErrorResponse"
+                }
+              }
+            }
+          },
+          "520": {
+            "description": "Use this when an error is the result of calling an external service, such as an API. This indicates that the error came from a downstream service rather than directly in your app.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ExternalServerErrorResponse"
                 }
               }
             }
@@ -207,6 +314,16 @@
           }
         },
         "responses": {
+          "200": {
+            "description": "This object model represents the response from a successful void labels request.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/VoidLabelsResponse"
+                }
+              }
+            }
+          },
           "400": {
             "description": "Can be an internal or external error indicating an issue with the request that must be corrected.",
             "content": {
@@ -227,6 +344,9 @@
               }
             }
           },
+          "404": {
+            "description": "Use this when the behavior is not supported or the behavior is not available for the user."
+          },
           "500": {
             "description": "An unexpected error occurred in the carrier app.",
             "content": {
@@ -246,19 +366,6 @@
                 }
               }
             }
-          },
-          "404": {
-            "description": "Use this when the behavior is not supported or the behavior is not available for the user."
-          },
-          "200": {
-            "description": "This object model represents the response from a successful void labels request.",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/VoidLabelsResponse"
-                }
-              }
-            }
           }
         }
       }
@@ -292,6 +399,16 @@
           }
         },
         "responses": {
+          "200": {
+            "description": "This object model represents the response from a successful create manifest request.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/CreateManifestResponse"
+                }
+              }
+            }
+          },
           "400": {
             "description": "Can be an internal or external error indicating an issue with the request that must be corrected.",
             "content": {
@@ -312,6 +429,9 @@
               }
             }
           },
+          "404": {
+            "description": "Use this when the behavior is not supported or the behavior is not available for the user."
+          },
           "500": {
             "description": "An unexpected error occurred in the carrier app.",
             "content": {
@@ -331,19 +451,6 @@
                 }
               }
             }
-          },
-          "404": {
-            "description": "Use this when the behavior is not supported or the behavior is not available for the user."
-          },
-          "200": {
-            "description": "This object model represents the response from a successful create manifest request.",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/CreateManifestResponse"
-                }
-              }
-            }
           }
         }
       }
@@ -377,6 +484,16 @@
           }
         },
         "responses": {
+          "200": {
+            "description": "This object model represents the response from a successful create manifest request.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/CreateManifestResponse"
+                }
+              }
+            }
+          },
           "400": {
             "description": "Can be an internal or external error indicating an issue with the request that must be corrected.",
             "content": {
@@ -397,6 +514,9 @@
               }
             }
           },
+          "404": {
+            "description": "Use this when the behavior is not supported or the behavior is not available for the user."
+          },
           "500": {
             "description": "An unexpected error occurred in the carrier app.",
             "content": {
@@ -416,19 +536,6 @@
                 }
               }
             }
-          },
-          "404": {
-            "description": "Use this when the behavior is not supported or the behavior is not available for the user."
-          },
-          "200": {
-            "description": "This object model represents the response from a successful create manifest request.",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/CreateManifestResponse"
-                }
-              }
-            }
           }
         }
       }
@@ -458,11 +565,48 @@
               "schema": {
                 "$ref": "#/components/schemas/ValidateInboundDataRequest"
               },
-              "example": {"data":"{\"tracking_number\":\"12345678901234567890\",\"status\":11,\"timestamp\":\"2021-08-11T21:15:00Z\"}","headers":{"content-type":["application/json"],"X-Signature":["v1:cedff7d0389299089e4c62c1042ce93059664d455ed0bfdf29cb959a861bda4b","v2:4b3157c730e498cb1126359fa020017e9e7c97b148f2d55da822fdfcd83e4a19"]},"transaction_id":"00000000-0000-0000-0000-000000000000","metadata":{"username":"auctane-next-day","password":"password!","meter_number":"8675309"}}
+              "example": {
+                "data": "{\"tracking_number\":\"12345678901234567890\",\"status\":11,\"timestamp\":\"2021-08-11T21:15:00Z\"}",
+                "headers": {
+                  "content-type": [
+                    "application/json"
+                  ],
+                  "X-Signature": [
+                    "v1:cedff7d0389299089e4c62c1042ce93059664d455ed0bfdf29cb959a861bda4b",
+                    "v2:4b3157c730e498cb1126359fa020017e9e7c97b148f2d55da822fdfcd83e4a19"
+                  ]
+                },
+                "transaction_id": "00000000-0000-0000-0000-000000000000",
+                "metadata": {
+                  "username": "auctane-next-day",
+                  "password": "password!",
+                  "meter_number": "8675309"
+                }
+              }
             }
           }
         },
         "responses": {
+          "200": {
+            "description": "An object with a list of information contained in the inbound data.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ValidateInboundDataResponse"
+                },
+                "examples": {
+                  "Tracking": {
+                    "summary": "Tracking",
+                    "value": {
+                      "content_types": [
+                        "tracking"
+                      ]
+                    }
+                  }
+                }
+              }
+            }
+          },
           "400": {
             "description": "Can be an internal or external error indicating an issue with the request that must be corrected.",
             "content": {
@@ -483,6 +627,9 @@
               }
             }
           },
+          "404": {
+            "description": "Use this when the behavior is not supported or the behavior is not available for the user."
+          },
           "500": {
             "description": "An unexpected error occurred in the carrier app.",
             "content": {
@@ -502,25 +649,6 @@
                 }
               }
             }
-          },
-          "404": {
-            "description": "Use this when the behavior is not supported or the behavior is not available for the user."
-          },
-          "200": {
-            "description": "An object with a list of information contained in the inbound data.",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/ValidateInboundDataResponse"
-                },
-                "examples": {
-                  "Tracking": {
-                    "summary": "Tracking",
-                    "value": {"content_types":["tracking"]}
-                  }
-                }
-              }
-            }
           }
         }
       }
@@ -550,11 +678,65 @@
               "schema": {
                 "$ref": "#/components/schemas/NormalizeTrackingDataRequest"
               },
-              "example": {"data":"{\"tracking_number\":\"12345678901234567890\",\"status\":11,\"timestamp\":\"2021-08-11T21:15:00Z\"}","headers":{"content-type":["application/json"],"X-Signature":["v1:cedff7d0389299089e4c62c1042ce93059664d455ed0bfdf29cb959a861bda4b","v2:4b3157c730e498cb1126359fa020017e9e7c97b148f2d55da822fdfcd83e4a19"]},"transaction_id":"00000000-0000-0000-0000-000000000000","metadata":{"username":"auctane-next-day","password":"password!","meter_number":"8675309"}}
+              "example": {
+                "data": "{\"tracking_number\":\"12345678901234567890\",\"status\":11,\"timestamp\":\"2021-08-11T21:15:00Z\"}",
+                "headers": {
+                  "content-type": [
+                    "application/json"
+                  ],
+                  "X-Signature": [
+                    "v1:cedff7d0389299089e4c62c1042ce93059664d455ed0bfdf29cb959a861bda4b",
+                    "v2:4b3157c730e498cb1126359fa020017e9e7c97b148f2d55da822fdfcd83e4a19"
+                  ]
+                },
+                "transaction_id": "00000000-0000-0000-0000-000000000000",
+                "metadata": {
+                  "username": "auctane-next-day",
+                  "password": "password!",
+                  "meter_number": "8675309"
+                }
+              }
             }
           }
         },
         "responses": {
+          "200": {
+            "description": "An object with tracking information for one or more shipments.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/NormalizeTrackingDataResponse"
+                },
+                "examples": {
+                  "Delivered": {
+                    "summary": "Delivered",
+                    "value": {
+                      "tracking_info": [
+                        {
+                          "carrier_name": "UPS",
+                          "tracking_number": "12345678901234567890",
+                          "standardized_status_code": "DE",
+                          "carrier_status_code": "11",
+                          "carrier_status_description": "Delivered",
+                          "estimated_delivery_datetime": "2021-08-11T00:00:00",
+                          "actual_delivery_datetime": "2021-08-11T21:15:00Z",
+                          "service": {
+                            "code": "03",
+                            "name": "UPS® Ground"
+                          },
+                          "packaging": "package",
+                          "package_count": 1,
+                          "shipping_problem": false,
+                          "carrierEnum": 0
+                        }
+                      ],
+                      "update_method": "append"
+                    }
+                  }
+                }
+              }
+            }
+          },
           "400": {
             "description": "Can be an internal or external error indicating an issue with the request that must be corrected.",
             "content": {
@@ -575,6 +757,9 @@
               }
             }
           },
+          "404": {
+            "description": "Use this when the behavior is not supported or the behavior is not available for the user."
+          },
           "500": {
             "description": "An unexpected error occurred in the carrier app.",
             "content": {
@@ -594,25 +779,6 @@
                 }
               }
             }
-          },
-          "404": {
-            "description": "Use this when the behavior is not supported or the behavior is not available for the user."
-          },
-          "200": {
-            "description": "An object with tracking information for one or more shipments.",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/NormalizeTrackingDataResponse"
-                },
-                "examples": {
-                  "Delivered": {
-                    "summary": "Delivered",
-                    "value": {"tracking_info":[{"carrier_name":"UPS","tracking_number":"12345678901234567890","standardized_status_code":"DE","carrier_status_code":"11","carrier_status_description":"Delivered","estimated_delivery_datetime":"2021-08-11T00:00:00","actual_delivery_datetime":"2021-08-11T21:15:00Z","service":{"code":"03","name":"UPS® Ground"},"packaging":"package","package_count":1,"shipping_problem":false,"carrierEnum":0}],"update_method":"append"}
-                  }
-                }
-              }
-            }
           }
         }
       }
@@ -643,6 +809,16 @@
           }
         },
         "responses": {
+          "200": {
+            "description": "This object model represents the response from a successful create notification request.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/CreateNotificationResponse"
+                }
+              }
+            }
+          },
           "400": {
             "description": "Can be an internal or external error indicating an issue with the request that must be corrected.",
             "content": {
@@ -663,6 +839,9 @@
               }
             }
           },
+          "404": {
+            "description": "Use this when the behavior is not supported or the behavior is not available for the user."
+          },
           "500": {
             "description": "An unexpected error occurred in the carrier app.",
             "content": {
@@ -682,19 +861,6 @@
                 }
               }
             }
-          },
-          "404": {
-            "description": "Use this when the behavior is not supported or the behavior is not available for the user."
-          },
-          "200": {
-            "description": "This object model represents the response from a successful create notification request.",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/CreateNotificationResponse"
-                }
-              }
-            }
           }
         }
       }
@@ -725,6 +891,16 @@
           }
         },
         "responses": {
+          "200": {
+            "description": "This object model represents the response from a successful cancel notification request.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/CancelNotificationResponse"
+                }
+              }
+            }
+          },
           "400": {
             "description": "Can be an internal or external error indicating an issue with the request that must be corrected.",
             "content": {
@@ -745,6 +921,9 @@
               }
             }
           },
+          "404": {
+            "description": "Use this when the behavior is not supported or the behavior is not available for the user."
+          },
           "500": {
             "description": "An unexpected error occurred in the carrier app.",
             "content": {
@@ -764,19 +943,6 @@
                 }
               }
             }
-          },
-          "404": {
-            "description": "Use this when the behavior is not supported or the behavior is not available for the user."
-          },
-          "200": {
-            "description": "This object model represents the response from a successful cancel notification request.",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/CancelNotificationResponse"
-                }
-              }
-            }
           }
         }
       }
@@ -810,6 +976,16 @@
           }
         },
         "responses": {
+          "200": {
+            "description": "This object model represents the response from a successful schedule pickup request.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SchedulePickupResponse"
+                }
+              }
+            }
+          },
           "400": {
             "description": "Can be an internal or external error indicating an issue with the request that must be corrected.",
             "content": {
@@ -830,6 +1006,9 @@
               }
             }
           },
+          "404": {
+            "description": "Use this when the behavior is not supported or the behavior is not available for the user."
+          },
           "500": {
             "description": "An unexpected error occurred in the carrier app.",
             "content": {
@@ -849,19 +1028,6 @@
                 }
               }
             }
-          },
-          "404": {
-            "description": "Use this when the behavior is not supported or the behavior is not available for the user."
-          },
-          "200": {
-            "description": "This object model represents the response from a successful schedule pickup request.",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/SchedulePickupResponse"
-                }
-              }
-            }
           }
         }
       }
@@ -892,6 +1058,16 @@
           }
         },
         "responses": {
+          "200": {
+            "description": "This object model represents the response from a successful cancel pickup request.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/CancelPickupResponse"
+                }
+              }
+            }
+          },
           "400": {
             "description": "Can be an internal or external error indicating an issue with the request that must be corrected.",
             "content": {
@@ -912,6 +1088,9 @@
               }
             }
           },
+          "404": {
+            "description": "Use this when the behavior is not supported or the behavior is not available for the user."
+          },
           "500": {
             "description": "An unexpected error occurred in the carrier app.",
             "content": {
@@ -931,19 +1110,6 @@
                 }
               }
             }
-          },
-          "404": {
-            "description": "Use this when the behavior is not supported or the behavior is not available for the user."
-          },
-          "200": {
-            "description": "This object model represents the response from a successful cancel pickup request.",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/CancelPickupResponse"
-                }
-              }
-            }
           }
         }
       }
@@ -977,6 +1143,16 @@
           }
         },
         "responses": {
+          "200": {
+            "description": "This object model represents the response from a successful get rates request.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/GetRatesResponse"
+                }
+              }
+            }
+          },
           "400": {
             "description": "Can be an internal or external error indicating an issue with the request that must be corrected.",
             "content": {
@@ -997,6 +1173,9 @@
               }
             }
           },
+          "404": {
+            "description": "Use this when the behavior is not supported or the behavior is not available for the user."
+          },
           "500": {
             "description": "An unexpected error occurred in the carrier app.",
             "content": {
@@ -1016,19 +1195,6 @@
                 }
               }
             }
-          },
-          "404": {
-            "description": "Use this when the behavior is not supported or the behavior is not available for the user."
-          },
-          "200": {
-            "description": "This object model represents the response from a successful get rates request.",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/GetRatesResponse"
-                }
-              }
-            }
           }
         }
       }
@@ -1062,6 +1228,16 @@
           }
         },
         "responses": {
+          "200": {
+            "description": "This object model represents the response from a successful get relay points request.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/GetRelayPointsResponse"
+                }
+              }
+            }
+          },
           "400": {
             "description": "Can be an internal or external error indicating an issue with the request that must be corrected.",
             "content": {
@@ -1082,6 +1258,9 @@
               }
             }
           },
+          "404": {
+            "description": "Use this when the behavior is not supported or the behavior is not available for the user."
+          },
           "500": {
             "description": "An unexpected error occurred in the carrier app.",
             "content": {
@@ -1101,19 +1280,6 @@
                 }
               }
             }
-          },
-          "404": {
-            "description": "Use this when the behavior is not supported or the behavior is not available for the user."
-          },
-          "200": {
-            "description": "This object model represents the response from a successful get relay points request.",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/GetRelayPointsResponse"
-                }
-              }
-            }
           }
         }
       }
@@ -1143,11 +1309,256 @@
               "schema": {
                 "$ref": "#/components/schemas/TrackingRequest"
               },
-              "example": {"tracking_number":"12345678901234567890","is_return":false,"identifiers":[{"type":"tracking_number","value":"12345678901234567890"},{"type":"carrier_transaction_id","value":"US-12345678901234567890-1"}],"attributes":[{"type":"marketplace_order_token","value":"123456abcdefg7890"}],"transaction_id":"00000000-0000-0000-0000-000000000000","metadata":{"username":"auctane-next-day","password":"password!","meter_number":"8675309"}}
+              "example": {
+                "tracking_number": "12345678901234567890",
+                "is_return": false,
+                "identifiers": [
+                  {
+                    "type": "tracking_number",
+                    "value": "12345678901234567890"
+                  },
+                  {
+                    "type": "carrier_transaction_id",
+                    "value": "US-12345678901234567890-1"
+                  }
+                ],
+                "attributes": [
+                  {
+                    "type": "marketplace_order_token",
+                    "value": "123456abcdefg7890"
+                  }
+                ],
+                "transaction_id": "00000000-0000-0000-0000-000000000000",
+                "metadata": {
+                  "username": "auctane-next-day",
+                  "password": "password!",
+                  "meter_number": "8675309"
+                }
+              }
             }
           }
         },
         "responses": {
+          "200": {
+            "description": "An object with tracking information for the specified shipment.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TrackingResponse"
+                },
+                "examples": {
+                  "Delivered with Event History": {
+                    "summary": "Delivered with Event History",
+                    "value": {
+                      "tracking_info": {
+                        "carrier_name": "UPS",
+                        "tracking_number": "12345678901234567890",
+                        "standardized_status_code": "DE",
+                        "carrier_status_code": "11",
+                        "carrier_status_description": "Delivered",
+                        "estimated_delivery_datetime": "2021-08-11T00:00:00",
+                        "actual_delivery_datetime": "2021-08-11T21:15:00Z",
+                        "weight": 500,
+                        "dimensions": {
+                          "length": 10,
+                          "width": 10,
+                          "height": 10
+                        },
+                        "service": {
+                          "code": "03",
+                          "name": "UPS® Ground"
+                        },
+                        "packaging": "package",
+                        "package_count": 1,
+                        "events": [
+                          {
+                            "event_datetime": "2021-08-08T21:15:00Z",
+                            "event_datetime_local": "2021-08-08T16:15:00",
+                            "event_code": "3",
+                            "description": "Order Processed: Ready for UPS",
+                            "city": "Austin",
+                            "state": "TX",
+                            "postal_code": "78756",
+                            "country": "US",
+                            "geo": {
+                              "lat": 30.31,
+                              "long": -97.74
+                            },
+                            "status_code": "AC"
+                          },
+                          {
+                            "event_datetime": "2021-08-09T09:15:00Z",
+                            "event_datetime_local": "2021-08-09T04:15:00",
+                            "event_code": "5",
+                            "description": "In Transit",
+                            "city": "Austin",
+                            "state": "TX",
+                            "postal_code": "78756",
+                            "country": "US",
+                            "geo": {
+                              "lat": 30.2,
+                              "long": -97.66
+                            },
+                            "status_code": "IT"
+                          },
+                          {
+                            "event_datetime": "2021-08-10T09:15:00Z",
+                            "event_datetime_local": "2021-08-10T04:15:00",
+                            "event_code": "6",
+                            "description": "On Vehicle for Delivery",
+                            "city": "Los Angeles",
+                            "state": "CA",
+                            "postal_code": "90045",
+                            "country": "US",
+                            "geo": {
+                              "lat": 33.95,
+                              "long": -118.38
+                            },
+                            "status_code": "IT"
+                          },
+                          {
+                            "event_datetime": "2021-08-10T15:15:00Z",
+                            "event_datetime_local": "2021-08-10T10:15:00",
+                            "event_code": "21",
+                            "description": "On Vehicle for Delivery Today",
+                            "city": "Los Angeles",
+                            "state": "CA",
+                            "postal_code": "90045",
+                            "country": "US",
+                            "geo": {
+                              "lat": 33.95,
+                              "long": -118.38
+                            },
+                            "status_code": "IT"
+                          },
+                          {
+                            "event_datetime": "2021-08-10T21:15:00Z",
+                            "event_datetime_local": "2021-08-10T16:15:00",
+                            "event_code": "22",
+                            "description": "First Attempt Made",
+                            "city": "El Segundo",
+                            "state": "CA",
+                            "postal_code": "90245",
+                            "country": "US",
+                            "geo": {
+                              "lat": 33.95,
+                              "long": -118.38
+                            },
+                            "status_code": "AT"
+                          },
+                          {
+                            "event_datetime": "2021-08-11T03:15:00Z",
+                            "event_datetime_local": "2021-08-10T22:15:00",
+                            "event_code": "21",
+                            "description": "On Vehicle for Delivery Today",
+                            "city": "Los Angeles",
+                            "state": "CA",
+                            "postal_code": "90045",
+                            "country": "US",
+                            "geo": {
+                              "lat": 33.95,
+                              "long": -118.38
+                            },
+                            "status_code": "IT"
+                          },
+                          {
+                            "event_datetime": "2021-08-11T21:15:00Z",
+                            "event_datetime_local": "2021-08-11T16:15:00",
+                            "event_code": "11",
+                            "description": "Delivered",
+                            "city": "El Segundo",
+                            "state": "CA",
+                            "postal_code": "90245",
+                            "country": "US",
+                            "geo": {
+                              "lat": 33.95,
+                              "long": -118.38
+                            },
+                            "status_code": "DE"
+                          }
+                        ],
+                        "shipping_problem": false,
+                        "carrierEnum": 0
+                      }
+                    }
+                  },
+                  "Not Yet in System": {
+                    "summary": "Not Yet in System",
+                    "value": {
+                      "tracking_info": {
+                        "carrier_name": "UPS",
+                        "tracking_number": "12345678901234567890",
+                        "standardized_status_code": "NY",
+                        "events": [],
+                        "shipping_problem": false,
+                        "carrierEnum": 0
+                      }
+                    }
+                  },
+                  "Fatal Exception": {
+                    "summary": "Fatal Exception",
+                    "value": {
+                      "tracking_info": {
+                        "carrier_name": "UPS",
+                        "tracking_number": "12345678901234567890",
+                        "standardized_status_code": "EX",
+                        "carrier_status_code": "64",
+                        "carrier_status_description": "Delivery Refused",
+                        "estimated_delivery_datetime": "2021-08-11T00:00:00",
+                        "actual_delivery_datetime": "2021-08-11T21:15:00Z",
+                        "weight": 500,
+                        "dimensions": {
+                          "length": 10,
+                          "width": 10,
+                          "height": 10
+                        },
+                        "service": {
+                          "code": "03",
+                          "name": "UPS® Ground"
+                        },
+                        "packaging": "package",
+                        "package_count": 1,
+                        "events": [
+                          {
+                            "event_datetime": "2021-08-09T09:15:00Z",
+                            "event_datetime_local": "2021-08-09T04:15:00",
+                            "event_code": "5",
+                            "description": "In Transit",
+                            "city": "Austin",
+                            "state": "TX",
+                            "postal_code": "78756",
+                            "country": "US",
+                            "geo": {
+                              "lat": 30.2,
+                              "long": -97.66
+                            },
+                            "status_code": "IT"
+                          },
+                          {
+                            "event_datetime": "2021-08-11T21:15:00Z",
+                            "event_datetime_local": "2021-08-11T16:15:00",
+                            "event_code": "59",
+                            "description": "Delivery Refused",
+                            "city": "El Segundo",
+                            "state": "CA",
+                            "postal_code": "90245",
+                            "country": "US",
+                            "geo": {
+                              "lat": 33.95,
+                              "long": -118.38
+                            },
+                            "status_code": "EX"
+                          }
+                        ],
+                        "shipping_problem": false,
+                        "carrierEnum": 0
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          },
           "400": {
             "description": "Can be an internal or external error indicating an issue with the request that must be corrected.",
             "content": {
@@ -1168,6 +1579,9 @@
               }
             }
           },
+          "404": {
+            "description": "Use this when the behavior is not supported or the behavior is not available for the user."
+          },
           "500": {
             "description": "An unexpected error occurred in the carrier app.",
             "content": {
@@ -1187,33 +1601,6 @@
                 }
               }
             }
-          },
-          "404": {
-            "description": "Use this when the behavior is not supported or the behavior is not available for the user."
-          },
-          "200": {
-            "description": "An object with tracking information for the specified shipment.",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/TrackingResponse"
-                },
-                "examples": {
-                  "Delivered with Event History": {
-                    "summary": "Delivered with Event History",
-                    "value": {"tracking_info":{"carrier_name":"UPS","tracking_number":"12345678901234567890","standardized_status_code":"DE","carrier_status_code":"11","carrier_status_description":"Delivered","estimated_delivery_datetime":"2021-08-11T00:00:00","actual_delivery_datetime":"2021-08-11T21:15:00Z","weight":500.0,"dimensions":{"length":10.0,"width":10.0,"height":10.0},"service":{"code":"03","name":"UPS® Ground"},"packaging":"package","package_count":1,"events":[{"event_datetime":"2021-08-08T21:15:00Z","event_datetime_local":"2021-08-08T16:15:00","event_code":"3","description":"Order Processed: Ready for UPS","city":"Austin","state":"TX","postal_code":"78756","country":"US","geo":{"lat":30.31,"long":-97.74},"status_code":"AC"},{"event_datetime":"2021-08-09T09:15:00Z","event_datetime_local":"2021-08-09T04:15:00","event_code":"5","description":"In Transit","city":"Austin","state":"TX","postal_code":"78756","country":"US","geo":{"lat":30.2,"long":-97.66},"status_code":"IT"},{"event_datetime":"2021-08-10T09:15:00Z","event_datetime_local":"2021-08-10T04:15:00","event_code":"6","description":"On Vehicle for Delivery","city":"Los Angeles","state":"CA","postal_code":"90045","country":"US","geo":{"lat":33.95,"long":-118.38},"status_code":"IT"},{"event_datetime":"2021-08-10T15:15:00Z","event_datetime_local":"2021-08-10T10:15:00","event_code":"21","description":"On Vehicle for Delivery Today","city":"Los Angeles","state":"CA","postal_code":"90045","country":"US","geo":{"lat":33.95,"long":-118.38},"status_code":"IT"},{"event_datetime":"2021-08-10T21:15:00Z","event_datetime_local":"2021-08-10T16:15:00","event_code":"22","description":"First Attempt Made","city":"El Segundo","state":"CA","postal_code":"90245","country":"US","geo":{"lat":33.95,"long":-118.38},"status_code":"AT"},{"event_datetime":"2021-08-11T03:15:00Z","event_datetime_local":"2021-08-10T22:15:00","event_code":"21","description":"On Vehicle for Delivery Today","city":"Los Angeles","state":"CA","postal_code":"90045","country":"US","geo":{"lat":33.95,"long":-118.38},"status_code":"IT"},{"event_datetime":"2021-08-11T21:15:00Z","event_datetime_local":"2021-08-11T16:15:00","event_code":"11","description":"Delivered","city":"El Segundo","state":"CA","postal_code":"90245","country":"US","geo":{"lat":33.95,"long":-118.38},"status_code":"DE"}],"shipping_problem":false,"carrierEnum":0}}
-                  },
-                  "Not Yet in System": {
-                    "summary": "Not Yet in System",
-                    "value": {"tracking_info":{"carrier_name":"UPS","tracking_number":"12345678901234567890","standardized_status_code":"NY","events":[],"shipping_problem":false,"carrierEnum":0}}
-                  },
-                  "Fatal Exception": {
-                    "summary": "Fatal Exception",
-                    "value": {"tracking_info":{"carrier_name":"UPS","tracking_number":"12345678901234567890","standardized_status_code":"EX","carrier_status_code":"64","carrier_status_description":"Delivery Refused","estimated_delivery_datetime":"2021-08-11T00:00:00","actual_delivery_datetime":"2021-08-11T21:15:00Z","weight":500.0,"dimensions":{"length":10.0,"width":10.0,"height":10.0},"service":{"code":"03","name":"UPS® Ground"},"packaging":"package","package_count":1,"events":[{"event_datetime":"2021-08-09T09:15:00Z","event_datetime_local":"2021-08-09T04:15:00","event_code":"5","description":"In Transit","city":"Austin","state":"TX","postal_code":"78756","country":"US","geo":{"lat":30.2,"long":-97.66},"status_code":"IT"},{"event_datetime":"2021-08-11T21:15:00Z","event_datetime_local":"2021-08-11T16:15:00","event_code":"59","description":"Delivery Refused","city":"El Segundo","state":"CA","postal_code":"90245","country":"US","geo":{"lat":33.95,"long":-118.38},"status_code":"EX"}],"shipping_problem":false,"carrierEnum":0}}
-                  }
-                }
-              }
-            }
           }
         }
       }
@@ -1345,7 +1732,7 @@
             "nullable": true
           }
         },
-        "additionalProperties": { },
+        "additionalProperties": {},
         "description": "This is a schemaless object. It is for open ended customizations unique to particular carriers. The documented\r\nkeys are some common options shared by many carriers, but are not definitive. Advanced options you support will\r\nbe defined in ShipEngine. If the field is absent it should be interpreted as the default value for any\r\napplicable options, e.g. false for booleans."
       },
       "Authorization": {
@@ -1390,7 +1777,7 @@
           },
           "metadata": {
             "type": "object",
-            "additionalProperties": { },
+            "additionalProperties": {},
             "nullable": true
           }
         },
@@ -1401,7 +1788,7 @@
         "properties": {
           "metadata": {
             "type": "object",
-            "additionalProperties": { },
+            "additionalProperties": {},
             "description": "This is an optional schemaless object that you may return with a successful response. Anything returned\r\nunder this key will be included in all future requests. For example, you may store additional static\r\nproperties about the end user or their connection to the carrier. The maximum storage size\r\nfor data under this key is 4KB.",
             "nullable": true
           }
@@ -1665,6 +2052,49 @@
         ],
         "type": "string"
       },
+      "CreateLabelPaymentRequest": {
+        "type": "object",
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/BaseRequest"
+          }
+        ],
+        "properties": {
+          "labels": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/LabelDetails"
+            },
+            "nullable": true
+          }
+        },
+        "additionalProperties": false
+      },
+      "CreateLabelPaymentResponse": {
+        "type": "object",
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/BaseResponse"
+          }
+        ],
+        "properties": {
+          "transaction_id": {
+            "type": "string",
+            "description": "The transaction ID uniquely represents this request.",
+            "format": "uuid"
+          },
+          "results": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/LabelPaymentResult"
+            },
+            "description": "Label payment results.",
+            "nullable": true
+          }
+        },
+        "additionalProperties": false,
+        "description": "This model represents the response from a successful create label payment request."
+      },
       "CreateLabelRequest": {
         "type": "object",
         "allOf": [
@@ -1768,6 +2198,14 @@
             "type": "string",
             "description": "Unique identifier for the carrier rate",
             "nullable": true
+          },
+          "alternative_identifiers": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Identifier"
+            },
+            "description": "Alternative identifiers associated with this shipment.",
+            "nullable": true
           }
         },
         "additionalProperties": false
@@ -1948,7 +2386,7 @@
           },
           "manifest_identifiers": {
             "type": "object",
-            "additionalProperties": { },
+            "additionalProperties": {},
             "description": "Carrier information needed to get created manifests.\r\nOnly needed if carrier requires two calls to create and get manifests.",
             "nullable": true
           }
@@ -2383,7 +2821,7 @@
           },
           "manifest_identifiers": {
             "type": "object",
-            "additionalProperties": { },
+            "additionalProperties": {},
             "description": "Carrier specific data needed to retrieve Manifest results",
             "nullable": true
           },
@@ -2589,6 +3027,121 @@
         "additionalProperties": false,
         "description": "This model represents a module level error that was caught."
       },
+      "LabelDetails": {
+        "type": "object",
+        "properties": {
+          "correlation_id": {
+            "type": "string",
+            "description": "A unique identifier for the label in this request which should be used to correlate the results.",
+            "nullable": true
+          },
+          "service_code": {
+            "type": "string",
+            "description": "The service code uniquely identifies a shipping service that you offer. Which service codes can be passed\r\nto you will be configured in ShipEngine.",
+            "nullable": true
+          },
+          "ship_datetime": {
+            "type": "string",
+            "description": "When the package is expected to ship. Not guaranteed to be in the future. Formatted per the\r\nhttps://tools.ietf.org/html/rfc3339 spec. Will always be in UTC.",
+            "format": "date-time"
+          },
+          "confirmation": {
+            "$ref": "#/components/schemas/ConfirmationTypes"
+          },
+          "label_format": {
+            "$ref": "#/components/schemas/DocumentFormat"
+          },
+          "label_layout": {
+            "$ref": "#/components/schemas/LabelLayouts"
+          },
+          "is_test_label": {
+            "type": "boolean",
+            "description": "Whether this request is the result of a test. When true the request must not result in any financial charges\r\nto any party. If the field is absent it should be interpreted as false"
+          },
+          "advanced_options": {
+            "$ref": "#/components/schemas/AdvancedOptions"
+          },
+          "insurance_provider": {
+            "$ref": "#/components/schemas/InsuranceProviders"
+          },
+          "is_return_label": {
+            "type": "boolean",
+            "description": "Whether this label is to return a previously shipped package. If the field is absent it should be\r\ninterpreted as false."
+          },
+          "packages": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Package"
+            },
+            "description": "All the packages that make up this shipment. There will always be at least one package defined.",
+            "nullable": true
+          },
+          "ship_to": {
+            "$ref": "#/components/schemas/ShipTo"
+          },
+          "ship_from": {
+            "$ref": "#/components/schemas/ShipFrom"
+          },
+          "pickup_location": {
+            "$ref": "#/components/schemas/PudoLocation"
+          },
+          "relay_points": {
+            "$ref": "#/components/schemas/RelayPointDetails"
+          },
+          "ship_from_display": {
+            "$ref": "#/components/schemas/ShipFromDisplay"
+          },
+          "next_day": {
+            "type": "boolean",
+            "description": "Whether this shipment is expected to use a next day service class. If the field is absent it\r\nshould be interpreted as false",
+            "nullable": true
+          },
+          "international": {
+            "type": "boolean",
+            "description": "Whether this shipment is deemed international.",
+            "nullable": true
+          },
+          "reference": {
+            "type": "string",
+            "description": "A user specified free form string to identify this shipment in their own system.",
+            "nullable": true
+          },
+          "return_details": {
+            "$ref": "#/components/schemas/ReturnLabelDetails"
+          },
+          "fulfillment_plan_details": {
+            "$ref": "#/components/schemas/FulfillmentPlanDetails"
+          },
+          "attachments": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Document"
+            },
+            "description": "Attachments that may be required to be sent to the carrier, in particular customs documents or\r\ncommercial invoices.",
+            "nullable": true
+          },
+          "bill_shipping_to": {
+            "$ref": "#/components/schemas/BillTo"
+          },
+          "carrier_pickup_window": {
+            "$ref": "#/components/schemas/TimeWindow"
+          },
+          "carrier_rate_id": {
+            "type": "string",
+            "description": "Unique identifier for the carrier rate",
+            "nullable": true
+          },
+          "alternative_identifiers": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Identifier"
+            },
+            "description": "Alternative identifiers associated with this shipment.",
+            "nullable": true
+          }
+        },
+        "additionalProperties": false
+      },
       "LabelDownload": {
         "type": "object",
         "allOf": [
@@ -2652,6 +3205,41 @@
         "additionalProperties": false,
         "description": "Package information provided from the carrier"
       },
+      "LabelPaymentResult": {
+        "type": "object",
+        "properties": {
+          "correlation_id": {
+            "type": "string",
+            "description": "A unique identifier for the label as specified in the request to correlate the results.",
+            "nullable": true
+          },
+          "alternative_identifiers": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Identifier"
+            },
+            "description": "Alternative identifiers associated with this label payment. Any values returned will be included in\r\nsubsequent requests for the related shipment such as `CreateLabel`. An example use case would be returning\r\nthe carrier's internal identifier for the shipment that was paid for as the `carrier_transaction_id` and\r\nthen referencing that in the `CreateLabel` call when creating/retrieving the actual label from the carrier.",
+            "nullable": true
+          },
+          "error_messages": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "List of discrete errors relating to this label payment. The presence of error messages indicates to the\r\nsystem that the payment was unsuccessful and label creation for this shipment should not proceed.",
+            "nullable": true
+          },
+          "warning_messages": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "A list of discrete warnings about this label payment. This is information the end user needs to be aware\r\nof but should not stop the request from succeeding, or a label being created as a result of this payment.",
+            "nullable": true
+          }
+        },
+        "additionalProperties": false
+      },
       "LatLong": {
         "type": "object",
         "properties": {
@@ -3119,7 +3707,7 @@
         "properties": {
           "registration_info": {
             "type": "object",
-            "additionalProperties": { },
+            "additionalProperties": {},
             "description": "This is a schemaless object used to contain any required fields for validating a users credentials or\r\nregistering a new account. These fields will be custom to the shipping service provider, and will be\r\ncollected via a form and sent over as key value pairs.",
             "nullable": true
           }
@@ -3135,7 +3723,7 @@
           },
           "metadata": {
             "type": "object",
-            "additionalProperties": { },
+            "additionalProperties": {},
             "description": "This is an optional schemaless object that should be returned for persisted auth and user information.\r\nAnything returned under this key will be included in all future requests. For example, you may store\r\nadditional static properties about the end user or their connection to the carrier. The maximum\r\nstorage size for data under this key is 4KB.",
             "nullable": true
           }
@@ -4041,4 +4629,4 @@
       "description": "Given inbound data, such as a webhook with tracking updates, return normalized information."
     }
   ]
-}
+}