From 7d3cad870d89c4f6379ddfa45b33cf0cc9f412b7 Mon Sep 17 00:00:00 2001 From: Kevin Andrews Date: Wed, 5 May 2021 12:46:49 +0100 Subject: [PATCH] Regenerate against 3.0.20 yaml definition file - shipment info added Incoterms DAT/DAP/DDU - new shipment customs information object for shipment creations - print label response "routing" object added to contain gazetter routing codes - shipper new field added for shipper reference 2 - fixed swagger generation of TokenApi call --- .swagger-codegen/VERSION | 2 +- .../rmg-pro-shipping-v3-rest-api-v3.0.20.yaml | 4841 +++++++++++++++++ docs/Api/AddressesApi.md | 10 +- docs/Api/ItemsApi.md | 10 +- docs/Api/ManifestsApi.md | 6 +- docs/Api/PackagingApi.md | 10 +- docs/Api/ShipmentsApi.md | 16 +- docs/Api/TokenApi.md | 2 +- .../Model/CreateShipmentCustomsInformation.md | 17 + docs/Model/CreateShipmentServiceOptions.md | 4 +- docs/Model/CreateShipmentShipment.md | 1 + .../CreateShipmentShipmentInformation.md | 3 +- docs/Model/PrintLabelResponse.md | 1 + docs/Model/Routing.md | 12 + docs/Model/ShipmentCreateResponse.md | 3 +- docs/Model/ShipmentDeferRequest.md | 2 +- docs/Model/Shipper.md | 1 + lib/AddressesApi.php | 49 +- lib/ApiException.php | 4 +- lib/Configuration.php | 6 +- lib/HeaderSelector.php | 4 +- lib/ItemsApi.php | 49 +- lib/ManifestsApi.php | 31 +- lib/ObjectSerializer.php | 4 +- lib/PackagingApi.php | 49 +- lib/ShipmentsApi.php | 76 +- lib/TokenApi.php | 13 +- lib/models/Address.php | 4 +- lib/models/AddressResponse.php | 4 +- .../CreateShipmentCustomsInformation.php | 532 ++ lib/models/CreateShipmentDestination.php | 6 +- lib/models/CreateShipmentServiceOptions.php | 8 +- lib/models/CreateShipmentShipment.php | 44 +- .../CreateShipmentShipmentInformation.php | 70 +- lib/models/CreateShipmentShipmentPackage.php | 4 +- lib/models/ErrorDetail.php | 4 +- lib/models/Item.php | 4 +- lib/models/ItemResponse.php | 4 +- lib/models/Manifest.php | 4 +- lib/models/ManifestCarrierCodesRequest.php | 4 +- lib/models/ManifestRequest.php | 4 +- lib/models/ManifestResponse.php | 4 +- lib/models/ManifestServiceCodesRequest.php | 4 +- lib/models/ModelInterface.php | 4 +- lib/models/PackageResponse.php | 4 +- lib/models/Packaging.php | 4 +- lib/models/PackagingResponse.php | 4 +- lib/models/PrintDocumentRequest.php | 4 +- lib/models/PrintDocumentResponse.php | 4 +- lib/models/PrintLabelRequest.php | 4 +- lib/models/PrintLabelResponse.php | 34 +- lib/models/Routing.php | 30 +- lib/models/ServiceAvailabilityDestination.php | 4 +- lib/models/ServiceAvailabilityFormat.php | 4 +- lib/models/ServiceAvailabilityOption.php | 4 +- lib/models/ServiceAvailabilityResponse.php | 4 +- .../ServiceAvailabilityServiceOptions.php | 4 +- lib/models/ServiceAvailabilityShipment.php | 4 +- ...ServiceAvailabilityShipmentInformation.php | 4 +- .../ServiceAvailabilityShipmentPackage.php | 4 +- lib/models/ShipmentCancelRequest.php | 4 +- lib/models/ShipmentCreateResponse.php | 10 +- lib/models/ShipmentDeferRequest.php | 8 +- lib/models/ShipmentHoldRequest.php | 4 +- lib/models/ShipmentItem.php | 4 +- lib/models/ShipmentsCancelResponse.php | 4 +- lib/models/ShipmentsDeferResponse.php | 4 +- lib/models/ShipmentsHoldResponse.php | 4 +- lib/models/ShipmentsReleaseRequest.php | 4 +- lib/models/ShipmentsReleaseResponse.php | 4 +- lib/models/Shipper.php | 34 +- test/Api/AddressesApiTest.php | 4 +- test/Api/ItemsApiTest.php | 4 +- test/Api/ManifestsApiTest.php | 4 +- test/Api/PackagingApiTest.php | 4 +- test/Api/ShipmentsApiTest.php | 4 +- test/Api/TokenApiTest.php | 4 +- test/Model/AddressResponseTest.php | 4 +- test/Model/AddressTest.php | 4 +- .../CreateShipmentCustomsInformationTest.php | 140 + test/Model/CreateShipmentDestinationTest.php | 6 +- .../CreateShipmentServiceOptionsTest.php | 4 +- .../CreateShipmentShipmentInformationTest.php | 11 +- .../CreateShipmentShipmentPackageTest.php | 4 +- test/Model/CreateShipmentShipmentTest.php | 11 +- test/Model/ErrorDetailTest.php | 4 +- test/Model/ItemResponseTest.php | 4 +- test/Model/ItemTest.php | 4 +- .../Model/ManifestCarrierCodesRequestTest.php | 4 +- test/Model/ManifestRequestTest.php | 4 +- test/Model/ManifestResponseTest.php | 4 +- .../Model/ManifestServiceCodesRequestTest.php | 4 +- test/Model/ManifestTest.php | 4 +- test/Model/PackageResponseTest.php | 4 +- test/Model/PackagingResponseTest.php | 4 +- test/Model/PackagingTest.php | 4 +- test/Model/PrintDocumentRequestTest.php | 4 +- test/Model/PrintDocumentResponseTest.php | 4 +- test/Model/PrintLabelRequestTest.php | 4 +- test/Model/PrintLabelResponseTest.php | 11 +- test/Model/RoutingTest.php | 105 + .../ServiceAvailabilityDestinationTest.php | 4 +- test/Model/ServiceAvailabilityFormatTest.php | 4 +- test/Model/ServiceAvailabilityOptionTest.php | 4 +- .../Model/ServiceAvailabilityResponseTest.php | 4 +- .../ServiceAvailabilityServiceOptionsTest.php | 4 +- ...iceAvailabilityShipmentInformationTest.php | 4 +- ...ServiceAvailabilityShipmentPackageTest.php | 4 +- .../Model/ServiceAvailabilityShipmentTest.php | 4 +- test/Model/ShipmentCancelRequestTest.php | 4 +- test/Model/ShipmentCreateResponseTest.php | 11 +- test/Model/ShipmentDeferRequestTest.php | 4 +- test/Model/ShipmentHoldRequestTest.php | 4 +- test/Model/ShipmentItemTest.php | 4 +- test/Model/ShipmentsCancelResponseTest.php | 4 +- test/Model/ShipmentsDeferResponseTest.php | 4 +- test/Model/ShipmentsHoldResponseTest.php | 4 +- test/Model/ShipmentsReleaseRequestTest.php | 4 +- test/Model/ShipmentsReleaseResponseTest.php | 4 +- test/Model/ShipperTest.php | 11 +- 120 files changed, 6240 insertions(+), 368 deletions(-) create mode 100644 config/rmg-pro-shipping-v3-rest-api-v3.0.20.yaml create mode 100644 docs/Model/CreateShipmentCustomsInformation.md create mode 100644 docs/Model/Routing.md create mode 100644 lib/models/CreateShipmentCustomsInformation.php create mode 100644 test/Model/CreateShipmentCustomsInformationTest.php create mode 100644 test/Model/RoutingTest.php diff --git a/.swagger-codegen/VERSION b/.swagger-codegen/VERSION index 3a8b971..87e5fea 100644 --- a/.swagger-codegen/VERSION +++ b/.swagger-codegen/VERSION @@ -1 +1 @@ -3.0.7 \ No newline at end of file +3.0.20 \ No newline at end of file diff --git a/config/rmg-pro-shipping-v3-rest-api-v3.0.20.yaml b/config/rmg-pro-shipping-v3-rest-api-v3.0.20.yaml new file mode 100644 index 0000000..de81d26 --- /dev/null +++ b/config/rmg-pro-shipping-v3-rest-api-v3.0.20.yaml @@ -0,0 +1,4841 @@ +--- +swagger: "2.0" +info: + version: 3.0.20 + title: Royal Mail API Shipping V3 (REST) + description: "API Shipping V3 (REST) provides the functionality for customers to + take a shipping transaction from creation to collection. \n\nIt specifically covers + how the Royal Mail API Shipping V3 can be used by business customers to conduct + shipping activity with Royal Mail and provides the technical information to build + this integration. This specification must be used with the relevant accompanying + specifications for customers wishing to interface their systems with Royal Mail + services.\n\nRoyal Mail API Shipping V3 exposes a fully RESTful service that allows + account customers to create shipments, produce labels, and produce documentation + for all the tasks required to ship domestic and international items with Royal + Mail.\n\nBuilt on industry standards, Royal Mail API Shipping V3 provides a simple + and low cost method for customers to integrate with Royal Mail, and allows them + to get shipping quickly. The API offers data streaming to allow customers greater + flexibility when generating their labels. There are no costs to customers for + using the Royal Mail API Shipping V3 services, however customers??? own development + costs must be covered by the customer developing the solution. Royal Mail will + not accept any responsibility for these development, implementation and testing + costs. Customers should address initial enquiries regarding development of systems + for these purposes to their account handler.\n\nThis API can be used in conjunction + with Royal Mail Pro Shipping, a GUI based shipping platform. For more details + on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling + a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help." + x-ibm-name: royal-mail-shipping-v3-rest +basePath: /shipping/v3 +schemes: +- https +paths: + /shipments: + post: + tags: + - Shipments + summary: Create Shipment + description: Use to generate the final delivery label for your packages.

The request is split into several sections:

**Shipper** - who and where the parcel is coming from - optional if the + posting location is to be used.
**Destination** - who and where the parcel + is going to.
**Shipment Information** - overall package details, individual + item details and requested service information. + operationId: Shipments_Create + parameters: + - name: shipment + in: body + description: The shipment. + required: true + schema: + $ref: '#/definitions/CreateShipment.Shipment' + responses: + 200: + description: The shipment(s) are created successfully + schema: + $ref: '#/definitions/ShipmentCreateResponse' + examples: + application/json: + Packages: + - PackageOccurance: 1 + UniqueId: 1A07033860010000AF62C + TrackingNumber: TT0213546985GB + TrackingUrl: https://www.royalmail.com/track-your-item#/tracking-results/TT0213546985GB + CarrierCode: RMG + LabelImageFormat: PDF + LabelImages: iVBORw0KGgoAAAANSUhEUgAAAGgA ... AABoAQMAAAAn0ifiAAAAAXNSR0IArs4c6 + HttpStatusCode: 200 + HttpStatusDescription: OK + Message: Shipment(s) processed. + application/xml: "\r\n\r\n + \ 200\r\n OK\r\n + \ Shipment(s) processed.\r\n \r\n \r\n + \ 1\r\n 1A07033860010000AF62C\r\n + \ TT0213546985GB\r\n https://www.royalmail.com/track-your-item#/tracking-results/TT0213546985GB\r\n + \ RMG\r\n \r\n \r\n + \ PDF\r\n iVBORw0KGgoAAAANSUhEUgAAAGgA + ... AABoAQMAAAAn0ifiAAAAAXNSR0IArs4c6\r\n \r\n" + 400: + description: Bad Request - one or more shipments are invalid. Details are + provided in the error messages. + schema: + $ref: '#/definitions/ShipmentCreateResponse' + examples: + application/json: + HttpStatusCode: 400 + HttpStatusDescription: BadRequest + Message: The shipment is invalid. + Errors: + - Message: The service code provided does not exist. + Cause: ShipmentInformation.ServiceCode + ErrorCode: E1433 + - Message: The destination contact name is required. + Cause: Destination.ContactName + ErrorCode: E1432 + application/xml: "\r\n\r\n + \ 400\r\n BadRequest\r\n + \ The shipment is invalid.\r\n \r\n \r\n + \ The service code provided does not exist.\r\n + \ ShipmentInformation.ServiceCode\r\n E1433\r\n + \ \r\n \r\n The destination + contact name is required.\r\n Destination.ContactName\r\n + \ E1432\r\n \r\n \r\n + \ \r\n \r\n" + 401: + description: Unauthorized + examples: + application/json: + httpCode: 401 + httpMessage: Unauthorized + moreInformation: Authentication failure. + application/xml: " \r\n\r\n401 + \r\nUnauthorized \r\nAuthentication + failure.\r\n " + 500: + description: Internal Server Error + 503: + description: Service Unavailable + consumes: + - application/xml + - application/json + produces: + - application/xml + - application/json + parameters: + - $ref: '#/parameters/X-RMG-Auth-Token' + /shipments/{shipmentId}/printDocument: + put: + tags: + - Shipments + summary: Print Document + description: Prints the requested document for the shipment.
If item information, + description of goods or reason for export have not been provided then the + document cannot be printed.

This service can only be + used before the shipment has been confirmed either by calling the manifest + create request or by closing out via the User Interface. + operationId: Shipments_PrintDocument + parameters: + - name: shipmentId + in: path + description: Shipment Id
The tracking number or Unique Id of the shipment + to print. + required: true + type: string + maxLength: 21 + minLength: 13 + - name: printDocumentRequest + in: body + description: Print Document Request + required: true + schema: + $ref: '#/definitions/PrintDocumentRequest' + responses: + 200: + description: The document has printed successfully + schema: + $ref: '#/definitions/PrintDocumentResponse' + examples: + application/json: + ShipmentId: 3A07033860010000B2268 + DocumentType: CN23 + DocumentImage: iVBORw0KGgoAAAANSUhEUgAA ... A4QAAAXcCAYAAAB6Q0CbAAAAAXNSR0IArs4 + HttpStatusCode: 200 + HttpStatusDescription: OK + Message: Document printed. + application/xml: "\r\n\r\n + \ 200\r\n OK\r\n + \ Document printed.\r\n 3A07033860010000B2268\r\n + \ CN23\r\n iVBORw0KGgoAAAANSUhEUgAA + ... A4QAAAXcCAYAAAB6Q0CbAAAAAXNSR0IArs4\r\n" + 400: + description: Bad Request - the shipment is in an invalid state and the document + cannot be printed. Details are provided in the error messages. + schema: + $ref: '#/definitions/PrintDocumentResponse' + examples: + application/json: + ShipmentId: 3A01234561234568AE7C7 + HttpStatusCode: 400 + HttpStatusDescription: BadRequest + Message: Invalid request. + Errors: + - Message: The shipment has already been manifested. + Cause: ShipmentExportState + ErrorCode: E1434 + application/xml: "\r\n\r\n + \ 400\r\n BadRequest\r\n + \ Invalid request.\r\n \r\n \r\n + \ The shipment has already been manifested.\r\n + \ ShipmentExportState\r\n E1434\r\n + \ \r\n \r\n 3A01234561234568AE7C7\r\n + \ \r\n" + 401: + description: Unauthorized + examples: + application/json: + httpCode: 401 + httpMessage: Unauthorized + moreInformation: Authentication failure. + application/xml: " \r\n\r\n401 + \r\nUnauthorized \r\nAuthentication + failure.\r\n " + 404: + description: The shipment was not found + schema: + $ref: '#/definitions/PrintDocumentResponse' + examples: + application/json: + ShipmentId: RE012345673GB + HttpStatusCode: 404 + HttpStatusDescription: NotFound + Message: The shipment was not found. + application/xml: "\r\n\r\n + \ 404\r\n NotFound\r\n + \ The shipment was not found.\r\n RE012345673GB\r\n + \ \r\n" + 500: + description: Internal Server Error + 503: + description: Service Unavailable + consumes: + - application/xml + - application/json + produces: + - application/xml + - application/json + parameters: + - $ref: '#/parameters/X-RMG-Auth-Token' + /shipments/{shipmentId}/printLabel: + put: + tags: + - Shipments + summary: Print Label + description: Prints the label for the shipment.
Moves the shipment to processed, + ready to manifest, if the shipment was not already in a processed state.
This service can only be used before the shipment has been confirmed either + by calling the manifest create request or by closing out via the User Interface.
**On Hold Shipment**
Calling print label on a held shipment will release + the shipment from hold and update the shipment date to today. + operationId: Shipments_PrintLabel + parameters: + - name: shipmentId + in: path + description: Shipment Id
The tracking number or Unique Id of the shipment + to print. + required: true + type: string + maxLength: 21 + minLength: 13 + - name: printLabelRequest + in: body + description: Print Label Request + required: true + schema: + $ref: '#/definitions/PrintLabelRequest' + responses: + 200: + description: The label was printed successfully + schema: + $ref: '#/definitions/PrintLabelResponse' + examples: + application/json: + ShipmentId: 3A07033860010000B2268 + LabelImage: iVBORw0KGgoAAAANSUhEUgAA ... A4QAAAXcCAYAAAB6Q0CbAAAAAXNSR0IArs4 + LabelImageFormat: PNG + TrackingNumber: GQ660548056GB + UniqueId: 3A07033860010000B2268 + TrackingUrl: https://www.royalmail.com/track-your-item#/tracking-results/GQ660548056GB + CarrierCode: RMG + ReturnLabelImageFormat: PDF + ReturnLabelImage: JVBERi0xLjQKJdP0zOEKMSAwIG9iag ... o8PAovQ3JlYXRpb25EYXRlKEQ6MjAxODExMDExMzQ + HttpStatusCode: 200 + HttpStatusDescription: OK + Message: Label printed and shipment moved to processed ready for manifesting. + application/xml: "\r\n\r\n + \ 200\r\n OK\r\n + \ Label printed and shipment moved to processed ready for manifesting.\r\n + \ 3A07033860010000B2268\r\n iVBORw0KGgoAAAANSUhEUgAA + ... A4QAAAXcCAYAAAB6Q0CbAAAAAXNSR0IArs4\r\n PNG\r\n + \ GQ660548056GB\r\n 3A07033860010000B2268\r\n + \ https://www.royalmail.com/track-your-item#/tracking-results/GQ660548056GB\r\n + \ RMG\r\n PDF\r\n + \ JVBERi0xLjQKJdP0zOEKMSAwIG9iag ... o8PAovQ3JlYXRpb25EYXRlKEQ6MjAxODExMDExMzQ\r\n" + 400: + description: Invalid Request. Details are provided in the error messages. + schema: + $ref: '#/definitions/PrintLabelResponse' + examples: + application/json: + ShipmentId: 3A01234561234568AE7C7 + HttpStatusCode: 400 + HttpStatusDescription: BadRequest + Message: Invalid request. + Errors: + - Message: The shipment has already been manifested and cannot be reprinted. + Cause: ShipmentExportState + ErrorCode: E1434 + application/xml: "\r\n\r\n + \ 400\r\n BadRequest\r\n + \ Invalid request.\r\n \r\n \r\n + \ The shipment has already been manifested and cannot be + reprinted.\r\n ShipmentExportState\r\n + \ E1434\r\n \r\n \r\n + \ 3A01234561234568AE7C7\r\n \r\n \r\n" + 401: + description: Unauthorized + examples: + application/json: + httpCode: 401 + httpMessage: Unauthorized + moreInformation: Authentication failure. + application/xml: " \r\n\r\n401 + \r\nUnauthorized \r\nAuthentication + failure.\r\n " + 404: + description: The shipment was not found + schema: + $ref: '#/definitions/PrintLabelResponse' + examples: + application/json: + ShipmentId: RE012345673GB + HttpStatusCode: 404 + HttpStatusDescription: NotFound + Message: The shipment was not found. + application/xml: "\r\n\r\n + \ 404\r\n NotFound\r\n + \ The shipment was not found.\r\n RE012345673GB\r\n + \ \r\n \r\n" + 500: + description: Internal Server Error + 503: + description: Service Unavailable + consumes: + - application/xml + - application/json + produces: + - application/xml + - application/json + parameters: + - $ref: '#/parameters/X-RMG-Auth-Token' + /shipments/cancel: + put: + tags: + - Shipments + summary: Cancel Shipments + description: Can be used to cancel/void one or more current shipping labels.
This service can only be used before the shipment has been confirmed either + by calling the manifest create request or by closing out via the User Interface.
There can be a maximum of 99 cancellation requests per call. + operationId: Shipments_Cancel + parameters: + - name: shipmentCancelRequests + in: body + description: Shipment Cancel Requests + required: true + schema: + type: array + items: + $ref: '#/definitions/ShipmentCancelRequest' + xml: + name: ArrayOfShipmentCancelRequest + wrapped: true + responses: + 200: + description: All shipments were cancelled successfully + schema: + $ref: '#/definitions/ShipmentsCancelResponse' + examples: + application/json: + ShipmentIds: + - RE012345673GB + - 3A01234561234568AE7C7 + HttpStatusCode: 200 + HttpStatusDescription: OK + Message: Shipments cancelled. + application/xml: "\r\n\r\n + \ 200\r\n OK\r\n + \ Shipments cancelled.\r\n \r\n RE012345673GB\r\n + \ 3A01234561234568AE7C7\r\n \r\n" + 400: + description: Bad Request - one or more shipments are in an invalid state + to cancel. Details are provided in the error messages. No shipments will + be cancelled. + schema: + $ref: '#/definitions/ShipmentsCancelResponse' + examples: + application/json: + ShipmentIds: + - RE012345673GB + - 3A01234561234568AE7C7 + - RE012345458GB + HttpStatusCode: 400 + HttpStatusDescription: BadRequest + Message: One or more requests are invalid. No shipments have been cancelled. + Errors: + - Message: The reason for cancellation is required. + Cause: RE012345673GB + ErrorCode: E1432 + - Message: The shipment has already been manifested and cannot be cancelled. + Cause: 3A01234561234568AE7C7 + ErrorCode: E1434 + application/xml: "\r\n\r\n + \ 400\r\n BadRequest\r\n + \ One or more requests are invalid. No shipments have been + cancelled.\r\n \r\n \r\n The + reason for cancellation is required.\r\n RE012345673GB\r\n + \ E1432\r\n \r\n \r\n + \ The shipment has already been manifested and cannot be + cancelled.\r\n 3A01234561234568AE7C7\r\n + \ E1434\r\n \r\n \r\n + \ \r\n RE012345673GB\r\n 3A01234561234568AE7C7\r\n + \ RE012345458GB\r\n \r\n" + 401: + description: Unauthorized + examples: + application/json: + httpCode: 401 + httpMessage: Unauthorized + moreInformation: Authentication failure. + application/xml: " \r\n\r\n401 + \r\nUnauthorized \r\nAuthentication + failure.\r\n " + 404: + description: One or more shipments were not found. No shipments will be + cancelled. + schema: + $ref: '#/definitions/ShipmentsCancelResponse' + examples: + application/json: + ShipmentIds: + - RE012345673GB + - 3A01234561234568AE7C7 + - RE012345458GB + HttpStatusCode: 404 + HttpStatusDescription: NotFound + Message: One or more shipments were not found. No shipments have been + cancelled. + Errors: + - Message: The shipment was not found. + Cause: RE012345673GB + ErrorCode: E1435 + - Message: The shipment was not found. + Cause: 3A01234561234568AE7C7 + ErrorCode: E1435 + application/xml: "\r\n\r\n + \ 404\r\n NotFound\r\n + \ One or more shipments were not found. No shipments have been + cancelled.\r\n \r\n \r\n The + shipment was not found.\r\n RE012345673GB\r\n + \ E1435\r\n \r\n \r\n + \ The shipment was not found.\r\n 3A01234561234568AE7C7\r\n + \ E1435\r\n \r\n \r\n + \ \r\n RE012345673GB\r\n 3A01234561234568AE7C7\r\n + \ RE012345458GB\r\n \r\n" + 500: + description: Internal Server Error + 503: + description: Service Unavailable + consumes: + - application/xml + - application/json + produces: + - application/xml + - application/json + parameters: + - $ref: '#/parameters/X-RMG-Auth-Token' + /shipments/defer: + put: + tags: + - Shipments + summary: Defer Shipments + description: Used to update the shipment shipping date for a current shipment.
A shipment can be deferred by a maximum of 28 days from the date of the + request.
This service can only be used before the shipment has been confirmed + either by calling the manifest create request or by closing out via the User + Interface.
There can be a maximum of 99 defer requests per call. + operationId: Shipments_Defer + parameters: + - name: shipmentDeferRequests + in: body + description: The shipments to defer. + required: true + schema: + type: array + items: + $ref: '#/definitions/ShipmentDeferRequest' + xml: + name: ArrayOfShipmentDeferRequest + wrapped: true + responses: + 200: + description: All shipments were deferred successfully + schema: + $ref: '#/definitions/ShipmentsDeferResponse' + examples: + application/json: + ShipmentIds: + - RE012345673GB + - 3A01234561234568AE7C7 + HttpStatusCode: 200 + HttpStatusDescription: OK + Message: Shipments deferred. + application/xml: "\r\n\r\n + \ 200\r\n OK\r\n + \ Shipments deferred.\r\n \r\n RE012345673GB\r\n + \ 3A01234561234568AE7C7\r\n \r\n" + 400: + description: Bad Request - one or more shipments are in an invalid state + to defer or the date is invalid. Details are provided in the error messages. + No shipments will be deferred. + schema: + $ref: '#/definitions/ShipmentsDeferResponse' + examples: + application/json: + ShipmentIds: + - RE012345673GB + - 3A01234561234568AE7C7 + - RE012345458GB + HttpStatusCode: 400 + HttpStatusDescription: BadRequest + Message: One or more requests are invalid. No shipments have been deferred. + Errors: + - Message: The shipment date cannot be in the past. + Cause: RE012345673GB + ErrorCode: E1433 + - Message: The shipment has already been manifested and cannot be deferred. + Cause: 3A01234561234568AE7C7 + ErrorCode: E1434 + application/xml: "\r\n\r\n + \ 400\r\n BadRequest\r\n + \ One or more requests are invalid. No shipments have been + deferred.\r\n \r\n \r\n The + shipment date cannot be in the past.\r\n RE012345673GB\r\n + \ E1433\r\n \r\n \r\n + \ The shipment has already been manifested and cannot be + deferred.\r\n 3A01234561234568AE7C7\r\n + \ E1434\r\n \r\n \r\n + \ \r\n RE012345673GB\r\n 3A01234561234568AE7C7\r\n + \ RE012345458GB\r\n \r\n" + 401: + description: Unauthorized + examples: + application/json: + httpCode: 401 + httpMessage: Unauthorized + moreInformation: Authentication failure. + application/xml: " \r\n\r\n401 + \r\nUnauthorized \r\nAuthentication + failure.\r\n " + 404: + description: One or more shipments were not found. No shipments will be + deferred. + schema: + $ref: '#/definitions/ShipmentsDeferResponse' + examples: + application/json: + ShipmentIds: + - RE012345673GB + - 3A01234561234568AE7C7 + - RE012345458GB + HttpStatusCode: 404 + HttpStatusDescription: NotFound + Message: One or more shipments were not found. No shipments have been + deferred. + Errors: + - Message: The shipment was not found. + Cause: RE012345673GB + ErrorCode: E1435 + - Message: The shipment was not found. + Cause: 3A01234561234568AE7C7 + ErrorCode: E1435 + application/xml: "\r\n\r\n + \ 404\r\n NotFound\r\n + \ One or more shipments were not found. No shipments have been + deferred.\r\n \r\n \r\n The + shipment was not found.\r\n RE012345673GB\r\n + \ E1435\r\n \r\n \r\n + \ The shipment was not found.\r\n 3A01234561234568AE7C7\r\n + \ E1435\r\n \r\n \r\n + \ \r\n RE012345673GB\r\n 3A01234561234568AE7C7\r\n + \ RE012345458GB\r\n \r\n" + 500: + description: Internal Server Error + 503: + description: Service Unavailable + consumes: + - application/xml + - application/json + produces: + - application/xml + - application/json + parameters: + - $ref: '#/parameters/X-RMG-Auth-Token' + /shipments/hold: + put: + tags: + - Shipments + summary: Hold Shipments + description: Used to put a shipment on hold indefinitely.
A shipment on + hold will not be included in any closeouts, but instead will remain in its + current state.
Calling printLabel will release the shipment from being + held.
This service can only be used before the shipment has been confirmed + either by calling the manifest create request or by closing out via the User + Interface.

A hold reason must be provided and must + match those set in Pro Shipping under your maintenance screens.
If no + hold reasons exist, then shipments cannot be put on hold.

There can be a maximum of 99 hold requests per call. + operationId: Shipments_Hold + parameters: + - name: shipmentHoldRequests + in: body + description: The shipments to hold. + required: true + schema: + type: array + items: + $ref: '#/definitions/ShipmentHoldRequest' + xml: + name: ArrayOfShipmentHoldRequest + wrapped: true + responses: + 200: + description: All shipments were put on hold successfully + schema: + $ref: '#/definitions/ShipmentsHoldResponse' + examples: + application/json: + ShipmentIds: + - RE012345673GB + - 3A01234561234568AE7C7 + HttpStatusCode: 200 + HttpStatusDescription: OK + Message: Shipments held. + application/xml: "\r\n\r\n + \ 200\r\n OK\r\n + \ Shipments held.\r\n \r\n RE012345673GB\r\n + \ 3A01234561234568AE7C7\r\n \r\n" + 400: + description: Bad Request - one or more shipments are in an invalid state + to hold or the hold reason is invalid. Details are provided in the error + messages. No shipments will be put on hold. + schema: + $ref: '#/definitions/ShipmentsHoldResponse' + examples: + application/json: + ShipmentIds: + - RE012345673GB + - 3A01234561234568AE7C7 + - RE012345458GB + HttpStatusCode: 400 + HttpStatusDescription: BadRequest + Message: One or more requests are invalid. No shipments have been put + on hold. + Errors: + - Message: The reason for hold is required. + Cause: RE012345673GB + ErrorCode: E1432 + - Message: The shipment has already been manifested and cannot be held. + Cause: 3A01234561234568AE7C7 + ErrorCode: E1434 + application/xml: "\r\n\r\n + \ 400\r\n BadRequest\r\n + \ One or more requests are invalid. No shipments have been + put on hold.\r\n \r\n \r\n The + reason for hold is required.\r\n RE012345673GB\r\n + \ E1432\r\n \r\n \r\n + \ The shipment has already been manifested and cannot be + held.\r\n 3A01234561234568AE7C7\r\n E1434\r\n + \ \r\n \r\n \r\n RE012345673GB\r\n + \ 3A01234561234568AE7C7\r\n RE012345458GB\r\n + \ \r\n" + 401: + description: Unauthorized + examples: + application/json: + httpCode: 401 + httpMessage: Unauthorized + moreInformation: Authentication failure. + application/xml: " \r\n\r\n401 + \r\nUnauthorized \r\nAuthentication + failure.\r\n " + 404: + description: One or more shipments were not found. No shipments will be + put on hold. + schema: + $ref: '#/definitions/ShipmentsHoldResponse' + examples: + application/json: + ShipmentIds: + - RE012345673GB + - 3A01234561234568AE7C7 + - RE012345458GB + HttpStatusCode: 404 + HttpStatusDescription: NotFound + Message: One or more shipments were not found. No shipments have been + put on hold. + Errors: + - Message: The shipment was not found. + Cause: RE012345673GB + ErrorCode: E1435 + - Message: The shipment was not found. + Cause: 3A01234561234568AE7C7 + ErrorCode: E1435 + application/xml: "\r\n\r\n + \ 404\r\n NotFound\r\n + \ One or more shipments were not found. No shipments have been + put on hold.\r\n \r\n \r\n The + shipment was not found.\r\n RE012345673GB\r\n + \ E1435\r\n \r\n \r\n + \ The shipment was not found.\r\n 3A01234561234568AE7C7\r\n + \ E1435\r\n \r\n \r\n + \ \r\n RE012345673GB\r\n 3A01234561234568AE7C7\r\n + \ RE012345458GB\r\n \r\n" + 500: + description: Internal Server Error + 503: + description: Service Unavailable + consumes: + - application/xml + - application/json + produces: + - application/xml + - application/json + parameters: + - $ref: '#/parameters/X-RMG-Auth-Token' + /shipments/release: + put: + tags: + - Shipments + summary: Release Shipments + description: Used to release a shipment from being on hold.
This service + can only be used for shipments on hold.

Releasing a + shipment from hold will update the shipment date to today's date and if the + shipment is processed it will be included the next requested manifest.

There can be a maximum of 99 release requests per call. + operationId: Shipments_Release + parameters: + - name: shipmentsReleaseRequest + in: body + description: Shipments Release Request + required: true + schema: + $ref: '#/definitions/ShipmentsReleaseRequest' + responses: + 200: + description: All shipments were released successfully + schema: + $ref: '#/definitions/ShipmentsReleaseResponse' + examples: + application/json: + ShipmentIds: + - RE012345673GB + - 3A01234561234568AE7C7 + HttpStatusCode: 200 + HttpStatusDescription: OK + Message: Shipments released. + application/xml: "\r\n\r\n + \ 200\r\n OK\r\n + \ Shipments released.\r\n \r\n RE012345673GB\r\n + \ 3A01234561234568AE7C7\r\n \r\n" + 400: + description: Bad Request - one or more shipments are in an invalid state. + Details are provided in the error messages. No shipments will be released. + schema: + $ref: '#/definitions/ShipmentsReleaseResponse' + examples: + application/json: + ShipmentIds: + - RE012345673GB + - 3A01234561234568AE7C7 + - RE012345458GB + HttpStatusCode: 400 + HttpStatusDescription: BadRequest + Message: One or more requests are invalid. No shipments have been released. + Errors: + - Message: The shipment is not on hold. + Cause: RE012345673GB + ErrorCode: E1434 + - Message: The shipment is cancelled. + Cause: 3A01234561234568AE7C7 + ErrorCode: E1434 + application/xml: "\r\n\r\n + \ 400\r\n BadRequest\r\n + \ One or more requests are invalid. No shipments have been + released.\r\n \r\n \r\n The + shipment is not on hold.\r\n RE012345673GB\r\n + \ E1434\r\n \r\n \r\n + \ The shipment is cancelled.\r\n 3A01234561234568AE7C7\r\n + \ E1434\r\n \r\n \r\n + \ \r\n RE012345673GB\r\n 3A01234561234568AE7C7\r\n + \ RE012345458GB\r\n \r\n" + 401: + description: Unauthorized + examples: + application/json: + httpCode: 401 + httpMessage: Unauthorized + moreInformation: Authentication failure. + application/xml: " \r\n\r\n401 + \r\nUnauthorized \r\nAuthentication + failure.\r\n " + 404: + description: One or more shipments were not found. No shipments will be + released. + schema: + $ref: '#/definitions/ShipmentsReleaseResponse' + examples: + application/json: + ShipmentIds: + - RE012345673GB + - 3A01234561234568AE7C7 + - RE012345458GB + HttpStatusCode: 404 + HttpStatusDescription: NotFound + Message: One or more shipments were not found. No shipments have been + released. + Errors: + - Message: The shipment was not found. + Cause: RE012345673GB + ErrorCode: E1435 + - Message: The shipment was not found. + Cause: 3A01234561234568AE7C7 + ErrorCode: E1435 + application/xml: "\r\n\r\n + \ 404\r\n NotFound\r\n + \ One or more shipments were not found. No shipments have been + released.\r\n \r\n \r\n The + shipment was not found.\r\n RE012345673GB\r\n + \ E1435\r\n \r\n \r\n + \ The shipment was not found.\r\n 3A01234561234568AE7C7\r\n + \ E1435\r\n \r\n \r\n + \ \r\n RE012345673GB\r\n 3A01234561234568AE7C7\r\n + \ RE012345458GB\r\n \r\n" + 500: + description: Internal Server Error + 503: + description: Service Unavailable + consumes: + - application/xml + - application/json + produces: + - application/xml + - application/json + parameters: + - $ref: '#/parameters/X-RMG-Auth-Token' + /shipments/serviceAvailability: + post: + tags: + - Shipments + summary: Service Availability + description: Retrieve a list of available services for a potential shipment.

**Destination** - where the parcel is going to.
**Shipment + Information** - overall package details and requested service requirements. + operationId: Shipments_ServiceAvailability + parameters: + - name: shipment + in: body + description: The shipment. + required: true + schema: + $ref: '#/definitions/ServiceAvailability.Shipment' + responses: + 200: + description: The available service options are returned. + schema: + $ref: '#/definitions/ServiceAvailabilityResponse' + examples: + application/json: + WeightUnitOfMeasure: KG + Options: + - ServiceCode: TPSN + ServiceName: Royal Mail Tracked 48 No Signature + TransitDays: 2 + IsTracked: true + SignatureIncluded: false + RecordedSignedForAvailable: false + SafeplaceAvailable: true + LocalCollectAvailable: true + SaturdayGuaranteedAvailable: false + ConsequentialLossAvailable: false + FormatsAvailable: + - FormatDescription: Not Applicable + MaxWeight: 20 + - ServiceCode: TPSS + ServiceName: Royal Mail Tracked 48 Signature + TransitDays: 2 + IsTracked: true + SignatureIncluded: true + RecordedSignedForAvailable: false + SafeplaceAvailable: true + LocalCollectAvailable: true + SaturdayGuaranteedAvailable: false + ConsequentialLossAvailable: false + FormatsAvailable: + - FormatDescription: Not Applicable + MaxWeight: 20 + - ServiceCode: STL1 + ServiceName: 1st Class Account Mail + TransitDays: 1 + IsTracked: false + SignatureIncluded: false + RecordedSignedForAvailable: true + SafeplaceAvailable: false + LocalCollectAvailable: false + SaturdayGuaranteedAvailable: false + ConsequentialLossAvailable: false + FormatsAvailable: + - ServiceFormat: L + MaxWeight: 0.001000 + - ServiceFormat: F + MaxWeight: 0.750000 + - ServiceFormat: P + MaxWeight: 20 + - ServiceCode: SD1 + ServiceName: Special Delivery Guaranteed by 1pm (??750) + TransitDays: 1 + IsTracked: true + SignatureIncluded: true + RecordedSignedForAvailable: false + SafeplaceAvailable: false + LocalCollectAvailable: true + SaturdayGuaranteedAvailable: true + ConsequentialLossAvailable: true + FormatsAvailable: + - FormatDescription: Not Applicable + MaxWeight: 10 + HttpStatusCode: 200 + HttpStatusDescription: OK + Message: Available service options returned. + application/xml: "\r\n\r\n + \ 200\r\n OK\r\n + \ Available service options returned.\r\n KG\r\n + \ \r\n \r\n \r\n \r\n \r\n \r\n" + 400: + description: The request was invalid. Details are provided in the error + messages. + schema: + $ref: '#/definitions/ServiceAvailabilityResponse' + examples: + application/json: + HttpStatusCode: 400 + HttpStatusDescription: BadRequest + Message: The shipment is invalid. + Errors: + - Message: Service code ABC does not exist. + Cause: ShipmentInformation.ServiceCode + ErrorCode: E1433 + - Message: The destination town is required. + Cause: Destination.Town + ErrorCode: E1432 + - Message: The destination country code AA is invalid. + Cause: Destination.CountryCode + ErrorCode: E1432 + application/xml: "\r\n\r\n + \ 400\r\n BadRequest\r\n + \ The shipment is invalid.\r\n \r\n \r\n + \ Service code ABC does not exist.\r\n ShipmentInformation.ServiceCode\r\n + \ E1433\r\n \r\n \r\n + \ The destination town is required.\r\n Destination.Town\r\n + \ E1432\r\n \r\n \r\n + \ The destination country code AA is invalid.\r\n + \ Destination.CountryCode\r\n E1432\r\n + \ \r\n \r\n" + 401: + description: Unauthorized + examples: + application/json: + httpCode: 401 + httpMessage: Unauthorized + moreInformation: Authentication failure. + application/xml: " \r\n\r\n401 + \r\nUnauthorized \r\nAuthentication + failure.\r\n " + 500: + description: Internal Server Error + 503: + description: Service Unavailable + consumes: + - application/xml + - application/json + produces: + - application/xml + - application/json + parameters: + - $ref: '#/parameters/X-RMG-Auth-Token' + /manifests: + post: + tags: + - Manifests + summary: Manifest All Shipments + description: 'Manifest all shipments that are ready to manifest for a single + Posting Location.

Required to confirm parcels are + ready to despatch.
Generates the required paperwork to despatch your + parcels.
One or more manifests, including the base 64 encoded PDF and + manifest number will be returned.

*Note: All average + weight shipments are ignored and need to be closed out via Shipment Processing*' + operationId: Manifests_Create + parameters: + - name: request + in: body + description: Request + required: true + schema: + $ref: '#/definitions/ManifestRequest' + responses: + 200: + description: The manifest(s) have created successfully + schema: + $ref: '#/definitions/ManifestResponse' + examples: + application/json: + PostingLocation: "123456789" + Manifests: + - ManifestNumber: INT1810000003 + ManifestImage: JVBERi0xLjQKJdP0zOEKMSAwIG ... yDy51RYblaQeRyJybTcNlVe37Y + CarrierCode: RMG + ServiceCode: TPLN + TotalWeight: 5.342000 + TotalPackages: 14 + - ManifestNumber: INT1810000004 + ManifestImage: JVBERi0xLjQKJdP0zOEKMSAwIG ... yDy51RYblaQeRyJybTcNlVe37Y + CarrierCode: RMG + ServiceCode: Mixed + TotalWeight: 8.342000 + TotalPackages: 32 + HttpStatusCode: 200 + HttpStatusDescription: OK + Message: Shipments manifested successfully + application/xml: "\r\n\r\n + \ 200\r\n OK\r\n + \ Shipments manifested successfully\r\n 0123456789\r\n + \ \r\n \r\n INT1810000003\r\n + \ JVBERi0xLjQKJdP0zOEKMSAwIG ... yDy51RYblaQeRyJybTcNlVe37Y\r\n + \ RMG\r\n TPLN\r\n + \ 5.342\r\n 14\r\n + \ \r\n \r\n INT1810000004\r\n + \ JVBERi0xLjQKJdP0zOEKMSAwIG ... yDy51RYblaQeRyJybTcNlVe37Y\r\n + \ RMG\r\n Mixed\r\n + \ 8.342\r\n 32\r\n + \ \r\n \r\n" + 400: + description: Bad Request - the posting location is required or invalid, + or there are no shipments to manifest. Details are provided in the error + messages. + schema: + $ref: '#/definitions/ManifestResponse' + examples: + application/json: + PostingLocation: "123456789" + HttpStatusCode: 400 + HttpStatusDescription: BadRequest + Message: The request is invalid. + Errors: + - Message: There are no shipments ready to manifest + Cause: PostingLocation + ErrorCode: E1434 + application/xml: "\r\n\r\n + \ 400\r\n BadRequest\r\n + \ The request is invalid.\r\n \r\n \r\n + \ There are no shipments ready to manifest\r\n + \ PostingLocation\r\n E1434\r\n + \ \r\n \r\n 0123456789\r\n" + 401: + description: Unauthorized + examples: + application/json: + httpCode: 401 + httpMessage: Unauthorized + moreInformation: Authentication failure. + application/xml: " \r\n\r\n401 + \r\nUnauthorized \r\nAuthentication + failure.\r\n " + 500: + description: Internal Server Error + 503: + description: Service Unavailable + consumes: + - application/xml + - application/json + produces: + - application/xml + - application/json + parameters: + - $ref: '#/parameters/X-RMG-Auth-Token' + /manifests/bycarrier: + post: + tags: + - Manifests + summary: Manifest by Carrier Code(s) + description: 'Manifest shipments created with the given carrier codes that are + ready to manifest for a single Posting Location.

Required + to confirm parcels are ready to despatch.
Generates the required paperwork + to despatch your parcels.
One or more manifests, including the base + 64 encoded PDF and manifest number will be returned.

*Note: All average weight shipments are ignored and need to be closed out + via Shipment Processing*' + operationId: Manifests_CreateByCarrier + parameters: + - name: request + in: body + description: "" + required: true + schema: + $ref: '#/definitions/ManifestCarrierCodesRequest' + responses: + 200: + description: The manifest(s) have created successfully + schema: + $ref: '#/definitions/ManifestResponse' + examples: + application/json: + PostingLocation: "123456789" + Manifests: + - ManifestNumber: INT1810000003 + ManifestImage: JVBERi0xLjQKJdP0zOEKMSAwIG ... yDy51RYblaQeRyJybTcNlVe37Y + CarrierCode: RMG + ServiceCode: TPLN + TotalWeight: "5.342" + TotalPackages: "14" + - ManifestNumber: INT1810000004 + ManifestImage: JVBERi0xLjQKJdP0zOEKMSAwIG ... yDy51RYblaQeRyJybTcNlVe37Y + CarrierCode: RMG + ServiceCode: Mixed + TotalWeight: "8.342" + TotalPackages: "32" + HttpStatusCode: "200" + HttpStatusDescription: OK + Message: Shipments manifested successfully + application/xml: "\r\n\r\n + \ 200\r\n OK\r\n + \ Shipments manifested successfully\r\n 0123456789\r\n + \ \r\n \r\n INT1810000003\r\n + \ JVBERi0xLjQKJdP0zOEKMSAwIG ... yDy51RYblaQeRyJybTcNlVe37Y\r\n + \ RMG\r\n TPLN\r\n + \ 5.342\r\n 14\r\n + \ \r\n \r\n INT1810000004\r\n + \ JVBERi0xLjQKJdP0zOEKMSAwIG ... yDy51RYblaQeRyJybTcNlVe37Y\r\n + \ RMG\r\n Mixed\r\n + \ 8.342\r\n 32\r\n + \ \r\n \r\n" + 400: + description: Bad Request - the posting location is required or invalid, + there are no shipments to manifest or the carrier codes are invalid. Details + are provided in the error messages. + schema: + $ref: '#/definitions/ManifestResponse' + examples: + application/json: + PostingLocation: "123456789" + HttpStatusCode: 400 + HttpStatusDescription: BadRequest + Message: The request is invalid. + Errors: + - Message: There are no shipments ready to manifest + Cause: PostingLocation + ErrorCode: E1434 + application/xml: "\r\n\r\n + \ 400\r\n BadRequest\r\n + \ The request is invalid.\r\n \r\n \r\n + \ There are no shipments ready to manifest\r\n + \ PostingLocation\r\n E1434\r\n + \ \r\n \r\n 0123456789\r\n" + 401: + description: Unauthorized + examples: + application/json: + httpCode: 401 + httpMessage: Unauthorized + moreInformation: Authentication failure. + application/xml: " \r\n\r\n401 + \r\nUnauthorized \r\nAuthentication + failure.\r\n " + 500: + description: Internal Server Error + 503: + description: Service Unavailable + consumes: + - application/xml + - application/json + produces: + - application/xml + - application/json + parameters: + - $ref: '#/parameters/X-RMG-Auth-Token' + /manifests/byservice: + post: + tags: + - Manifests + summary: Manifest by Service Code(s) + description: 'Manifest shipments created with the given service codes that are + ready to manifest for a single Posting Location.

Required + to confirm parcels are ready to despatch.
Generates the required paperwork + to despatch your parcels.
One or more manifests, including the base + 64 encoded PDF and manifest number will be returned.

*Note: All average weight shipments are ignored and need to be closed out + via Shipment Processing*' + operationId: Manifests_CreateByService + parameters: + - name: request + in: body + description: "" + required: true + schema: + $ref: '#/definitions/ManifestServiceCodesRequest' + responses: + 200: + description: The manifest(s) have created successfully + schema: + $ref: '#/definitions/ManifestResponse' + examples: + application/json: + PostingLocation: "123456789" + Manifests: + - ManifestNumber: INT1810000003 + ManifestImage: JVBERi0xLjQKJdP0zOEKMSAwIG ... yDy51RYblaQeRyJybTcNlVe37Y + CarrierCode: RMG + ServiceCode: TPLN + TotalWeight: 5.342000 + TotalPackages: 14 + - ManifestNumber: INT1810000004 + ManifestImage: JVBERi0xLjQKJdP0zOEKMSAwIG ... yDy51RYblaQeRyJybTcNlVe37Y + CarrierCode: RMG + ServiceCode: Mixed + TotalWeight: 8.342000 + TotalPackages: 32 + HttpStatusCode: 200 + HttpStatusDescription: OK + Message: Shipments manifested successfully + application/xml: "\r\n\r\n + \ 200\r\n OK\r\n + \ Shipments manifested successfully\r\n 0123456789\r\n + \ \r\n \r\n INT1810000003\r\n + \ JVBERi0xLjQKJdP0zOEKMSAwIG ... yDy51RYblaQeRyJybTcNlVe37Y\r\n + \ RMG\r\n TPLN\r\n + \ 5.342\r\n 14\r\n + \ \r\n \r\n INT1810000004\r\n + \ JVBERi0xLjQKJdP0zOEKMSAwIG ... yDy51RYblaQeRyJybTcNlVe37Y\r\n + \ RMG\r\n Mixed\r\n + \ 8.342\r\n 32\r\n + \ \r\n \r\n" + 400: + description: Bad Request - the posting location is required or invalid, + there are no shipments to manifest or the service codes are invalid. Details + are provided in the error messages. + schema: + $ref: '#/definitions/ManifestResponse' + examples: + application/json: + PostingLocation: "123456789" + HttpStatusCode: 400 + HttpStatusDescription: BadRequest + Message: The request is invalid. + Errors: + - Message: There are no shipments ready to manifest + Cause: PostingLocation + ErrorCode: E1434 + application/xml: "\r\n\r\n + \ 400\r\n BadRequest\r\n + \ The request is invalid.\r\n \r\n \r\n + \ There are no shipments ready to manifest\r\n + \ PostingLocation\r\n E1434\r\n + \ \r\n \r\n 0123456789\r\n" + 401: + description: Unauthorized + examples: + application/json: + httpCode: 401 + httpMessage: Unauthorized + moreInformation: Authentication failure. + application/xml: " \r\n\r\n401 + \r\nUnauthorized \r\nAuthentication + failure.\r\n " + 500: + description: Internal Server Error + 503: + description: Service Unavailable + consumes: + - application/xml + - application/json + produces: + - application/xml + - application/json + parameters: + - $ref: '#/parameters/X-RMG-Auth-Token' + /addresses: + get: + tags: + - Addresses + summary: Get Addresses + description: Get all of your stored addresses + operationId: Addresses_GetAll + responses: + 200: + description: All existing addresses are returned + schema: + type: array + items: + $ref: '#/definitions/Address' + examples: + application/json: + - AddressId: GBAD453RD1030 + IsReturnAddress: false + ContactName: John Smith + AddressLine1: Brown Cottage + AddressLine2: 15-30 Maple Tree Avenue + Town: Redhill Moores + CountryCode: GB + Postcode: AD45 3RD + EmailAddress: john@exampleemail.com + - AddressId: 5377feaf-87fe-4c6c-b16e-98e4ef4e8745 + IsReturnAddress: true + ContactName: Returns Hub + AddressLine1: 18 Container Road + Town: Stanhill Stores + CountryCode: GB + Postcode: KT18 9PB + application/xml: "\r\n\r\n + \
\r\n GBAD453RD1030\r\n false\r\n + \ John Smith\r\n Brown + Cottage\r\n 15-30 Maple Tree Avenue\r\n + \ Redhill Moores\r\n GB\r\n + \ AD45 3RD\r\n john@exampleemail.com\r\n + \
\r\n
\r\n 5377feaf-87fe-4c6c-b16e-98e4ef4e8745\r\n + \ true\r\n Returns + Hub\r\n 18 Container Road\r\n + \ Stanhill Stores\r\n GB\r\n + \ KT18 9PB\r\n
\r\n" + 401: + description: Unauthorized + examples: + application/json: + httpCode: 401 + httpMessage: Unauthorized + moreInformation: Authentication failure. + application/xml: " \r\n\r\n401 + \r\nUnauthorized \r\nAuthentication + failure.\r\n " + 500: + description: Internal Server Error + 503: + description: Service Unavailable + consumes: [] + produces: + - application/xml + - application/json + post: + tags: + - Addresses + summary: Create Address + description: Add a new address to your address book that you can then use in + your shipment requests. + operationId: Addresses_Create + parameters: + - name: address + in: body + description: The address. + required: true + schema: + $ref: '#/definitions/Address' + responses: + 200: + description: The address was created successfully + schema: + $ref: '#/definitions/AddressResponse' + examples: + application/json: + AddressId: GBAD453RD1030 + HttpStatusCode: 200 + HttpStatusDescription: OK + Message: Address created + application/xml: "\r\n\r\n + \ 200\r\n OK\r\n + \ Address created\r\n GBAD453RD1030\r\n" + 400: + description: Bad Request - the address is invalid. Details are provided + in the error messages. + schema: + $ref: '#/definitions/AddressResponse' + examples: + application/json: + AddressId: GBAD453RD1030 + HttpStatusCode: 400 + HttpStatusDescription: BadRequest + Message: The address is invalid. + Errors: + - Message: The town for an address is required. + Cause: Town + ErrorCode: E1432 + - Message: The second line of the address must be 35 characters or less. + Cause: AddressLine2 + ErrorCode: E1433 + application/xml: "\r\n\r\n + \ 400\r\n BadRequest\r\n + \ The address is invalid.\r\n \r\n \r\n + \ The town for an address is required.\r\n Town\r\n + \ E1432\r\n \r\n \r\n + \ The second line of the address must be 35 characters + or less.\r\n AddressLine2\r\n E1433\r\n + \ \r\n \r\n GBAD453RD1030\r\n" + 401: + description: Unauthorized + examples: + application/json: + httpCode: 401 + httpMessage: Unauthorized + moreInformation: Authentication failure. + application/xml: " \r\n\r\n401 + \r\nUnauthorized \r\nAuthentication + failure.\r\n " + 500: + description: Internal Server Error + 503: + description: Service Unavailable + consumes: + - application/xml + - application/json + produces: + - application/xml + - application/json + parameters: + - $ref: '#/parameters/X-RMG-Auth-Token' + /addresses/{addressId}: + get: + tags: + - Addresses + summary: Get Address + description: Get the address specified by your unique Address ID. + operationId: Addresses_Get + consumes: [] + parameters: + - name: addressId + in: path + description: Your unique Address ID. + required: true + type: string + responses: + 200: + description: The address is found and returned successfully + schema: + $ref: '#/definitions/Address' + examples: + application/json: + AddressId: GBAD453RD1030 + IsReturnAddress: false + ContactName: John Smith + AddressLine1: Brown Cottage + AddressLine2: 15-30 Maple Tree Avenue + Town: Redhill Moores + CountryCode: GB + Postcode: AD45 3RD + EmailAddress: john@exampleemail.com + application/xml: "\r\n
\r\n + \ GBAD453RD1030\r\n false\r\n + \ John Smith\r\n Brown Cottage\r\n + \ 15-30 Maple Tree Avenue\r\n Redhill + Moores\r\n GB\r\n AD45 + 3RD\r\n john@exampleemail.com\r\n
" + 401: + description: Unauthorized + examples: + application/json: + httpCode: 401 + httpMessage: Unauthorized + moreInformation: Authentication failure. + application/xml: " \r\n\r\n401 + \r\nUnauthorized \r\nAuthentication + failure.\r\n " + 404: + description: Address not found + 500: + description: Internal Server Error + 503: + description: Service Unavailable + produces: + - application/xml + - application/json + put: + tags: + - Addresses + summary: Update address + description: Update an address that is already in your address book with new + details. The whole address will be replaced with
new details. + operationId: Addresses_Update + parameters: + - name: addressId + in: path + description: Your unique Address ID of the address to update. + required: true + type: string + - name: address + in: body + description: The address with the updated details. + required: true + schema: + $ref: '#/definitions/Address' + responses: + 200: + description: The address was updated successfully + schema: + $ref: '#/definitions/AddressResponse' + examples: + application/json: + AddressId: GBAD453RD1030 + HttpStatusCode: 200 + HttpStatusDescription: OK + Message: Address updated + application/xml: "\r\n\r\n + \ 200\r\n OK\r\n + \ Address updated\r\n GBAD453RD1030\r\n" + 400: + description: Bad Request - the address is invalid. Details are provided + in the error messages. + schema: + $ref: '#/definitions/AddressResponse' + examples: + application/json: + AddressId: GBAD453RD1030 + HttpStatusCode: 400 + HttpStatusDescription: BadRequest + Message: The address is invalid. + Errors: + - Message: The town for an address is required. + Cause: Town + ErrorCode: E1432 + - Message: The second line of the address must be 35 characters or less. + Cause: AddressLine2 + ErrorCode: E1433 + application/xml: "\r\n\r\n + \ 400\r\n BadRequest\r\n + \ The address is invalid.\r\n \r\n \r\n + \ The town for an address is required.\r\n Town\r\n + \ E1432\r\n \r\n \r\n + \ The second line of the address must be 35 characters + or less.\r\n AddressLine2\r\n E1433\r\n + \ \r\n \r\n GBAD453RD1030\r\n" + 401: + description: Unauthorized + examples: + application/json: + httpCode: 401 + httpMessage: Unauthorized + moreInformation: Authentication failure. + application/xml: " \r\n\r\n401 + \r\nUnauthorized \r\nAuthentication + failure.\r\n " + 404: + description: Address not found + schema: + $ref: '#/definitions/AddressResponse' + examples: + application/json: + AddressId: GBAD453RD1030 + HttpStatusCode: 404 + HttpStatusDescription: NotFound + Message: The address was not found. Please check the AddressId is correct. + application/xml: "\r\n\r\n + \ 404\r\n NotFound\r\n + \ The address was not found. Please check the AddressId is + correct.\r\n GBAD453RD1030\r\n" + 500: + description: Internal Server Error + 503: + description: Service Unavailable + consumes: + - application/xml + - application/json + delete: + tags: + - Addresses + summary: Delete Address + description: Deletes the specified address. + operationId: Addresses_Delete + consumes: [] + parameters: + - name: addressId + in: path + description: Your unique Address ID of the address to delete. + required: true + type: string + responses: + 200: + description: The address was deleted successfully + schema: + $ref: '#/definitions/AddressResponse' + examples: + application/json: + AddressId: GBAD453RD1030 + HttpStatusCode: 200 + HttpStatusDescription: OK + Message: Address deleted + application/xml: "\r\n\r\n + \ 200\r\n OK\r\n + \ Address deleted\r\n GBAD453RD1030\r\n" + 400: + description: Unable to delete the address + schema: + $ref: '#/definitions/AddressResponse' + examples: + application/json: + AddressId: GBAD453RD1030 + HttpStatusCode: 400 + HttpStatusDescription: BadRequest + Message: Unable to delete the address. + Errors: + - Message: Unable to delete the address as it is being used as a default + return address in label options. + Cause: Address being used + ErrorCode: E1434 + application/xml: "\r\n\r\n + \ 400\r\n BadRequest\r\n + \ Unable to delete the address.\r\n \r\n + \ \r\n Unable to delete the address as + it is being used as a default return address in label options.\r\n + \ Address being used\r\n E1434\r\n + \ \r\n \r\n GBAD453RD1030\r\n" + 401: + description: Unauthorized + examples: + application/json: + httpCode: 401 + httpMessage: Unauthorized + moreInformation: Authentication failure. + application/xml: " \r\n\r\n401 + \r\nUnauthorized \r\nAuthentication + failure.\r\n " + 404: + description: Address not found + schema: + $ref: '#/definitions/AddressResponse' + examples: + application/json: + AddressId: GBAD453RD1030 + HttpStatusCode: 404 + HttpStatusDescription: NotFound + Message: The address was not found. Please check the AddressId is correct. + application/xml: "\r\n\r\n + \ 404\r\n NotFound\r\n + \ The address was not found. Please check the AddressId is + correct.\r\n GBAD453RD1030\r\n" + 500: + description: Internal Server Error + 503: + description: Service Unavailable + produces: + - application/xml + - application/json + parameters: + - $ref: '#/parameters/X-RMG-Auth-Token' + /token: + post: + tags: + - Token + summary: Authenticates a User and provides token. + description: Provides security token. + operationId: Authenticate_Post + responses: + 200: + description: Token is created. + examples: + application/json: + token: eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDc2NTE4NzUsImlhdCI6MTU0NzYzNzQ3NSwicGFzc3dvcmQiOiJodmZrTi9xbHAvemhYUjNjdWVycTZqZDJaN2c9In0.gKwLgSNxF5X1l5R2VkYRO42xjOmxvoPyslohY74q64 + application/xml: "\r\n\r\neyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDc2NTE4NzUsImlhdCI6MTU0NzYzNzQ3NSwicGFzc3dvcmQiOiJodmZrTi9xbHAvemhYUjNjdWVycTZqZDJaN2c9In0.gKwLgSNxF5X1l5R2VkYRO42xjOmxvoPyslohY74q64\r\n" + 401: + description: Unauthorized + examples: + application/json: + httpCode: 401 + httpMessage: Unauthorized + moreInformation: Invalid or expired token. + application/xml: " \r\n\r\n401 + \r\nUnauthorized \r\nInvalid + or expired token.\r\n " + 500: + description: Internal Server Error + 503: + description: Service Unavailable + security: + - clientID: [] + clientSecret: [] + parameters: + - $ref: '#/parameters/X-RMG-Security-Username' + - $ref: '#/parameters/X-RMG-Security-Password' + produces: + - application/xml + - application/json + /items: + get: + tags: + - Items + summary: Get Items + description: Get all of your stored items + operationId: Items_GetAll + consumes: [] + responses: + 200: + description: All existing items are returned + schema: + type: array + items: + $ref: '#/definitions/Item' + examples: + application/json: + - ItemId: GBAD453RD1030 + Description: White Tee-shirt Large + Value: 19.990000 + Currency: GBP + Weight: 0.129000 + WeightUnitOfMeasure: KG + HsCode: "123546215487" + SkuCode: TEEWHLG + CountryOfOrigin: IT + - ItemId: GBAD453RD1031 + Description: Oak Chest + Value: 139.990000 + Currency: GBP + Weight: 1.200000 + WeightUnitOfMeasure: KG + HsCode: "201245" + SkuCode: CHEST-OAK + CountryOfOrigin: DE + application/xml: "\r\n\r\n + \ \r\n 123546215487\r\n TEEWHLG\r\n + \ IT\r\n GBAD453RD1030\r\n + \ White Tee-shirt Large\r\n 19.99\r\n + \ GBP\r\n 0.129\r\n KG\r\n + \ \r\n \r\n 201245\r\n CHEST-OAK\r\n + \ DE\r\n GBAD453RD1031\r\n + \ Oak Chest\r\n 139.99\r\n + \ GBP\r\n 1.2\r\n KG\r\n + \ \r\n" + 401: + description: Unauthorized + examples: + application/json: + httpCode: 401 + httpMessage: Unauthorized + moreInformation: Authentication failure. + application/xml: " \r\n\r\n401 + \r\nUnauthorized \r\nAuthentication + failure.\r\n " + 500: + description: Internal Server Error + 503: + description: Service Unavailable + produces: + - application/xml + - application/json + post: + tags: + - Items + summary: Create Item + description: Add a new item to your stored items that you can then use in your + shipment requests. + operationId: Items_Create + parameters: + - name: item + in: body + description: The item. + required: true + schema: + $ref: '#/definitions/Item' + responses: + 200: + description: The item was created successfully + schema: + $ref: '#/definitions/ItemResponse' + examples: + application/json: + ItemId: AB1223454 + HttpStatusCode: 200 + HttpStatusDescription: OK + Message: Item created + application/xml: "\r\n\r\n + \ 200\r\n OK\r\n + \ Item created\r\n AB1223454\r\n" + 400: + description: Bad Request - the request is invalid. Details are provided + in the error messages. + schema: + $ref: '#/definitions/ItemResponse' + examples: + application/json: + ItemId: AB1223454 + HttpStatusCode: 400 + HttpStatusDescription: BadRequest + Message: The item is invalid. + Errors: + - Message: The currency code GBR is invalid + Cause: Currency + ErrorCode: E1433 + - Message: The description is required + Cause: Description + ErrorCode: E1432 + application/xml: "\r\n\r\n + \ 400\r\n BadRequest\r\n + \ The item is invalid.\r\n \r\n \r\n + \ The currency code GBR is invalid\r\n Currency\r\n + \ E1433\r\n \r\n \r\n + \ The description is required\r\n Description\r\n + \ E1432\r\n \r\n \r\n + \ AB1223454\r\n" + 401: + description: Unauthorized + examples: + application/json: + httpCode: 401 + httpMessage: Unauthorized + moreInformation: Authentication failure. + application/xml: " \r\n\r\n401 + \r\nUnauthorized \r\nAuthentication + failure.\r\n " + 500: + description: Internal Server Error + 503: + description: Service Unavailable + consumes: + - application/xml + - application/json + produces: + - application/xml + - application/json + parameters: + - $ref: '#/parameters/X-RMG-Auth-Token' + /items/{itemId}: + get: + tags: + - Items + summary: Get Item + description: Get the item specified by your unique Item ID. + operationId: Items_Get + parameters: + - name: itemId + in: path + description: Your unique Item ID. + required: true + type: string + responses: + 200: + description: The item is found and returned successfully + schema: + $ref: '#/definitions/Item' + examples: + application/json: + ItemId: GBAD453RD1030 + Description: White Tee-shirt Large + Value: 19.990000 + Currency: GBP + Weight: 0.129000 + WeightUnitOfMeasure: KG + HsCode: "123546215487" + SkuCode: TEEWHLG + CountryOfOrigin: IT + application/xml: "\r\n\r\n + \ 123546215487\r\n TEEWHLG\r\n + \ IT\r\n GBAD453RD1030\r\n + \ White Tee-shirt Large\r\n 19.99\r\n + \ GBP\r\n 0.129\r\n KG\r\n" + 401: + description: Unauthorized + examples: + application/json: + httpCode: 401 + httpMessage: Unauthorized + moreInformation: Authentication failure. + application/xml: " \r\n\r\n401 + \r\nUnauthorized \r\nAuthentication + failure.\r\n " + 404: + description: Item not found + 500: + description: Internal Server Error + 503: + description: Service Unavailable + consumes: [] + produces: + - application/xml + - application/json + put: + tags: + - Items + summary: Update item + description: Update an item that is already stored with new details. The whole + item will be replaced with new details. + operationId: Items_Update + parameters: + - name: itemId + in: path + description: Your unique Item ID of the item to update. + required: true + type: string + - name: item + in: body + description: The item with the updated details. + required: true + schema: + $ref: '#/definitions/Item' + responses: + 200: + description: The item was updated successfully + schema: + $ref: '#/definitions/ItemResponse' + examples: + application/json: + ItemId: AB1223454 + HttpStatusCode: 200 + HttpStatusDescription: OK + Message: Item updated + application/xml: "\r\n\r\n + \ 200\r\n OK\r\n + \ Item updated\r\n AB1223454\r\n" + 400: + description: Bad Request - the request is invalid. Details are provided + in the error messages. + schema: + $ref: '#/definitions/ItemResponse' + examples: + application/json: + ItemId: AB1223454 + HttpStatusCode: 400 + HttpStatusDescription: BadRequest + Message: The item is invalid. + Errors: + - Message: The currency code GBR is invalid + Cause: Currency + ErrorCode: E1433 + - Message: The description is required + Cause: Description + ErrorCode: E1432 + application/xml: "\r\n\r\n + \ 400\r\n BadRequest\r\n + \ The item is invalid.\r\n \r\n \r\n + \ The currency code GBR is invalid\r\n Currency\r\n + \ E1433\r\n \r\n \r\n + \ The description is required\r\n Description\r\n + \ E1432\r\n \r\n \r\n + \ AB1223454\r\n" + 401: + description: Unauthorized + examples: + application/json: + httpCode: 401 + httpMessage: Unauthorized + moreInformation: Authentication failure. + application/xml: " \r\n\r\n401 + \r\nUnauthorized \r\nAuthentication + failure.\r\n " + 404: + description: Item not found + examples: + application/json: + ItemId: GBAD453RD1030 + HttpStatusCode: 404 + HttpStatusDescription: NotFound + Message: The item was not found. Please check the ItemId is correct. + application/xml: "\r\n\r\n + \ 404\r\n NotFound\r\n + \ The item was not found. Please check the ItemId is correct.\r\n + \ GBAD453RD1030\r\n" + 500: + description: Internal Server Error + 503: + description: Service Unavailable + consumes: + - application/xml + - application/json + produces: + - application/xml + - application/json + delete: + tags: + - Items + summary: Delete Item + description: Deletes the specified item. + operationId: Items_Delete + parameters: + - name: itemId + in: path + description: Your unique Item ID of the item to delete. + required: true + type: string + responses: + 200: + description: The item was deleted successfully + schema: + $ref: '#/definitions/ItemResponse' + examples: + application/json: + ItemId: GBAD453RD1030 + HttpStatusCode: 200 + HttpStatusDescription: OK + Message: Item deleted + application/xml: "\r\n\r\n + \ 200\r\n OK\r\n + \ Item deleted\r\n GBAD453RD1030\r\n" + 401: + description: Unauthorized + examples: + application/json: + httpCode: 401 + httpMessage: Unauthorized + moreInformation: Authentication failure. + application/xml: " \r\n\r\n401 + \r\nUnauthorized \r\nAuthentication + failure.\r\n " + 404: + description: Item not found + examples: + application/json: + ItemId: GBAD453RD1030 + HttpStatusCode: 404 + HttpStatusDescription: NotFound + Message: The item was not found. Please check the ItemId is correct. + application/xml: "\r\n\r\n + \ 404\r\n NotFound\r\n + \ The item was not found. Please check the ItemId is correct.\r\n + \ GBAD453RD1030\r\n" + 500: + description: Internal Server Error + 503: + description: Service Unavailable + consumes: [] + produces: + - application/xml + - application/json + parameters: + - $ref: '#/parameters/X-RMG-Auth-Token' + /packaging: + get: + tags: + - Packaging + summary: Get All Packaging + description: Get all of your stored packaging details + operationId: Packaging_GetAll + consumes: [] + responses: + 200: + description: OK + schema: + type: array + items: + $ref: '#/definitions/Packaging' + examples: + application/json: + - PackagingId: GBAD453RD1030 + Name: Box - Small + Weight: 0.013000 + WeightUnitOfMeasure: KG + Length: 5 + Width: 5 + Height: 2.500000 + - PackagingId: GBAD453RD1031 + Name: Box - Medium + Weight: 0.025000 + WeightUnitOfMeasure: KG + Length: 10.200000 + Width: 15.200000 + Height: 5.500000 + application/xml: "\r\n\r\n + \ \r\n GBAD453RD1030\r\n Box + - Small\r\n 0.013\r\n KG\r\n + \ 5\r\n 5\r\n 2.5\r\n + \ \r\n \r\n GBAD453RD1031\r\n + \ Box - Medium\r\n 0.025\r\n KG\r\n + \ 10.2\r\n 15.2\r\n 5.5\r\n + \ \r\n" + 401: + description: Unauthorized + examples: + application/json: + httpCode: 401 + httpMessage: Unauthorized + moreInformation: Authentication failure. + application/xml: " \r\n\r\n401 + \r\nUnauthorized \r\nAuthentication + failure.\r\n " + 500: + description: Internal Server Error + 503: + description: Service Unavailable + produces: + - application/xml + - application/json + post: + tags: + - Packaging + summary: Create Packaging + description: Add new packaging to your stored packaging details that you can + then use in your shipment requests. + operationId: Packaging_Create + parameters: + - name: packaging + in: body + description: The packaging details. + required: true + schema: + $ref: '#/definitions/Packaging' + responses: + 200: + description: OK + schema: + $ref: '#/definitions/PackagingResponse' + examples: + application/json: + PackagingId: AB1223454 + HttpStatusCode: 200 + HttpStatusDescription: OK + Message: Packaging details created + application/xml: "\r\n\r\n + \ 200\r\n OK\r\n + \ Packaging details created\r\n AB1223454\r\n" + 400: + description: Bad Request - the packaging details are invalid. Details are + provided in the error messages. + schema: + $ref: '#/definitions/PackagingResponse' + examples: + application/json: + PackagingId: AB1223454 + HttpStatusCode: 400 + HttpStatusDescription: BadRequest + Message: The packaging details are invalid. + Errors: + - Message: The package length must be between 0.01cm to 250cm + Cause: Length + ErrorCode: E1433 + - Message: The packaging name is required + Cause: Name + ErrorCode: E1432 + application/xml: "\r\n\r\n + \ 400\r\n BadRequest\r\n + \ The packaging details are invalid.\r\n \r\n + \ \r\n The package length must be between + 0.01cm to 250cm\r\n Length\r\n E1433\r\n + \ \r\n \r\n The packaging + name is required\r\n Name\r\n E1432\r\n + \ \r\n \r\n AB1223454\r\n" + 401: + description: Unauthorized + examples: + application/json: + httpCode: 401 + httpMessage: Unauthorized + moreInformation: Authentication failure. + application/xml: " \r\n\r\n401 + \r\nUnauthorized \r\nAuthentication + failure.\r\n " + 500: + description: Internal Server Error + 503: + description: Service Unavailable + consumes: + - application/xml + - application/json + produces: + - application/xml + - application/json + parameters: + - $ref: '#/parameters/X-RMG-Auth-Token' + /packaging/{packagingId}: + get: + tags: + - Packaging + summary: Get Packaging + description: Get the packaging details specified by your unique Packaging ID. + operationId: Packaging_Get + consumes: [] + parameters: + - name: packagingId + in: path + description: Your Unique Packaging ID. + required: true + type: string + responses: + 200: + description: OK + schema: + $ref: '#/definitions/Packaging' + examples: + application/json: + PackagingId: GBAD453RD1030 + Name: Box - Small + Weight: 0.013000 + WeightUnitOfMeasure: KG + Length: 5 + Width: 5 + Height: 2.500000 + application/xml: "\r\n\r\n + \ GBAD453RD1030\r\n Box - Small\r\n + \ 0.013\r\n KG\r\n + \ 5\r\n 5\r\n 2.5\r\n" + 401: + description: Unauthorized + examples: + application/json: + httpCode: 401 + httpMessage: Unauthorized + moreInformation: Authentication failure. + application/xml: " \r\n\r\n401 + \r\nUnauthorized \r\nAuthentication + failure.\r\n " + 404: + description: Packaging details not found + 500: + description: Internal Server Error + 503: + description: Service Unavailable + produces: + - application/xml + - application/json + put: + tags: + - Packaging + summary: Update packaging + description: Update packaging details that is already stored with new details. + All details will be replaced with new details. + operationId: Packaging_Update + parameters: + - name: packagingId + in: path + description: Your unique Packaging ID of the packaging details to update. + required: true + type: string + - name: packaging + in: body + description: The packaging with the updated details. + required: true + schema: + $ref: '#/definitions/Packaging' + responses: + 200: + description: OK + schema: + $ref: '#/definitions/PackagingResponse' + examples: + application/json: + PackagingId: AB1223454 + HttpStatusCode: 200 + HttpStatusDescription: OK + Message: Packaging details updated + application/xml: "\r\n\r\n + \ 200\r\n OK\r\n + \ Packaging details updated\r\n AB1223454\r\n" + 400: + description: Bad Request - The packaging details are invalid. Details are + provided in the error messages. + schema: + $ref: '#/definitions/PackagingResponse' + examples: + application/json: + PackagingId: AB1223454 + HttpStatusCode: 400 + HttpStatusDescription: BadRequest + Message: The packaging details are invalid. + Errors: + - Message: The package length must be between 0.01cm to 250cm + Cause: Length + ErrorCode: E1433 + - Message: The packaging name is required + Cause: Name + ErrorCode: E1432 + application/xml: "\r\n\r\n + \ 400\r\n BadRequest\r\n + \ The packaging details are invalid.\r\n \r\n + \ \r\n The package length must be between + 0.01cm to 250cm\r\n Length\r\n E1433\r\n + \ \r\n \r\n The packaging + name is required\r\n Name\r\n E1432\r\n + \ \r\n \r\n AB1223454\r\n" + 401: + description: Unauthorized + examples: + application/json: + httpCode: 401 + httpMessage: Unauthorized + moreInformation: Authentication failure. + application/xml: " \r\n\r\n401 + \r\nUnauthorized \r\nAuthentication + failure.\r\n " + 404: + description: Packaging not found + examples: + application/json: + PackagingId: GBAD453RD1030 + HttpStatusCode: 404 + HttpStatusDescription: NotFound + Message: The packaging details were not found. Please check the PackagingId + is correct. + application/xml: "\r\n\r\n + \ 404\r\n NotFound\r\n + \ The packaging details were not found. Please check the PackagingId + is correct.\r\n GBAD453RD1030\r\n" + 500: + description: Internal Server Error + 503: + description: Service Unavailable + consumes: + - application/xml + - application/json + produces: + - application/xml + - application/json + delete: + tags: + - Packaging + summary: Delete Packaging + description: Deletes the specified packaging. + operationId: Packaging_Delete + consumes: [] + parameters: + - name: packagingId + in: path + description: Your unique Packaging ID of the packaging details to delete. + required: true + type: string + responses: + 200: + description: OK + schema: + $ref: '#/definitions/PackagingResponse' + examples: + application/json: + PackagingId: GBAD453RD1030 + HttpStatusCode: 200 + HttpStatusDescription: OK + Message: Packaging details deleted + application/xml: "\r\n\r\n + \ 200\r\n OK\r\n + \ Packaging details deleted\r\n GBAD453RD1030\r\n" + 401: + description: Unauthorized + examples: + application/json: + httpCode: 401 + httpMessage: Unauthorized + moreInformation: Authentication failure. + application/xml: " \r\n\r\n401 + \r\nUnauthorized \r\nAuthentication + failure.\r\n " + 404: + description: Packaging not found + examples: + application/json: + PackagingId: GBAD453RD1030 + HttpStatusCode: 404 + HttpStatusDescription: NotFound + Message: The packaging details were not found. Please check the PackagingId + is correct. + application/xml: "\r\n\r\n + \ 404\r\n NotFound\r\n + \ The packaging details were not found. Please check the PackagingId + is correct.\r\n GBAD453RD1030\r\n" + 500: + description: Internal Server Error + 503: + description: Service Unavailable + produces: + - application/xml + - application/json + parameters: + - $ref: '#/parameters/X-RMG-Auth-Token' +definitions: + ShipmentHoldRequest: + description: A request to hold a shipment. + required: + - ShipmentId + - ReasonForHold + type: object + properties: + ShipmentId: + description: Shipment Id
The tracking number or Unique Id of the shipment + to hold. + maxLength: 21 + minLength: 13 + type: string + example: RE012345673GB + ReasonForHold: + description: Reason for Hold
Must match a Hold Reason set in Pro Shipping + Maintenance / Hold Reasons. + maxLength: 30 + type: string + example: Awaiting part + xml: + name: ShipmentHoldRequest + ShipmentsHoldResponse: + description: Response from a hold 1 or more shipments request. + required: + - HttpStatusCode + - HttpStatusDescription + type: object + properties: + ShipmentIds: + description: Shipment Ids
Tracking Numbers / Unique Ids of each shipment + involved in the request. + maxLength: 21 + minLength: 13 + type: array + items: + type: string + xml: + name: ShipmentId + xml: + name: ShipmentIds + wrapped: true + example: + - RE012345673GB + - 3A01234561234568AE7C7 + HttpStatusCode: + format: int32 + description: HTTP Status Code + type: integer + example: 200 + HttpStatusDescription: + description: HTTP Status Description + type: string + example: OK + Message: + description: Message
Successful response may include a success message.
Failure responses will have general reason as to why. Further details + may be contained in the list of errors. + type: string + example: Your item has been created/updated successfully + Errors: + description: Errors
Details about why a request failed. + type: array + items: + $ref: '#/definitions/ErrorDetail' + xml: + name: Errors + wrapped: true + xml: + name: ShipmentsHoldResponse + ErrorDetail: + description: Details about an error + type: object + properties: + Message: + description: Message
The error message, or issue. + type: string + example: The first line of the address must be 35 characters or less. + Cause: + description: Cause
The cause of the error. + type: string + example: DestinationAddressLine1 + ErrorCode: + description: Error Code
The error code for this error.

**E1431** + - System error
**E1432** - Required field
**E1433** - Invalid + field
**E1434** - Invalid action
**E1435** - Item not found
+ type: string + example: E1433 + ErrorId: + description: Error Log Id
The associated Error Log Id if exists. + type: string + xml: + name: ErrorDetail + ShipmentDeferRequest: + description: A request to defer a shipment to a later date. + required: + - ShipmentId + - ShipmentDate + type: object + properties: + ShipmentId: + description: Shipment Id
The tracking number or Unique Id of the shipment + to defer. + maxLength: 21 + minLength: 13 + type: string + example: ED521469583GB + ShipmentDate: + format: date + description: Shipment Date
Date of despatch ??? YYYY-MM-DD
Cannot + be in the past. Max 28 days in the future. + type: string + example: "2019-01-19" + xml: + name: ShipmentDeferRequest + ShipmentsDeferResponse: + description: Response from a defer shipments request. + required: + - HttpStatusCode + - HttpStatusDescription + type: object + properties: + ShipmentIds: + description: Shipment Ids
Tracking Numbers / Unique Ids of each shipment + involved in the request. + maxLength: 21 + minLength: 13 + type: array + items: + type: string + xml: + name: ShipmentId + xml: + name: ShipmentIds + wrapped: true + example: + - RE012345673GB + - 3A01234561234568AE7C7 + HttpStatusCode: + format: int32 + description: HTTP Status Code + type: integer + example: 200 + HttpStatusDescription: + description: HTTP Status Description + type: string + example: OK + Message: + description: Message
Successful response may include a success message.
Failure responses will have general reason as to why. Further details + may be contained in the list of errors. + type: string + example: Your item has been created/updated successfully + Errors: + description: Errors
Details about why a request failed. + type: array + items: + $ref: '#/definitions/ErrorDetail' + xml: + name: Errors + wrapped: true + xml: + name: ShipmentsDeferResponse + ShipmentCancelRequest: + description: A request to cancel a shipment. + required: + - ShipmentId + - ReasonForCancellation + type: object + properties: + ShipmentId: + description: Shipment Id
The tracking number or Unique Id of the shipment + to cancel. + maxLength: 21 + minLength: 13 + type: string + example: ED521469583GB + ReasonForCancellation: + description: Reason for Cancellation + enum: + - OrderCancelled + - Repacked + - UploadedInError + - WrongService + type: string + xml: + name: ShipmentCancelRequest + ShipmentsCancelResponse: + description: Response from a cancel shipments request. + required: + - HttpStatusCode + - HttpStatusDescription + type: object + properties: + ShipmentIds: + description: Shipment Ids
Tracking Numbers / Unique Ids of each shipment + involved in the request. + maxLength: 21 + minLength: 13 + type: array + items: + type: string + xml: + name: ShipmentId + xml: + name: ShipmentIds + wrapped: true + example: + - RE012345673GB + - 3A01234561234568AE7C7 + HttpStatusCode: + format: int32 + description: HTTP Status Code + type: integer + example: 200 + HttpStatusDescription: + description: HTTP Status Description + type: string + example: OK + Message: + description: Message
Successful response may include a success message.
Failure responses will have general reason as to why. Further details + may be contained in the list of errors. + type: string + example: Your item has been created/updated successfully + Errors: + description: Errors
Details about why a request failed. + type: array + items: + $ref: '#/definitions/ErrorDetail' + xml: + name: Errors + wrapped: true + xml: + name: ShipmentsCancelResponse + ShipmentsReleaseRequest: + description: Request to release 1 or more shipments from hold. + type: object + properties: + ShipmentIds: + description: Shipment Ids
Tracking Numbers / Unique Ids of each shipment + to release from hold. + maxLength: 21 + minLength: 13 + type: array + items: + type: string + xml: + name: ShipmentId + xml: + name: ShipmentIds + wrapped: true + example: + - RE012345673GB + - 3A01234561234568AE7C7 + xml: + name: ShipmentsReleaseRequest + ShipmentsReleaseResponse: + description: Response from a release 1 or more shipments request. + required: + - HttpStatusCode + - HttpStatusDescription + type: object + properties: + ShipmentIds: + description: Shipment Ids
Tracking Numbers / Unique Ids of each shipment + involved in the request. + maxLength: 21 + minLength: 13 + type: array + items: + type: string + xml: + name: ShipmentId + xml: + name: ShipmentIds + wrapped: true + example: + - RE012345673GB + - 3A01234561234568AE7C7 + HttpStatusCode: + format: int32 + description: HTTP Status Code + type: integer + example: 200 + HttpStatusDescription: + description: HTTP Status Description + type: string + example: OK + Message: + description: Message
Successful response may include a success message.
Failure responses will have general reason as to why. Further details + may be contained in the list of errors. + type: string + example: Your item has been created/updated successfully + Errors: + description: Errors
Details about why a request failed. + type: array + items: + $ref: '#/definitions/ErrorDetail' + xml: + name: Errors + wrapped: true + xml: + name: ShipmentsReleaseResponse + PrintLabelRequest: + description: A request to print a label + type: object + properties: + LabelFormat: + description: Requested Label Format
*DATASTREAM is only available if + it has been activated on your account.* + default: PDF + enum: + - PDF + - PNG + - DATASTREAM + - ZPL203DPI + - ZPL300DPI + type: string + SilentPrintProfile: + format: uuid + description: Silent Print Profile
If present, resulting labels will be + printed using this profile. + type: string + example: 75b59db8-3cd3-4578-888e-54be016f07cc + xml: + name: PrintLabelRequest + PrintLabelResponse: + description: Response from a print label request, containing the label if the + request was successful. + required: + - HttpStatusCode + - HttpStatusDescription + type: object + properties: + ShipmentId: + description: Shipment Id
Tracking Number or Unique Id of the shipment + involved. + maxLength: 21 + minLength: 13 + type: string + example: 3A01234561234568AE7C7 + LabelImage: + description: Label Image
Depends on Label Image Format

**PDF**
Base 64 encoded PDF

**PNG**
Base + 64 encoded PNG

**ZPL 300 / 203 dpi**
Base 64 + encoded PRN (text file)

**Data stream**
Not + Included + type: string + example: AxLjUwLjQwMDAtZ2RpIFwod3d3LnBkZnNoY ... XJwLmNvbVwpKQovUHJvZHVjZXIoUERG + LabelImageFormat: + description: Label Image Format + enum: + - PDF + - PNG + - DATASTREAM + - ZPL203DPI + - ZPL300DPI + type: string + TrackingNumber: + description: Shipment Tracking Number
Final Mile carrier tracking number + maxLength: 13 + minLength: 13 + type: string + example: HF123456783GB + UniqueId: + description: Unique Shipment ID + maxLength: 21 + minLength: 21 + type: string + example: 3A01234561234568AE7C7 + TrackingUrl: + description: Tracking URL
Final Mile Tracking, if available + maxLength: 250 + type: string + example: http://carrier.website.com/tracking?number=HF123456783GB + CarrierCode: + description: Carrier Code
The allocated carrier. + maxLength: 4 + type: string + example: RMG + Primary2DBarcodeImage: + description: Primary 2D Barcode Image
Only populated for Data Stream + response.
Base64 Encoded PNG Image of the 2D data matrix barcode. + type: string + example: iVBORw0KGgoAAAANSUhE ... UgAAAGgAAABoAQMAAAAn0ifiAAAA + Primary2DBarcodeData: + description: Primary 2D Barcode Data - Base 64 Encoded
Only populated + for Data Stream response.
Data required to create your own 2D data + matrix barcode. Please decode before use. + type: string + example: iVBORw0KGgoAAAANSUhE ... UgAAAGgAAABoAQMAAAAn0ifiAAAA + FormattedUniqueId: + description: Formatted Unique Id
Only populated for Data Stream response.
Label for 2D data matrix barcode. + type: string + example: 3A-070 338 6001-000 0B2 000 + HighVolumeBarcodeData: + description: High Volume Barcode Data
Only populated for Data Stream + response where the service requires the barcode on the label.
Data + required to create your own High Volume barcode. + type: string + example: '*SW115QZ*' + HighVolumeBarcodeImage: + description: High Volume Barcode Image
Only populated for Data Stream + response where the service requires the barcode on the label.
Base64 + Encoded PNG Image of the High Volume barcode. + type: string + example: iVBORw0KGgoAAAANSUhE ... UgAAAGgAAABoAQMAAAAn0ifiAAAA + HighVolumeSortCode: + description: High Volume Sort Code
Only populated for Data Stream response + where the service requires the sort code on the label. + type: string + example: Q26 + Primary1DBarcodeData: + description: Primary 1D Barcode Data
Only populated for Data Stream response + where the service requires the barcode on the label.
Data required + to create your own 1D barcode. + type: string + example: HF123456783GB + Primary1DBarcodeImage: + description: Primary 1D Barcode Image
Only populated for Data Stream + response where the service requires the barcode on the label.
Base64 + Encoded PNG Image of the 1D barcode. + type: string + example: iVBORw0KGgoAAAANSUhE ... UgAAAGgAAABoAQMAAAAn0ifiAAAA + ReturnLabelImageFormat: + description: Return Label Image Format + enum: + - PDF + - PNG + - ZPL300DPI + - ZPL203DPI + type: string + ReturnLabelImage: + description: Return Label Image
Any return label that have been created + as a result of the request and label option settings.
Depends on ReturnLabelImageFormat.

**PDF**
Base 64 encoded PDF

**PNG**
Base 64 encoded PNG

**ZPL 300 / 203 + dpi**
Base 64 encoded PRN (text file) + type: string + example: AxLjUwLjQwMDAtZ2RpIFwod3d3LnBkZnNoY ... XJwLmNvbVwpKQovUHJvZHVjZXIoUERG + Routing: + $ref: '#/definitions/Routing' + HttpStatusCode: + format: int32 + description: HTTP Status Code + type: integer + example: 200 + HttpStatusDescription: + description: HTTP Status Description + type: string + example: OK + Message: + description: Message
Successful response may include a success message.
Failure responses will have general reason as to why. Further details + may be contained in the list of errors. + type: string + example: Your item has been created/updated successfully + Errors: + description: Errors
Details about why a request failed. + type: array + items: + $ref: '#/definitions/ErrorDetail' + xml: + name: Errors + wrapped: true + xml: + name: PrintLabelResponse + Routing: + description: Routing information + type: object + properties: + InwardCode: + description: Inward Code
Only populated for Data Stream response where + the service requires the Gazetteer codes on the label. + type: string + example: A3 + OutwardCode: + description: Outward Code
Only populated for Data Stream response where + the service requires the Gazetteer codes on the label. + type: string + example: Q20 + Walk: + description: Walk
Only populated for Data Stream response where the service + requires the Gazetteer codes on the label. + type: string + example: AAA + Loop: + description: Loop
Only populated for Data Stream response where the service + requires the Gazetteer codes on the label. + type: string + example: "123" + xml: + name: Routing + PrintDocumentRequest: + description: A request to print a document for a shipment + required: + - DocumentType + type: object + properties: + DocumentType: + description: Document Type
What document you would like printed

**CN23** - Customs Documents PDF 100mm x 150mm
**CI** - Commercial + Invoice PDF A4 Portrait
**P** - Proforma PDF A4 Portrait + enum: + - CN23 + - CI + - P + type: string + SilentPrintProfile: + format: uuid + description: Silent Print Profile
If present, resulting documents will + be printed using this profile. + type: string + example: 75b59db8-3cd3-4578-888e-54be016f07cc + xml: + name: PrintDocumentRequest + PrintDocumentResponse: + description: Response from a print documents request, containing the documents + if the request was successful. + required: + - HttpStatusCode + - HttpStatusDescription + type: object + properties: + ShipmentId: + description: Shipment Id
Tracking Number or Unique Id of the shipment + involved. + maxLength: 21 + minLength: 13 + type: string + example: 3A01234561234568AE7C7 + DocumentType: + description: Document Type

**CN23** - Customs Documents + PDF 100mm x 150mm
**CI** - Commercial Invoice PDF A4 Portrait
**P** + - Proforma PDF A4 Portrait + enum: + - CN23 + - CI + - P + type: string + example: CN23 + DocumentImage: + description: Document Image
Base 64 encoded PDF + type: string + example: AxLjUwLjQwMDAtZ2RpIFwod3d3LnBkZnNoY ... XJwLmNvbVwpKQovUHJvZHVjZXIoUERG + HttpStatusCode: + format: int32 + description: HTTP Status Code + type: integer + example: 200 + HttpStatusDescription: + description: HTTP Status Description + type: string + example: OK + Message: + description: Message
Successful response may include a success message.
Failure responses will have general reason as to why. Further details + may be contained in the list of errors. + type: string + example: Your item has been created/updated successfully + Errors: + description: Errors
Details about why a request failed. + type: array + items: + $ref: '#/definitions/ErrorDetail' + xml: + name: Errors + wrapped: true + xml: + name: PrintDocumentResponse + CreateShipment.Shipment: + description: Details of a shipment request. + required: + - Destination + - ShipmentInformation + type: object + properties: + Shipper: + $ref: '#/definitions/Shipper' + description: The Shipper
Who and where the parcel is coming from.
Optional. If not supplied, the posting location address will be used.
*Whether this is required or not is dependent on your account settings. + Destination: + $ref: '#/definitions/CreateShipment.Destination' + description: The Destination
Who and where the parcel is going to.
It is the shipper???s responsibility to provide accurate and concise information + to ensure the best possible delivery experience for the consumer. + ShipmentInformation: + $ref: '#/definitions/CreateShipment.ShipmentInformation' + description: Shipment Information
Overall package details and requested + service information + CustomsInformation: + $ref: '#/definitions/CreateShipment.CustomsInformation' + description: Customs Information + xml: + name: Shipment + Shipper: + description: The shipper details for a shipment request.
Confirms the details + of the shipper address and contact details.
If not supplied, the the posting + location address will be used. + type: object + properties: + AddressId: + description: Shipper Address Id
If supplied all shipper address fields + will be ignored and the address from the Address Book will be used. + maxLength: 70 + type: string + example: UNIQUEID123 + ShipperReference: + description: Shipper Reference
Your reference for this shipment.
This + field is used for Returns processing and is usually the shippers order number + provided to the consumer. + maxLength: 40 + type: string + example: REF123456789 + ShipperReference2: + description: Shipper Reference 2
Your second reference for this shipment. + This field is used for tracking shipment usually the EBAY VTN number provided + to the consumer.
Optional + maxLength: 40 + type: string + example: EBAY112234C + ShipperDepartment: + description: Shipper Department Code
For Royal Mail shipments, this code + must be a valid 10-digit OBA department code. + maxLength: 30 + type: string + example: "123456789" + CompanyName: + description: Company Name + maxLength: 35 + type: string + example: Company & Co. + ContactName: + description: Contact Name + maxLength: 40 + type: string + example: Jane Smith + AddressLine1: + description: Address Line 1
Populate with Shipper's address if provided. + maxLength: 35 + type: string + example: Level 5 + AddressLine2: + description: Address Line 2 + maxLength: 35 + type: string + example: Hashmoore House + AddressLine3: + description: Address Line 3 + maxLength: 35 + type: string + example: 10 Sky Lane + Town: + description: Town
Required if address is populated. + maxLength: 35 + type: string + example: Leatherhead + County: + description: County / State / Province
Whether this is required or not + is dependent on the country settings. + maxLength: 50 + type: string + example: Surrey + CountryCode: + description: Country Code
[ISO Alpha-2 Country Code](https://www.nationsonline.org/oneworld/country_code_list.htm) + per ISO 3166 Standard.
Required if address is populated.
Must + be GB, IM, GG or JE. + maxLength: 2 + minLength: 2 + type: string + example: GB + Postcode: + description: Postcode / Zip
Mandatory for all domestic addresses and + some international shipments if address is populated. + maxLength: 10 + type: string + example: AA34 3AB + PhoneNumber: + description: Contact Phone Number
Must be a valid phone number. + maxLength: 20 + type: string + example: "7723456789" + EmailAddress: + description: Contact Email Address
Must be a valid email address. + maxLength: 254 + type: string + example: email@server.com + VatNumber: + description: VAT Number + maxLength: 20 + type: string + example: GB123 4567 89 + xml: + name: Shipper + CreateShipment.Destination: + description: The destination address and contact details.
It is the shipper???s + responsibility to provide accurate and concise information to ensure the best + possible delivery experience for the consumer. + type: object + properties: + AddressId: + description: Destination Address ID
If supplied all destination address + fields will be ignored and the stored address will be used.
*If a Safeplace + is present in the stored address, the Safeplace enhancement will be used + if the service allows it, otherwise it will be ignored. ShipmentInformation.ServiceOptions.Safeplace + overrides the address Safeplace and forces Safeplace to be required enhancement + of the service.* + maxLength: 70 + type: string + example: UNIQUEID123 + CompanyName: + description: Company Name + maxLength: 35 + type: string + example: Company & Co. + ContactName: + description: Contact Name
Required if Address Id is not provided. + maxLength: 40 + type: string + example: Jane Brown + AddressLine1: + description: Address Line 1
Required if Address Id is not provided. + maxLength: 35 + type: string + example: White Horse + AddressLine2: + description: Address Line 2
*Please ensure the address data is presented + in line with the destination country formats.* + maxLength: 35 + type: string + example: 10 Round Road EBAY11224CB + AddressLine3: + description: Address Line 3
*Please ensure the address data is presented + in line with the destination country formats.* + maxLength: 35 + type: string + example: Mitre Peak + Town: + description: Town
Required if Address Id is not provided. + maxLength: 35 + type: string + example: Leatherhead + County: + description: County / State / Province
Whether this is required or not + is dependent on the country settings. + maxLength: 50 + type: string + example: Surrey + CountryCode: + description: Country Code
[ISO Alpha-2 Country Code](https://www.nationsonline.org/oneworld/country_code_list.htm) per + ISO 3166 Standard. Required if Address Id is not provided + maxLength: 2 + minLength: 2 + type: string + example: GB + Postcode: + description: Postcode / Zip
Mandatory for all domestic shipments and + some international shipments if the Address Id is not provided. + maxLength: 10 + type: string + example: AB3 5CD + PhoneNumber: + description: Contact Phone Number
Required if SMS notifications are requested + (Service Enhancement Code 13 or 16) and Address Id is not provided.
Must + be a valid phone number. + maxLength: 20 + type: string + example: "7123456789" + EmailAddress: + description: Contact Email Address
Required if email notifications are + requested (Service Enhancement Code 14 or 16) and Address Id is not provided.
Must be a valid email address. + maxLength: 254 + type: string + example: email@example.com + VatNumber: + description: VAT Number + maxLength: 20 + type: string + example: GB123 4567 89 + xml: + name: Destination + CreateShipment.ShipmentInformation: + description: Shipment Information. Overall package details, item details and requested + service information in a shipment request.
It is important to ensure accurate + information is supplied to ensure correct handling by different customs around + the world. + required: + - ShipmentDate + - ServiceCode + - TotalPackages + - TotalWeight + type: object + properties: + ShipmentDate: + format: date + description: Shipment Date
Date of despatch - YYYY-MM-DD.
Cannot + be in the past. Max 28 days in the future. + type: string + example: "2019-01-16" + ServiceCode: + description: Service Code
Must be a valid system service code OR a customer + mapped service code. + maxLength: 10 + type: string + example: TPLN + ServiceOptions: + $ref: '#/definitions/CreateShipment.ServiceOptions' + description: Service Options
Only required if you have more than 1 Royal + Mail Posting Location.
Allows you to add enhancements, specify the + posting location, change the service level and specify a service format. + TotalPackages: + format: int32 + description: Number of Packages
The total number of packages. + maximum: 9 + minimum: 1 + type: integer + example: 1 + TotalWeight: + format: double + description: 'Total Weight
The total weight of the shipment including + packaging. Validated againt package weight.
Min weight: 1 gram.
*Optional/Overwritten for Average Weight Services - Average Weight Customers + only.*' + type: number + example: 2.200000 + WeightUnitOfMeasure: + description: Weight Unit of Measure + default: KG + enum: + - KG + - Grams + type: string + Product: + description: Shipment/Product type being shipped

**DOX** + - Documents Only
**NDX** - All other shipment product types + default: NDX + enum: + - NDX + - DOX + type: string + DescriptionOfGoods: + description: Description of Goods
General description of the goods being + sent.
Required for Non-Document International and BFPO Shipments.
Ignored for Documents Only shipments. + maxLength: 70 + type: string + example: Clothing + ReasonForExport: + description: Reason For Export
Required for International Shipments and + BFPO (British Forces Post Office). + maxLength: 250 + type: string + example: Sale of goods + Value: + format: double + description: Total Shipment Value
Required for Non-Document International + and BFPO Shipments.
Ignored for Documents Only shipments. + maximum: 100000000 + minimum: 0.010000 + type: number + example: 39.980000 + Currency: + description: Currency
This currency will be used for all values across + the shipment request, including customs charges.
3 digit ISO Currency + Code.
Required for Non-Document International and BFPO Shipments, or + when values are provided.
Ignored for Documents Only shipments. + maxLength: 3 + minLength: 3 + type: string + example: GBP + Incoterms: + description: International Commercial Terms
Developed by International + Chamber of Commerce and widely used in international and domestic contracts + for the sale of goods.

**DDP** - Delivered Duty Paid.

**DAT** - Delivered At Terminal.

**DAP** - Delivered At Place.

**DDU** - + Delivered Duty Unpaid. + default: DDU + enum: + - DDP + - DAT + - DAP + - DDU + type: string + example: DDU + LabelFormat: + description: Requested Label Format
*DATASTREAM is only available if + it has been activated on your account.*
Ignored if ShipmentAction set + to Create or Allocate. + default: PDF + enum: + - PDF + - PNG + - DATASTREAM + - ZPL203DPI + - ZPL300DPI + type: string + SilentPrintProfile: + format: uuid + description: Silent Print Profile
If present, resulting labels will be + printed using this profile. + type: string + example: 75b59db8-3cd3-4578-888e-54be016f07cc + ShipmentAction: + description: Shipment Action

**Process** - Shipment + created and processed, ready for manifesting. Label and tracking number + returned.

**Create** - Shipment created as unprocessed, + ready for scanning. Scanning will create label and tracking number and move + shipment to processed.

**Allocate** - Shipment created + as unprocessed with tracking number allocated and returned and label created + but not returned. Scanning will return label and move shipment to processed. + default: Process + enum: + - Process + - Allocate + - Create + type: string + Packages: + description: Shipment Packages
The packages in the shipment.
Required + if TotalPackages is more than 1. + type: array + items: + $ref: '#/definitions/CreateShipment.ShipmentPackage' + xml: + name: Packages + wrapped: true + Items: + description: Shipment Items
The items in the shipment.
Required + for Non-Document International Shipments and BFPO (British Forces Post Office).
Ignored for Documents Only shipments. + type: array + items: + $ref: '#/definitions/ShipmentItem' + xml: + name: Items + wrapped: true + xml: + name: ShipmentInformation + CreateShipment.CustomsInformation: + description: Extra customs information not already part of Shipment Information. + type: object + properties: + PreRegistrationNumber: + description: A pre-registration number is only relevant if the INCOTERMS (International + Commercial Terms) for the shipment are DDP (Delivery duty paid).

If not provided, and the INCOTERMS are set to DDP, any pre-registration + numbers set up via your Customs Settings will be used. + maxLength: 50 + type: string + example: GB13132313 + PreRegistrationType: + description: The type of pre-registration number provided above.
Required + if a pre-registration number has been provided.
Ignored if there is + no pre-registration number. + maxLength: 18 + type: string + example: EORI + ShippingCharges: + format: double + description: Shipping Charges for International Shipments.
The postage + amount paid by your customer. The amount can be 0.00 if you have offered + your customer free delivery.
Used for the calculation of customs fees.

*The amount should be in the currency specified in the ShipmentInformation/Currency + field.* + maximum: 99999.990000 + minimum: 0 + type: number + example: "105.20" + OtherCharges: + format: double + description: Insurance and Other Costs for International Shipments.
If + you have charged your customer an additional surcharge such as insurance, + you must declare the amount here.
This field can be left blank, or + be 0.00 if no other charges have been levied.

*Any value should + be in the currency specified in the ShipmentInformation/Currency field.* + maximum: 99999.990000 + minimum: 0 + type: number + example: "0.00" + QuotedLandedCost: + format: double + description: Quoted Landed Cost
This will be the Value of Tax and Duties + due to be paid for via the purchaser to the merchant relevant to international + sales of goods.

*Any value should be in the currency specified + in the ShipmentInformation/Currency field.* + maximum: 99999.990000 + minimum: 0 + type: number + example: "0.00" + InvoiceNumber: + description: Commercial Invoice Number for International Shipments.
When + sending an item to an overseas address and a commercial invoice is available + the Invoice Number and Date should be provided where possible. This supports + customs processing in certain circumstances. + maxLength: 35 + type: string + example: "1234567890" + InvoiceDate: + format: date-time + description: Commercial Invoice Date - YYYY-MM-DD.
Required when a commercial + invoice number is provided.
Ignored if no Invoice Number provided. + type: string + example: "2020-12-31" + ExportLicence: + description: Export Licence Required.
Customers exporting items requiring + an export licence must flag the item as requiring an export licence here. + This requirement is restricted to exporters of specific type of goods used + predominantly for military purposes, as such will probably not apply to + you. You can find out more about the type of items requiring an export licence + on the UK Government website.

If an export licence is required, + it should be affixed to the outside of your parcel. + type: boolean + example: false + AddresseeIdentificationReferenceNumber: + description: Addressee Identification Reference Number (previously "recipients + purchasing ID").
Recipient Purchasing IDs for International Shipments. +
A small number of countries require their citizens to obtain a registration + number before importing goods from overseas. When exporting items to countries + with such a scheme in place there is a requirement to provide the recipients + registration details to customs authorities. + maxLength: 20 + type: string + example: "1234567890" + xml: + name: CustomsInformation + CreateShipment.ServiceOptions: + description: The Service Options for a Royal Mail Shipment, used in a shipment + request.
Required if have more than 1 possible Posting Location. + required: + - PostingLocation + type: object + properties: + PostingLocation: + description: Posting Location.
Optional if you only have 1 Posting Location. + maxLength: 10 + minLength: 10 + type: string + example: "123456789" + ServiceLevel: + description: Service Level
Valid values are 01-99.
Defaults to lowest + service level if not provided. + maxLength: 2 + minLength: 2 + type: string + example: "01" + ServiceFormat: + description: Service Format

**L** - Letter
**F** + - Large Letter
**P** - Parcel
**S** - Printed Papers - International + Services Only + enum: + - L + - F + - P + - S + type: string + example: P + Safeplace: + description: Safe Place Enhancement
Free text to describe a safe place + to leave the parcel.
Returns an error if the service does not allow + Safeplace. + maxLength: 30 + type: string + example: Front Porch + SaturdayGuaranteed: + description: Saturday Guaranteed Enhancement
Available for Domestic Special + Delivery Services Only
Returns an error if requested and the service + does not allow it. + type: boolean + example: false + ConsequentialLoss: + description: Consequential Loss Enhancement
Available for Domestic Special + Delivery Services Only.

**Level1** - ??1,000
**Level2** + - ??2,500
**Level3** - ??5,000
**Level4** - ??7,500
**Level5** + - ??10,000

Returns an error if requested and the + service does not allow it. + enum: + - Level1 + - Level2 + - Level3 + - Level4 + - Level5 + type: string + LocalCollect: + description: Local Collect Enhancement
Available for Domestic Special + Delivery and Domestic Tracked services only.
Returns an error if requested + and the service does not allow it. + type: boolean + example: false + TrackingNotifications: + description: Tracking Notifications Enhancement
Available for Domestic + Special Delivery and Domestic Tracked services.
The Email notification + enhancement is also available for International Tracked and International + Tracked and Signed services.
Returns an error if requested and the + service does not allow it. + enum: + - Email + - SMS + - EmailAndSMS + type: string + RecordedSignedFor: + description: Recorded Signed For
Available for all Domestic Services + that are not Special Delivery, Tracked or BFPO.
This is an enhancement + for services that don't have an in-built signature service like Special + Delivery and Tracked.
Returns an error if requested and the service + does not allow it. + type: boolean + example: false + xml: + name: ServiceOptions + CreateShipment.ShipmentPackage: + description: Details of a package in a shipment request.
Enter the dimensions + and weight of the package in the shipment. Use the PackageOccurance to indicate + the items within the package. + required: + - PackageOccurrence + - Weight + type: object + properties: + PackageOccurrence: + format: int32 + description: Package Occurrence
Unique package number within this shipment.
Cannot exceed total number of packages. + maximum: 9 + minimum: 1 + type: integer + example: 1 + PackagingId: + description: Packaging ID
If supplied, packaging details will be populated + from the stored information. + maxLength: 70 + type: string + example: UNIQUEID123 + Weight: + format: double + description: 'Total Package Weight.

This field will + be used as the Shipment Weight for single-package services such as RMG.
The package weight must be greater than or equal to the sum of all item + weights and packaging, if this information is provided.
Min weight: + 1 gram.
*Optional/Overwritten for Average Weight Services - Average + Weight Customers only.*' + type: number + example: 2.200000 + Length: + format: double + description: Package Length
Dimensions are in Centimetres.
*Dimensions + are optional, however supplying accurate information helps ensure a smooth + delivery experience.* + maximum: 250 + minimum: 0.010000 + type: number + example: 15 + Width: + format: double + description: Package Width
Dimensions are in Centimetres.
*Dimensions + are optional, however supplying accurate information helps ensure a smooth + delivery experience.* + maximum: 250 + minimum: 0.010000 + type: number + example: 15 + Height: + format: double + description: Package Height
Dimensions are in Centimetres.
*Dimensions + are optional, however supplying accurate information helps ensure a smooth + delivery experience.* + maximum: 250 + minimum: 0.010000 + type: number + example: 5 + xml: + name: ShipmentPackage + ShipmentItem: + description: Details of an item in a shipment request, including what package + it is in if possible. + required: + - Quantity + type: object + properties: + ItemId: + description: Item ID
If supplied all item fields except Item Quantity + will be populated from the stored item record. + maxLength: 70 + type: string + example: UNIQUEID123 + Quantity: + format: int32 + description: Item Quantity
The quantity of items of this type. + type: integer + example: 2 + Description: + description: Item Description
Required if an Item Id is not supplied. + maxLength: 255 + type: string + example: White Tee-shirt + Value: + format: double + description: Item Value
Individual item value (use same currency as shipment + currency).
Required if an Item Id is not supplied. + maximum: 100000000 + minimum: 0.010000 + type: number + example: 19.990000 + Weight: + format: double + description: Item Weight
Individual item weight. + maximum: 9999.999000 + minimum: 0.001000 + type: number + example: 0.900000 + PackageOccurrence: + format: int32 + description: Package Occurrence
Optional Package Occurrence used to indicate + which package the item has been packed into. + maximum: 9 + minimum: 1 + type: integer + example: 1 + HsCode: + description: HS Code
The [standardised commodity code](https://www.gov.uk/trade-tariff). + It must be 6-12 digits only.
Used by Customs to calculate potential + duties / taxes. + type: string + example: "652534" + SkuCode: + description: SKU Code.
Used by Customs to calculate potential duties + / taxes. + maxLength: 30 + type: string + example: SKU3455692 + CountryOfOrigin: + description: Country of Origin
[ISO Alpha-2 Country Code](https://www.nationsonline.org/oneworld/country_code_list.htm) + of item country of origin, per ISO 3166 Standard + type: string + example: CN + ImageUrl: + description: Image URL
Used to save a link to an image of the item with + the shipment details, so that this can be used in the Returns
system + for consumers to see an image of the item when selecting items for return.
URL must be a publicly accessible image. + maxLength: 1000 + type: string + example: http://www.myimagestore.com/myimage.jpg + xml: + name: ShipmentItem + ShipmentCreateResponse: + description: Response from a create shipment request + required: + - HttpStatusCode + - HttpStatusDescription + type: object + properties: + ConsignmentNumber: + description: Consignment Number
Only populated for services that support + Multi-Packages + maxLength: 21 + type: string + example: FD345678932GB + ConsignmentTrackingUrl: + description: Consignment Tracking URL
Only populated for services that + support Multi-Packages + maxLength: 250 + type: string + example: http://carrier.website.com/tracking?number=FD345678932GB + Packages: + description: Packages
Details each package tracking information and Unique + Id. + type: array + items: + $ref: '#/definitions/PackageResponse' + xml: + name: Packages + wrapped: true + Routing: + $ref: '#/definitions/Routing' + description: Routing information + LabelImageFormat: + description: Label Image Format + enum: + - PDF + - PNG + - DATASTREAM + - ZPL203DPI + - ZPL300DPI + type: string + LabelImages: + description: Label Images
Any labels that have been created as a result + of the request.
Depends on Label Image Format.

**PDF**
Base 64 encoded PDF

**PNG**
Base + 64 encoded PNG

**ZPL 300 / 203 dpi**
Base 64 + encoded PRN (text file)

**Data stream**
Not + Included - see Packages for Data Stream responses + type: string + example: AxLjUwLjQwMDAtZ2RpIFwod3d3LnBkZnNoY ... XJwLmNvbVwpKQovUHJvZHVjZXIoUERG + CustomsDocuments: + description: Customs Documents
Any customs documents that have been created + as a result of the request.
Depends on Label Image Format.

**PDF**
Base 64 encoded PDF

**PNG**
Base + 64 encoded PNG

**ZPL 300 / 203 dpi**
Base 64 + encoded PRN (text file)

**Data stream**
Not + Included - see Packages for Data Stream responses + type: string + example: AxLjUwLjQwMDAtZ2RpIFwod3d3LnBkZnNoY ... XJwLmNvbVwpKQovUHJvZHVjZXIoUERG + ReturnLabelImageFormat: + description: Return Label Image Format + enum: + - PDF + - PNG + - ZPL300DPI + - ZPL203DPI + type: string + ReturnLabelImages: + description: Return Label Images
Any return labels that have been created + as a result of the request and label option settings.
Depends on ReturnLabelImageFormat.

**PDF**
Base 64 encoded PDF

**PNG**
Base 64 encoded PNG

**ZPL 300 / 203 + dpi**
Base 64 encoded PRN (text file) + type: string + example: AxLjUwLjQwMDAtZ2RpIFwod3d3LnBkZnNoY ... XJwLmNvbVwpKQovUHJvZHVjZXIoUERG + HttpStatusCode: + format: int32 + description: HTTP Status Code + type: integer + example: 200 + HttpStatusDescription: + description: HTTP Status Description + type: string + example: OK + Message: + description: Message
Successful response may include a success message.
Failure responses will have general reason as to why. Further details + may be contained in the list of errors. + type: string + example: Your item has been created/updated successfully + Errors: + description: Errors
Details about why a request failed. + type: array + items: + $ref: '#/definitions/ErrorDetail' + xml: + name: Errors + wrapped: true + xml: + name: ShipmentCreateResponse + PackageResponse: + description: Individual Package Response within a Shipment Response.
Every + successful response will have one of these per package request. + required: + - PackageOccurance + type: object + properties: + PackageOccurance: + format: int32 + description: Package Occurence
Unique package number within this shipment + maximum: 15 + minimum: 1 + type: integer + example: "1" + UniqueId: + description: Unique Shipment ID
All shipments are assigned a unique Shipment + ID. + maxLength: 21 + minLength: 21 + type: string + example: 3A01234561234568AE7C7 + TrackingNumber: + description: Shipment Tracking Number
Final Mile carrier tracking number.
Only populated for services that support tracking numbers. + maxLength: 13 + minLength: 13 + type: string + example: HF123456783GB + TrackingUrl: + description: Tracking URL
Final Mile Tracking, if available. + maxLength: 250 + type: string + example: http://carrier.website.com/tracking?number=HF123456783GB + CarrierCode: + description: Carrier Code
The allocated carrier. + maxLength: 4 + type: string + example: RMG + Primary2DBarcodeImage: + description: Primary 2D Barcode Image
Only populated for Data Stream + response.
Base64 Encoded PNG Image of the 2D data matrix barcode. + type: string + example: iVBORw0KGgoAAAANSUhE ... UgAAAGgAAABoAQMAAAAn0ifiAAAA + Primary2DBarcodeData: + description: Primary 2D Barcode Data - Base 64 Encoded
Only populated + for Data Stream response.
Data required to create your own 2D data + matrix barcode. Please decode before use. + type: string + example: iVBORw0KGgoAAAANSUhE ... UgAAAGgAAABoAQMAAAAn0ifiAAAA + FormattedUniqueId: + description: Formatted Unique Id
Only populated for Data Stream response.
Label for 2D data matrix barcode. + type: string + example: 3A-070 338 6001-000 0B2 000 + HighVolumeBarcodeData: + description: High Volume Barcode Data
Only populated for Data Stream + response where the service requires the barcode on the label.
Data + required to create your own High Volume barcode. + type: string + example: '*SW115QZ*' + HighVolumeBarcodeImage: + description: High Volume Barcode Image
Only populated for Data Stream + response where the service requires the barcode on the label.
Base64 + Encoded PNG Image of the High Volume barcode. + type: string + example: iVBORw0KGgoAAAANSUhE ... UgAAAGgAAABoAQMAAAAn0ifiAAAA + HighVolumeSortCode: + description: High Volume Sort Code
Only populated for Data Stream response + where the service requires the sort code on the label. + type: string + example: Q26 + Primary1DBarcodeData: + description: Primary 1D Barcode Data
Only populated for Data Stream response + where the service requires the barcode on the label.
Data required + to create your own 1D barcode. + type: string + example: HF123456783GB + Primary1DBarcodeImage: + description: Primary 1D Barcode Image
Only populated for Data Stream + response where the service requires the barcode on the label.
Base64 + Encoded PNG Image of the 1D barcode. + type: string + example: iVBORw0KGgoAAAANSUhE ... UgAAAGgAAABoAQMAAAAn0ifiAAAA + xml: + name: PackageResponse + ServiceAvailability.Shipment: + description: Details of a shipment for a service availability check. + required: + - Destination + - ShipmentInformation + type: object + properties: + Destination: + $ref: '#/definitions/ServiceAvailability.Destination' + description: The Destination
Where the parcel is going to. + ShipmentInformation: + $ref: '#/definitions/ServiceAvailability.ShipmentInformation' + description: Shipment Information
Overall package details and requested + service requirements. + xml: + name: Shipment + ServiceAvailability.Destination: + description: The Destination
Where the parcel is going to. + type: object + properties: + AddressId: + description: Destination Address ID
If supplied all destination address + fields will be ignored and the stored address will be used. + maxLength: 70 + type: string + example: UNIQUEID123 + Town: + description: Town
Required if Address Id is not provided. + maxLength: 35 + type: string + example: Leatherhead + CountryCode: + description: Country Code
[ISO Alpha-2 Country Code](https://www.nationsonline.org/oneworld/country_code_list.htm) per + ISO 3166 Standard. Required if Address Id is not provided + maxLength: 2 + minLength: 2 + type: string + example: GB + Postcode: + description: Postcode / Zip
Mandatory for all domestic destinations and + some international destinations if the Address Id is not provided. + maxLength: 10 + type: string + example: AB3 5CD + xml: + name: Destination + ServiceAvailability.ShipmentInformation: + description: Shipment Information
Overall package details and requested service + requirements. + required: + - TotalPackages + - TotalWeight + type: object + properties: + ServiceCode: + description: Service Code
Must be a valid system service code OR a customer + mapped service code.
If service code is not supplied a list of all + available service options will be returned, otherwise only information about + the service requested will be returned. + maxLength: 10 + type: string + example: TPLN + ServiceOptions: + $ref: '#/definitions/ServiceAvailability.ServiceOptions' + description: Service Options
Specify any service requirements such as + format required or enhancements required. + TotalPackages: + format: int32 + description: Number of Packages
The total number of packages. + maximum: 9 + minimum: 1 + type: integer + example: 1 + TotalWeight: + format: double + description: 'Total Weight
The total weight of the shipment including + packaging. Validated againt package weight.
Min weight: 1 gram.' + type: number + example: 2.200000 + WeightUnitOfMeasure: + description: Weight Unit of Measure + default: KG + enum: + - KG + - Grams + type: string + Product: + description: Shipment/Product type being shipped

**DOX** + - Documents Only
**NDX** - All other shipment product types + default: NDX + enum: + - NDX + - DOX + type: string + Value: + format: double + description: Total Shipment Value
Required for Non-Document International + and BFPO Shipments.
Ignored for Documents Only shipments. + maximum: 100000000 + minimum: 0.010000 + type: number + example: 39.980000 + Currency: + description: Currency
This currency will be used for all values across + the shipment request.
3 digit ISO Currency Code.
Required for + Non-Document International and BFPO Shipments, or when value is provided.
Ignored for Documents Only shipments. + maxLength: 3 + minLength: 3 + type: string + example: GBP + Packages: + description: Shipment Packages
The packages in the shipment.
Required + if TotalPackages is more than 1. + type: array + items: + $ref: '#/definitions/ServiceAvailability.ShipmentPackage' + xml: + name: Packages + wrapped: true + xml: + name: ShipmentInformation + ServiceAvailability.ServiceOptions: + description: Service Options
Specify any service requirements such as format + required or enhancements required. + type: object + properties: + ServiceFormat: + description: Service Format
If provided, only return services that support + the given service format.

**L** - Letter
**F** + - Large Letter
**P** - Parcel
**S** - Printed Papers - International + Services Only + enum: + - L + - F + - P + - S + type: string + example: P + Tracked: + description: Tracked Services
If true, only return Tracked Services. + type: boolean + example: false + SignatureRequired: + description: Signature Required
If true, only return services that are + either with signature or support the Recorded Signed For enhancement. + type: boolean + example: false + Safeplace: + description: Safe Place Enhancement
If true, only return services that + support the Safe Place enhancement. + type: boolean + example: false + LocalCollect: + description: Local Collect Enhancement
If true, only return services + that support the Local Collect enhancement. + type: boolean + example: false + SaturdayGuaranteed: + description: Saturday Guaranteed Enhancement
If true, only return services + that support the Saturday Guaranteed enhancement. + type: boolean + example: false + ConsequentialLoss: + description: Consequential Loss Enhancement
If true, only return services + that support the Consequential Loss enhancement. + type: boolean + example: false + xml: + name: ServiceOptions + ServiceAvailability.ShipmentPackage: + description: Details of a package in a shipment request.
Enter the dimensions + and weight of the package in the shipment. Use the PackageOccurance to indicate + the items within the package. + required: + - PackageOccurrence + - Weight + type: object + properties: + PackageOccurrence: + format: int32 + description: Package Occurrence
Unique package number within this shipment.
Cannot exceed total number of packages. + maximum: 9 + minimum: 1 + type: integer + example: 1 + PackagingId: + description: Packaging ID
If supplied, packaging details will be populated + from the stored information. + maxLength: 70 + type: string + example: UNIQUEID123 + Weight: + format: double + description: 'Total Package Weight.

This field will + be used as the Shipment Weight for single-package services such as RMG.
The package weight must be greater than or equal to the sum of all item + weights and packaging, if this information is provided.
Min weight: + 1 gram.' + type: number + example: 2.200000 + Length: + format: double + description: Package Length
Dimensions are in Centimetres.
*Dimensions + are optional, however supplying accurate information helps ensure a smooth + delivery experience.* + maximum: 250 + minimum: 0.010000 + type: number + example: 15 + Width: + format: double + description: Package Width
Dimensions are in Centimetres.
*Dimensions + are optional, however supplying accurate information helps ensure a smooth + delivery experience.* + maximum: 250 + minimum: 0.010000 + type: number + example: 15 + Height: + format: double + description: Package Height
Dimensions are in Centimetres.
*Dimensions + are optional, however supplying accurate information helps ensure a smooth + delivery experience.* + maximum: 250 + minimum: 0.010000 + type: number + example: 5 + xml: + name: ShipmentPackage + ServiceAvailabilityResponse: + description: Response from a Service Availabilty Request + required: + - HttpStatusCode + - HttpStatusDescription + type: object + properties: + WeightUnitOfMeasure: + description: Weight Unit of Measure
The unit of measure used for the + Max Weights.
Will be the same as the Weight Unit of Measure received. + enum: + - KG + - Grams + type: string + Options: + description: Service Options
The available service options that can be + used for the details provided.
Populated for successful responses only. + type: array + items: + $ref: '#/definitions/ServiceAvailability.Option' + xml: + name: Options + wrapped: true + HttpStatusCode: + format: int32 + description: HTTP Status Code + type: integer + example: 200 + HttpStatusDescription: + description: HTTP Status Description + type: string + example: OK + Message: + description: Message
Successful response may include a success message.
Failure responses will have general reason as to why. Further details + may be contained in the list of errors. + type: string + example: Your item has been created/updated successfully + Errors: + description: Errors
Details about why a request failed. + type: array + items: + $ref: '#/definitions/ErrorDetail' + xml: + name: Errors + wrapped: true + xml: + name: ServiceAvailabilityResponse + ServiceAvailability.Option: + description: An available service option based on your request. + required: + - ServiceCode + - ServiceName + - TransitDays + - IsTracked + - SignatureIncluded + - RecordedSignedForAvailable + - SafeplaceAvailable + - LocalCollectAvailable + - SaturdayGuaranteedAvailable + - ConsequentialLossAvailable + - FormatsAvailable + type: object + properties: + ServiceCode: + description: Service Code
Customer Mapped Service Code or System Service + Code for this service. + maxLength: 10 + type: string + example: OTA + ServiceName: + description: Service Name + type: string + example: International Tracked On Account + TransitDays: + format: int32 + description: Estimated Transit Days + type: integer + example: 4 + IsTracked: + description: Is Tracked
If true, the service is a tracked service. + type: boolean + example: true + SignatureIncluded: + description: Signature Included
If true, a signature required on delivery + is included with the service. + type: boolean + example: false + RecordedSignedForAvailable: + description: Recorded Signed For Enhancement Available
If true, the recorded + signed for enhancement can be used with this service. + type: boolean + example: false + SafeplaceAvailable: + description: Safe Place Enhancement Available
If true, the safe place + enhancement can be used with this service. + type: boolean + example: false + LocalCollectAvailable: + description: Local Collect Enhancement Available
If true, the local collect + enhancement can be used with this service. + type: boolean + example: false + SaturdayGuaranteedAvailable: + description: Saturday Guaranteed Enhancement Available
If true, the saturday + guaranteed enhancement can be used with this service. + type: boolean + example: false + ConsequentialLossAvailable: + description: Consequential Loss Enhancement Available
If true, the consequential + loss enhancement can be used with this service. + type: boolean + example: false + FormatsAvailable: + description: Formats Available
All formats that are available for this + service for the given weight, including the maximum weight possible for + each format. + type: array + items: + $ref: '#/definitions/ServiceAvailability.Format' + xml: + name: FormatsAvailable + wrapped: true + xml: + name: Option + ServiceAvailability.Format: + description: Available Format for a service, with the maximum possible weight + allowed. + required: + - FormatDescription + - MaxWeight + type: object + properties: + ServiceFormat: + description: Service Format
An available service format for this service.
If blank, then formats are not applicable for this service.

**L** - Letter
**F** - Large Letter
**P** - Parcel
**S** + - Printed Papers
**Blank** - Not Applicable + enum: + - L + - F + - P + - S + type: string + FormatDescription: + description: Format Description
A description of the Service Format

Letter
Large Letter
Parcel
International + Printed Papaers
Not Applicable + type: string + MaxWeight: + format: double + description: Maximum Weight
The maximum weight allowed for this format + (or service if formats not applicable) in specified Unit of Measure. + type: number + example: 0.750000 + xml: + name: Format + ManifestRequest: + description: A request to manifest all shipments ready to manifest for a single + posting location. + required: + - PostingLocation + type: object + properties: + PostingLocation: + description: Posting Location.
Optional if you only have 1 Posting Location. + maxLength: 10 + minLength: 10 + type: string + example: "123456789" + xml: + name: ManifestRequest + ManifestResponse: + description: Response from a create manifest request + required: + - PostingLocation + - HttpStatusCode + - HttpStatusDescription + type: object + properties: + PostingLocation: + description: Posting Location.
The Posting Location manifested + maxLength: 10 + minLength: 10 + type: string + example: "123456789" + Manifests: + description: The Created Manifests
Only populated if the request was + successful. + type: array + items: + $ref: '#/definitions/Manifest' + xml: + name: Manifests + wrapped: true + HttpStatusCode: + format: int32 + description: HTTP Status Code + type: integer + example: 200 + HttpStatusDescription: + description: HTTP Status Description + type: string + example: OK + Message: + description: Message
Successful response may include a success message.
Failure responses will have general reason as to why. Further details + may be contained in the list of errors. + type: string + example: Your item has been created/updated successfully + Errors: + description: Errors
Details about why a request failed. + type: array + items: + $ref: '#/definitions/ErrorDetail' + xml: + name: Errors + wrapped: true + xml: + name: ManifestResponse + Manifest: + description: Details of a Manifest that is returned when manifests are successfully + created. + type: object + properties: + ManifestNumber: + description: Manifest Number + maxLength: 18 + type: string + example: INT1810002000 + ManifestImage: + description: Manifest Image
A base 64 encoded string of the manifest + PDF. + type: string + example: JVBERi0xLjQKJdP0zOEKMSAwIG9 ... iago8PAovQ3JlYXRpb25EYXRlKEQ6MjAxODA5MjcxM + CarrierCode: + description: Carrier Code
The carrier that this manifest is for. + maxLength: 4 + type: string + example: RMG + ServiceCode: + description: Service Code
The service included in this Manifest. If more + than one, Mixed will be returned. + maxLength: 10 + type: string + example: Mixed + TotalWeight: + format: double + description: Total Weight
Sum of the weight of all the packages included + on the Manifest in KGs. + type: number + example: 2.560000 + TotalPackages: + format: int32 + description: Total Packages
The total number of packages included on + the Manifest. + type: integer + example: 54 + xml: + name: Manifest + ManifestCarrierCodesRequest: + description: A request to manifest shipments created with the given carrier codes + that are ready to manifest for a single posting location. + required: + - CarrierCodes + - PostingLocation + type: object + properties: + CarrierCodes: + description: Carrier Codes
Must be valid system carrier codes. + maxLength: 4 + type: array + items: + type: string + xml: + name: CarrierCode + xml: + name: CarrierCodes + wrapped: true + example: + - RMG + - PFCE + PostingLocation: + description: Posting Location.
Optional if you only have 1 Posting Location. + maxLength: 10 + minLength: 10 + type: string + example: "123456789" + xml: + name: ManifestCarrierCodesRequest + ManifestServiceCodesRequest: + description: A request to manifest shipments created with the given service codes + that are ready to manifest for a single posting location. + required: + - ServiceCodes + - PostingLocation + type: object + properties: + ServiceCodes: + description: Service Codes
Must be valid system service codes OR customer + mapped service codes. + maxLength: 10 + type: array + items: + type: string + xml: + name: ServiceCode + xml: + name: ServiceCodes + wrapped: true + example: + - CRL1 + - CRL2 + PostingLocation: + description: Posting Location.
Optional if you only have 1 Posting Location. + maxLength: 10 + minLength: 10 + type: string + example: "123456789" + xml: + name: ManifestServiceCodesRequest + Address: + description: An address that is part of the address book.
A stored address + can be used in shipment requests. + required: + - IsReturnAddress + - ContactName + - AddressLine1 + - Town + - CountryCode + type: object + properties: + AddressId: + description: Address ID
Your unique identifier for this address.
If + not provided, a GUID will be generated. + maxLength: 70 + type: string + example: UNIQUEID123 + IsReturnAddress: + description: Is Return Address
If true, then this address is also available + as a return address. + type: boolean + example: false + CompanyName: + description: Company Name
*Ignored if is a return address* + maxLength: 35 + type: string + example: Company & Co. + ContactName: + description: Contact Name / Return Name + maxLength: 40 + type: string + example: John Smith + AddressLine1: + description: Address Line 1 + maxLength: 35 + type: string + example: Brown Cottage + AddressLine2: + description: Address Line 2 + maxLength: 35 + type: string + example: 10 Sky Lane + AddressLine3: + description: Address Line 3 + maxLength: 35 + type: string + example: Branton + Town: + description: Town + maxLength: 35 + type: string + example: Leatherhead + County: + description: County / State / Province
Conditional dependent on country.
USA, Australia and Canada all require a valid state code or name. + type: string + example: Surrey + CountryCode: + description: Country Code
[ISO Alpha-2 Country Code](https://www.nationsonline.org/oneworld/country_code_list.htm) + per ISO 3166 Standard
*Required to be GB if is a return address* + maxLength: 2 + minLength: 2 + type: string + example: GB + Postcode: + description: Postcode / Zip
Required for domestic addresses and some + international addresses. + maxLength: 10 + type: string + example: TW20 0HJ + PhoneNumber: + description: Contact Phone Number
Required for destination addresses + where SMS notifications are requested.
(Service Enhancement Code 13 + or 16)
*Ignored if is a return address* + maxLength: 20 + type: string + example: "7723456789" + EmailAddress: + description: Contact Email Address
Required for destination addresses + where email notifications are requested.
(Service Enhancement Code + 14 or 16)
*Ignored if is a Return Address* + maxLength: 254 + type: string + example: email@example.com + VatNumber: + description: VAT Number
*Ignored if is a return address* + maxLength: 20 + type: string + example: GB123 4567 89 + Safeplace: + description: Safeplace
Free text to describe a safe place to leave the + parcel if the service allows it.
*Ignored if is a return address* + maxLength: 30 + type: string + example: Front Porch + xml: + name: Address + AddressResponse: + description: Response from a create / update or delete address request. + required: + - HttpStatusCode + - HttpStatusDescription + type: object + properties: + AddressId: + description: Address Id
The Id of the Address involved in the request, + or in the case of create, the created Id, if not provided. + maxLength: 70 + type: string + example: UNIQUEID123 + HttpStatusCode: + format: int32 + description: HTTP Status Code + type: integer + example: 200 + HttpStatusDescription: + description: HTTP Status Description + type: string + example: OK + Message: + description: Message
Successful response may include a success message.
Failure responses will have general reason as to why. Further details + may be contained in the list of errors. + type: string + example: Your item has been created/updated successfully + Errors: + description: Errors
Details about why a request failed. + type: array + items: + $ref: '#/definitions/ErrorDetail' + xml: + name: Errors + wrapped: true + xml: + name: AddressResponse + Item: + description: An Item that is stored for use in shipment requests. + required: + - Description + - Value + - Currency + type: object + properties: + ItemId: + description: Unique ID
Your unique identifier for this item.
If + not provided, a GUID will be generated. + maxLength: 70 + type: string + example: UNIQUEID123 + Description: + description: Item Description + maxLength: 70 + type: string + example: White Tee-shirt + Value: + format: double + description: Item Value + maximum: 99999999.990000 + minimum: 0.010000 + type: number + example: 19.990000 + Currency: + description: Currency
3 digit ISO Currency Code + maxLength: 3 + minLength: 3 + type: string + example: GBP + Weight: + format: double + description: 'Item Weight
The weight of this item.
Min weight: 1 + gram.' + maximum: 9999.999000 + minimum: 0.001000 + type: number + example: 0.432000 + WeightUnitOfMeasure: + description: Weight Unit of Measure
If using Grams, minimum weight is + 1 and partial numbers will be ignored. + default: KG + enum: + - KG + - Grams + type: string + HsCode: + description: HS Code
The [standardised commodity code](https://www.gov.uk/trade-tariff). + It must be 6-12 digits only.
Used by Customs to calculate potential + duties / taxes. + type: string + example: "652534" + SkuCode: + description: SKU Code.
Used by Customs to calculate potential duties + / taxes. + maxLength: 30 + type: string + example: SKU3455692 + CountryOfOrigin: + description: Country of Origin
[ISO Alpha-2 Country Code](https://www.nationsonline.org/oneworld/country_code_list.htm) + of item country of origin, per ISO 3166 Standard + type: string + example: CN + ImageUrl: + description: Image URL
Used to save a link to an image of the item with + the shipment details, so that this can be used in the Returns
system + for consumers to see an image of the item when selecting items for return.
URL must be a publicly accessible image. + maxLength: 1000 + type: string + example: http://www.myimagestore.com/myimage.jpg + xml: + name: Item + ItemResponse: + description: Response from a delete item request. + required: + - HttpStatusCode + - HttpStatusDescription + type: object + properties: + ItemId: + description: Item Id
The Id of the Item involved in the request, or in + the case of create, the created Id, if not provided. + maxLength: 70 + type: string + example: UNIQUEID123 + HttpStatusCode: + format: int32 + description: HTTP Status Code + type: integer + example: 200 + HttpStatusDescription: + description: HTTP Status Description + type: string + example: OK + Message: + description: Message
Successful response may include a success message.
Failure responses will have general reason as to why. Further details + may be contained in the list of errors. + type: string + example: Your item has been created/updated successfully + Errors: + description: Errors
Details about why a request failed. + type: array + items: + $ref: '#/definitions/ErrorDetail' + xml: + name: Errors + wrapped: true + xml: + name: ItemResponse + Packaging: + description: Packaging details that are stored, to be used in shipment requests. + required: + - Name + - Length + - Width + - Height + type: object + properties: + PackagingId: + description: Packaging Unique ID
Your unique identifier for these packaging + details.
If not provided, a GUID will be generated. + maxLength: 70 + type: string + example: UNIQUEID123 + Name: + description: Name
The descriptive name of these packaging details + maxLength: 40 + type: string + example: Small Box + Weight: + format: double + description: 'Packaging Weight
The weight of this packaging.
Min + weight: 1 gram.' + maximum: 9999.999000 + minimum: 0.001000 + type: number + example: 0.008000 + WeightUnitOfMeasure: + description: Weight Unit of Measure + default: KG + enum: + - KG + - Grams + type: string + Length: + format: double + description: Packaging Length
The length of this packaging in CM + maximum: 250 + minimum: 0.010000 + type: number + example: 15 + Width: + format: double + description: Packaging Width
The width of this packaging in CM + maximum: 250 + minimum: 0.010000 + type: number + example: 15 + Height: + format: double + description: Packaging Height
The height of this packaging in CM + maximum: 250 + minimum: 0.010000 + type: number + example: 5 + xml: + name: Packaging + PackagingResponse: + description: Response from a delete packaging details request. + required: + - HttpStatusCode + - HttpStatusDescription + type: object + properties: + PackagingId: + description: Packaging Id
The Id of the Packaging Details involved in + the request. + maxLength: 70 + type: string + example: UNIQUEID123 + HttpStatusCode: + format: int32 + description: HTTP Status Code + type: integer + example: 200 + HttpStatusDescription: + description: HTTP Status Description + type: string + example: OK + Message: + description: Message
Successful response may include a success message.
Failure responses will have general reason as to why. Further details + may be contained in the list of errors. + type: string + example: Your item has been created/updated successfully + Errors: + description: Errors
Details about why a request failed. + type: array + items: + $ref: '#/definitions/ErrorDetail' + xml: + name: Errors + wrapped: true + xml: + name: PackagingResponse +x-ibm-configuration: + enforced: true + testable: true + phase: realized +security: +- clientID: [] +securityDefinitions: + clientID: + type: apiKey + description: Client ID + in: header + name: X-IBM-Client-Id + clientSecret: + type: apiKey + description: Client Secret + in: header + name: X-IBM-Client-Secret +consumes: +- application/xml +- application/json +produces: +- application/xml +- application/json +parameters: + X-RMG-Auth-Token: + name: X-RMG-Auth-Token + type: string + required: true + in: header + description: Authorisation token required to invoke this operation. Can be retrieved + by invoking the **/token** operation. + X-RMG-Security-Username: + name: X-RMG-Security-Username + type: string + required: true + in: header + description: User Name + X-RMG-Security-Password: + name: X-RMG-Security-Password + type: string + required: true + in: header + description: Password in plain text +x-ibm-endpoints: +- endpointUrl: https://api.royalmail.net + description: Custom API Endpoint + type: + - production + - development +... diff --git a/docs/Api/AddressesApi.md b/docs/Api/AddressesApi.md index eb04b79..ed5168b 100644 --- a/docs/Api/AddressesApi.md +++ b/docs/Api/AddressesApi.md @@ -26,7 +26,7 @@ $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()-> // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-IBM-Client-Id', 'Bearer'); -$apiInstance = new RoyalMail\Shipping\Rest\ApiAddressesApi( +$apiInstance = new RoyalMail\Shipping\Rest\AddressesApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), @@ -82,7 +82,7 @@ $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()-> // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-IBM-Client-Id', 'Bearer'); -$apiInstance = new RoyalMail\Shipping\Rest\ApiAddressesApi( +$apiInstance = new RoyalMail\Shipping\Rest\AddressesApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), @@ -138,7 +138,7 @@ $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()-> // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-IBM-Client-Id', 'Bearer'); -$apiInstance = new RoyalMail\Shipping\Rest\ApiAddressesApi( +$apiInstance = new RoyalMail\Shipping\Rest\AddressesApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), @@ -194,7 +194,7 @@ $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()-> // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-IBM-Client-Id', 'Bearer'); -$apiInstance = new RoyalMail\Shipping\Rest\ApiAddressesApi( +$apiInstance = new RoyalMail\Shipping\Rest\AddressesApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), @@ -248,7 +248,7 @@ $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()-> // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-IBM-Client-Id', 'Bearer'); -$apiInstance = new RoyalMail\Shipping\Rest\ApiAddressesApi( +$apiInstance = new RoyalMail\Shipping\Rest\AddressesApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), diff --git a/docs/Api/ItemsApi.md b/docs/Api/ItemsApi.md index 2426550..7006cdc 100644 --- a/docs/Api/ItemsApi.md +++ b/docs/Api/ItemsApi.md @@ -26,7 +26,7 @@ $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()-> // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-IBM-Client-Id', 'Bearer'); -$apiInstance = new RoyalMail\Shipping\Rest\ApiItemsApi( +$apiInstance = new RoyalMail\Shipping\Rest\ItemsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), @@ -82,7 +82,7 @@ $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()-> // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-IBM-Client-Id', 'Bearer'); -$apiInstance = new RoyalMail\Shipping\Rest\ApiItemsApi( +$apiInstance = new RoyalMail\Shipping\Rest\ItemsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), @@ -138,7 +138,7 @@ $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()-> // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-IBM-Client-Id', 'Bearer'); -$apiInstance = new RoyalMail\Shipping\Rest\ApiItemsApi( +$apiInstance = new RoyalMail\Shipping\Rest\ItemsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), @@ -194,7 +194,7 @@ $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()-> // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-IBM-Client-Id', 'Bearer'); -$apiInstance = new RoyalMail\Shipping\Rest\ApiItemsApi( +$apiInstance = new RoyalMail\Shipping\Rest\ItemsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), @@ -248,7 +248,7 @@ $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()-> // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-IBM-Client-Id', 'Bearer'); -$apiInstance = new RoyalMail\Shipping\Rest\ApiItemsApi( +$apiInstance = new RoyalMail\Shipping\Rest\ItemsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), diff --git a/docs/Api/ManifestsApi.md b/docs/Api/ManifestsApi.md index 8388f42..9a4c1fc 100644 --- a/docs/Api/ManifestsApi.md +++ b/docs/Api/ManifestsApi.md @@ -24,7 +24,7 @@ $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()-> // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-IBM-Client-Id', 'Bearer'); -$apiInstance = new RoyalMail\Shipping\Rest\ApiManifestsApi( +$apiInstance = new RoyalMail\Shipping\Rest\ManifestsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), @@ -80,7 +80,7 @@ $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()-> // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-IBM-Client-Id', 'Bearer'); -$apiInstance = new RoyalMail\Shipping\Rest\ApiManifestsApi( +$apiInstance = new RoyalMail\Shipping\Rest\ManifestsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), @@ -136,7 +136,7 @@ $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()-> // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-IBM-Client-Id', 'Bearer'); -$apiInstance = new RoyalMail\Shipping\Rest\ApiManifestsApi( +$apiInstance = new RoyalMail\Shipping\Rest\ManifestsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), diff --git a/docs/Api/PackagingApi.md b/docs/Api/PackagingApi.md index 3971cff..da24de9 100644 --- a/docs/Api/PackagingApi.md +++ b/docs/Api/PackagingApi.md @@ -26,7 +26,7 @@ $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()-> // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-IBM-Client-Id', 'Bearer'); -$apiInstance = new RoyalMail\Shipping\Rest\ApiPackagingApi( +$apiInstance = new RoyalMail\Shipping\Rest\PackagingApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), @@ -82,7 +82,7 @@ $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()-> // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-IBM-Client-Id', 'Bearer'); -$apiInstance = new RoyalMail\Shipping\Rest\ApiPackagingApi( +$apiInstance = new RoyalMail\Shipping\Rest\PackagingApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), @@ -138,7 +138,7 @@ $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()-> // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-IBM-Client-Id', 'Bearer'); -$apiInstance = new RoyalMail\Shipping\Rest\ApiPackagingApi( +$apiInstance = new RoyalMail\Shipping\Rest\PackagingApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), @@ -194,7 +194,7 @@ $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()-> // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-IBM-Client-Id', 'Bearer'); -$apiInstance = new RoyalMail\Shipping\Rest\ApiPackagingApi( +$apiInstance = new RoyalMail\Shipping\Rest\PackagingApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), @@ -248,7 +248,7 @@ $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()-> // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-IBM-Client-Id', 'Bearer'); -$apiInstance = new RoyalMail\Shipping\Rest\ApiPackagingApi( +$apiInstance = new RoyalMail\Shipping\Rest\PackagingApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), diff --git a/docs/Api/ShipmentsApi.md b/docs/Api/ShipmentsApi.md index 025cda6..c5a15ae 100644 --- a/docs/Api/ShipmentsApi.md +++ b/docs/Api/ShipmentsApi.md @@ -29,7 +29,7 @@ $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()-> // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-IBM-Client-Id', 'Bearer'); -$apiInstance = new RoyalMail\Shipping\Rest\ApiShipmentsApi( +$apiInstance = new RoyalMail\Shipping\Rest\ShipmentsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), @@ -85,7 +85,7 @@ $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()-> // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-IBM-Client-Id', 'Bearer'); -$apiInstance = new RoyalMail\Shipping\Rest\ApiShipmentsApi( +$apiInstance = new RoyalMail\Shipping\Rest\ShipmentsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), @@ -141,7 +141,7 @@ $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()-> // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-IBM-Client-Id', 'Bearer'); -$apiInstance = new RoyalMail\Shipping\Rest\ApiShipmentsApi( +$apiInstance = new RoyalMail\Shipping\Rest\ShipmentsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), @@ -197,7 +197,7 @@ $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()-> // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-IBM-Client-Id', 'Bearer'); -$apiInstance = new RoyalMail\Shipping\Rest\ApiShipmentsApi( +$apiInstance = new RoyalMail\Shipping\Rest\ShipmentsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), @@ -253,7 +253,7 @@ $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()-> // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-IBM-Client-Id', 'Bearer'); -$apiInstance = new RoyalMail\Shipping\Rest\ApiShipmentsApi( +$apiInstance = new RoyalMail\Shipping\Rest\ShipmentsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), @@ -311,7 +311,7 @@ $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()-> // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-IBM-Client-Id', 'Bearer'); -$apiInstance = new RoyalMail\Shipping\Rest\ApiShipmentsApi( +$apiInstance = new RoyalMail\Shipping\Rest\ShipmentsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), @@ -369,7 +369,7 @@ $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()-> // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-IBM-Client-Id', 'Bearer'); -$apiInstance = new RoyalMail\Shipping\Rest\ApiShipmentsApi( +$apiInstance = new RoyalMail\Shipping\Rest\ShipmentsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), @@ -425,7 +425,7 @@ $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()-> // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-IBM-Client-Id', 'Bearer'); -$apiInstance = new RoyalMail\Shipping\Rest\ApiShipmentsApi( +$apiInstance = new RoyalMail\Shipping\Rest\ShipmentsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), diff --git a/docs/Api/TokenApi.md b/docs/Api/TokenApi.md index 0e33c45..3abe4d5 100644 --- a/docs/Api/TokenApi.md +++ b/docs/Api/TokenApi.md @@ -25,7 +25,7 @@ $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()-> // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = RoyalMail\Shipping\Rest\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-IBM-Client-Secret', 'Bearer'); -$apiInstance = new RoyalMail\Shipping\Rest\ApiTokenApi( +$apiInstance = new RoyalMail\Shipping\Rest\TokenApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), diff --git a/docs/Model/CreateShipmentCustomsInformation.md b/docs/Model/CreateShipmentCustomsInformation.md new file mode 100644 index 0000000..d7404ba --- /dev/null +++ b/docs/Model/CreateShipmentCustomsInformation.md @@ -0,0 +1,17 @@ +# CreateShipmentCustomsInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**preRegistrationNumber** | **string** | A pre-registration number is only relevant if the INCOTERMS (International Commercial Terms) for the shipment are DDP (Delivery duty paid).<br /><br />If not provided, and the INCOTERMS are set to DDP, any pre-registration numbers set up via your Customs Settings will be used. | [optional] +**preRegistrationType** | **string** | The type of pre-registration number provided above. <br />Required if a pre-registration number has been provided.<br />Ignored if there is no pre-registration number. | [optional] +**shippingCharges** | **double** | Shipping Charges for International Shipments.<br />The postage amount paid by your customer. The amount can be 0.00 if you have offered your customer free delivery. <br />Used for the calculation of customs fees.<br /><br />*The amount should be in the currency specified in the ShipmentInformation/Currency field.* | [optional] +**otherCharges** | **double** | Insurance and Other Costs for International Shipments.<br />If you have charged your customer an additional surcharge such as insurance, you must declare the amount here. <br />This field can be left blank, or be 0.00 if no other charges have been levied.<br /><br />*Any value should be in the currency specified in the ShipmentInformation/Currency field.* | [optional] +**quotedLandedCost** | **double** | Quoted Landed Cost<br />This will be the Value of Tax and Duties due to be paid for via the purchaser to the merchant relevant to international sales of goods.<br /><br />*Any value should be in the currency specified in the ShipmentInformation/Currency field.* | [optional] +**invoiceNumber** | **string** | Commercial Invoice Number for International Shipments.<br />When sending an item to an overseas address and a commercial invoice is available the Invoice Number and Date should be provided where possible. This supports customs processing in certain circumstances. | [optional] +**invoiceDate** | [**\DateTime**](\DateTime.md) | Commercial Invoice Date - YYYY-MM-DD.<br />Required when a commercial invoice number is provided.<br />Ignored if no Invoice Number provided. | [optional] +**exportLicence** | **bool** | Export Licence Required.<br />Customers exporting items requiring an export licence must flag the item as requiring an export licence here. This requirement is restricted to exporters of specific type of goods used predominantly for military purposes, as such will probably not apply to you. You can find out more about the type of items requiring an export licence on the UK Government website.<br /><br />If an export licence is required, it should be affixed to the outside of your parcel. | [optional] +**addresseeIdentificationReferenceNumber** | **string** | Addressee Identification Reference Number (previously \"recipients purchasing ID\").<br />Recipient Purchasing IDs for International Shipments. <br />A small number of countries require their citizens to obtain a registration number before importing goods from overseas. When exporting items to countries with such a scheme in place there is a requirement to provide the recipients registration details to customs authorities. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Model/CreateShipmentServiceOptions.md b/docs/Model/CreateShipmentServiceOptions.md index b755ee9..4c9996c 100644 --- a/docs/Model/CreateShipmentServiceOptions.md +++ b/docs/Model/CreateShipmentServiceOptions.md @@ -8,9 +8,9 @@ Name | Type | Description | Notes **serviceFormat** | **string** | Service Format<br /> <br />**L** - Letter<br />**F** - Large Letter<br />**P** - Parcel<br />**S** - Printed Papers - International Services Only | [optional] **safeplace** | **string** | Safe Place Enhancement<br />Free text to describe a safe place to leave the parcel.<br />Returns an error if the service does not allow Safeplace. | [optional] **saturdayGuaranteed** | **bool** | Saturday Guaranteed Enhancement<br />Available for Domestic Special Delivery Services Only<br />Returns an error if requested and the service does not allow it. | [optional] -**consequentialLoss** | **string** | Consequential Loss Enhancement<br />Available for Domestic Special Delivery Services Only.<br /> <br />**Level1** - £1,000<br />**Level2** - £2,500<br />**Level3** - £5,000<br />**Level4** - £7,500<br />**Level5** - £10,000<br /> <br />Returns an error if requested and the service does not allow it. | [optional] +**consequentialLoss** | **string** | Consequential Loss Enhancement<br />Available for Domestic Special Delivery Services Only.<br /> <br />**Level1** - ??1,000<br />**Level2** - ??2,500<br />**Level3** - ??5,000<br />**Level4** - ??7,500<br />**Level5** - ??10,000<br /> <br />Returns an error if requested and the service does not allow it. | [optional] **localCollect** | **bool** | Local Collect Enhancement<br />Available for Domestic Special Delivery and Domestic Tracked services only.<br />Returns an error if requested and the service does not allow it. | [optional] -**trackingNotifications** | **string** | Tracking Notifications Enhancement<br />Available for Domestic Special Delivery and Domestic Tracked services only.<br />Returns an error if requested and the service does not allow it. | [optional] +**trackingNotifications** | **string** | Tracking Notifications Enhancement<br />Available for Domestic Special Delivery and Domestic Tracked services.<br />The Email notification enhancement is also available for International Tracked and International Tracked and Signed services.<br />Returns an error if requested and the service does not allow it. | [optional] **recordedSignedFor** | **bool** | Recorded Signed For<br />Available for all Domestic Services that are not Special Delivery, Tracked or BFPO.<br />This is an enhancement for services that don't have an in-built signature service like Special Delivery and Tracked.<br />Returns an error if requested and the service does not allow it. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/CreateShipmentShipment.md b/docs/Model/CreateShipmentShipment.md index 8f4ee3f..21e3ee4 100644 --- a/docs/Model/CreateShipmentShipment.md +++ b/docs/Model/CreateShipmentShipment.md @@ -6,6 +6,7 @@ Name | Type | Description | Notes **shipper** | [**\RoyalMail\Shipping\Rest\Api\models\Shipper**](Shipper.md) | | [optional] **destination** | [**\RoyalMail\Shipping\Rest\Api\models\CreateShipmentDestination**](CreateShipmentDestination.md) | | **shipmentInformation** | [**\RoyalMail\Shipping\Rest\Api\models\CreateShipmentShipmentInformation**](CreateShipmentShipmentInformation.md) | | +**customsInformation** | [**\RoyalMail\Shipping\Rest\Api\models\CreateShipmentCustomsInformation**](CreateShipmentCustomsInformation.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/CreateShipmentShipmentInformation.md b/docs/Model/CreateShipmentShipmentInformation.md index b65cc58..507e227 100644 --- a/docs/Model/CreateShipmentShipmentInformation.md +++ b/docs/Model/CreateShipmentShipmentInformation.md @@ -13,7 +13,8 @@ Name | Type | Description | Notes **descriptionOfGoods** | **string** | Description of Goods<br />General description of the goods being sent.<br />Required for Non-Document International and BFPO Shipments.<br />Ignored for Documents Only shipments. | [optional] **reasonForExport** | **string** | Reason For Export<br />Required for International Shipments and BFPO (British Forces Post Office). | [optional] **value** | **double** | Total Shipment Value<br />Required for Non-Document International and BFPO Shipments.<br />Ignored for Documents Only shipments. | [optional] -**currency** | **string** | Currency<br />This currency will be used for all values across the shipment request.<br />3 digit ISO Currency Code.<br />Required for Non-Document International and BFPO Shipments, or when values are provided.<br />Ignored for Documents Only shipments. | [optional] +**currency** | **string** | Currency<br />This currency will be used for all values across the shipment request, including customs charges.<br />3 digit ISO Currency Code.<br />Required for Non-Document International and BFPO Shipments, or when values are provided.<br />Ignored for Documents Only shipments. | [optional] +**incoterms** | **string** | International Commercial Terms<br />Developed by International Chamber of Commerce and widely used in international and domestic contracts for the sale of goods.<br /><br /> **DDP** - Delivered Duty Paid.<br /> <br /> **DAT** - Delivered At Terminal.<br /> <br /> **DAP** - Delivered At Place.<br /> <br /> **DDU** - Delivered Duty Unpaid. | [optional] [default to 'DDU'] **labelFormat** | **string** | Requested Label Format<br />*DATASTREAM is only available if it has been activated on your account.*<br />Ignored if ShipmentAction set to Create or Allocate. | [optional] [default to 'PDF'] **silentPrintProfile** | **string** | Silent Print Profile<br />If present, resulting labels will be printed using this profile. | [optional] **shipmentAction** | **string** | Shipment Action<br /> <br />**Process** - Shipment created and processed, ready for manifesting. Label and tracking number returned.<br /> <br />**Create** - Shipment created as unprocessed, ready for scanning. Scanning will create label and tracking number and move shipment to processed.<br /> <br />**Allocate** - Shipment created as unprocessed with tracking number allocated and returned and label created but not returned. Scanning will return label and move shipment to processed. | [optional] [default to 'Process'] diff --git a/docs/Model/PrintLabelResponse.md b/docs/Model/PrintLabelResponse.md index dd65257..69fa494 100644 --- a/docs/Model/PrintLabelResponse.md +++ b/docs/Model/PrintLabelResponse.md @@ -20,6 +20,7 @@ Name | Type | Description | Notes **primary1DBarcodeImage** | **string** | Primary 1D Barcode Image<br />Only populated for Data Stream response where the service requires the barcode on the label.<br />Base64 Encoded PNG Image of the 1D barcode. | [optional] **returnLabelImageFormat** | **string** | Return Label Image Format | [optional] **returnLabelImage** | **string** | Return Label Image<br />Any return label that have been created as a result of the request and label option settings.<br />Depends on ReturnLabelImageFormat.<br /> <br />**PDF**<br />Base 64 encoded PDF<br /> <br />**PNG**<br />Base 64 encoded PNG<br /> <br />**ZPL 300 / 203 dpi**<br />Base 64 encoded PRN (text file) | [optional] +**routing** | [**\RoyalMail\Shipping\Rest\Api\models\Routing**](Routing.md) | | [optional] **httpStatusCode** | **int** | HTTP Status Code | **httpStatusDescription** | **string** | HTTP Status Description | **message** | **string** | Message<br />Successful response may include a success message.<br />Failure responses will have general reason as to why. Further details may be contained in the list of errors. | [optional] diff --git a/docs/Model/Routing.md b/docs/Model/Routing.md new file mode 100644 index 0000000..baf9f68 --- /dev/null +++ b/docs/Model/Routing.md @@ -0,0 +1,12 @@ +# Routing + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**inwardCode** | **string** | Inward Code<br />Only populated for Data Stream response where the service requires the Gazetteer codes on the label. | [optional] +**outwardCode** | **string** | Outward Code<br />Only populated for Data Stream response where the service requires the Gazetteer codes on the label. | [optional] +**walk** | **string** | Walk<br />Only populated for Data Stream response where the service requires the Gazetteer codes on the label. | [optional] +**loop** | **string** | Loop<br />Only populated for Data Stream response where the service requires the Gazetteer codes on the label. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Model/ShipmentCreateResponse.md b/docs/Model/ShipmentCreateResponse.md index 5fb8fc8..58d9900 100644 --- a/docs/Model/ShipmentCreateResponse.md +++ b/docs/Model/ShipmentCreateResponse.md @@ -6,9 +6,10 @@ Name | Type | Description | Notes **consignmentNumber** | **string** | Consignment Number<br />Only populated for services that support Multi-Packages | [optional] **consignmentTrackingUrl** | **string** | Consignment Tracking URL<br />Only populated for services that support Multi-Packages | [optional] **packages** | [**\RoyalMail\Shipping\Rest\Api\models\PackageResponse[]**](PackageResponse.md) | Packages<br />Details each package tracking information and Unique Id. | [optional] +**routing** | [**\RoyalMail\Shipping\Rest\Api\models\Routing**](Routing.md) | | [optional] **labelImageFormat** | **string** | Label Image Format | [optional] **labelImages** | **string** | Label Images<br />Any labels that have been created as a result of the request.<br />Depends on Label Image Format.<br /> <br />**PDF**<br />Base 64 encoded PDF<br /> <br />**PNG**<br />Base 64 encoded PNG<br /> <br />**ZPL 300 / 203 dpi**<br />Base 64 encoded PRN (text file)<br /> <br />**Data stream**<br />Not Included - see Packages for Data Stream responses | [optional] -**customsDocuments** | **string** | Customs Documents<br />Base 64 encoded PDF<br />Any customs documents that have been created as a result of the request. | [optional] +**customsDocuments** | **string** | Customs Documents<br />Any customs documents that have been created as a result of the request.<br />Depends on Label Image Format.<br /> <br />**PDF**<br />Base 64 encoded PDF<br /> <br />**PNG**<br />Base 64 encoded PNG<br /> <br />**ZPL 300 / 203 dpi**<br />Base 64 encoded PRN (text file)<br /> <br />**Data stream**<br />Not Included - see Packages for Data Stream responses | [optional] **returnLabelImageFormat** | **string** | Return Label Image Format | [optional] **returnLabelImages** | **string** | Return Label Images<br />Any return labels that have been created as a result of the request and label option settings.<br />Depends on ReturnLabelImageFormat.<br /> <br />**PDF**<br />Base 64 encoded PDF<br /> <br />**PNG**<br />Base 64 encoded PNG<br /> <br />**ZPL 300 / 203 dpi**<br />Base 64 encoded PRN (text file) | [optional] **httpStatusCode** | **int** | HTTP Status Code | diff --git a/docs/Model/ShipmentDeferRequest.md b/docs/Model/ShipmentDeferRequest.md index 512f372..06fe239 100644 --- a/docs/Model/ShipmentDeferRequest.md +++ b/docs/Model/ShipmentDeferRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **shipmentId** | **string** | Shipment Id<br />The tracking number or Unique Id of the shipment to defer. | -**shipmentDate** | [**\DateTime**](\DateTime.md) | Shipment Date<br />Date of despatch – YYYY-MM-DD<br />Cannot be in the past. Max 28 days in the future. | +**shipmentDate** | [**\DateTime**](\DateTime.md) | Shipment Date<br />Date of despatch ??? YYYY-MM-DD<br />Cannot be in the past. Max 28 days in the future. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Shipper.md b/docs/Model/Shipper.md index 3e96a41..a848d38 100644 --- a/docs/Model/Shipper.md +++ b/docs/Model/Shipper.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **addressId** | **string** | Shipper Address Id<br />If supplied all shipper address fields will be ignored and the address from the Address Book will be used. | [optional] **shipperReference** | **string** | Shipper Reference<br />Your reference for this shipment.<br />This field is used for Returns processing and is usually the shippers order number provided to the consumer. | [optional] +**shipperReference2** | **string** | Shipper Reference 2<br />Your second reference for this shipment. This field is used for tracking shipment usually the EBAY VTN number provided to the consumer. <br />Optional | [optional] **shipperDepartment** | **string** | Shipper Department Code<br />For Royal Mail shipments, this code must be a valid 10-digit OBA department code. | [optional] **companyName** | **string** | Company Name | [optional] **contactName** | **string** | Contact Name | [optional] diff --git a/lib/AddressesApi.php b/lib/AddressesApi.php index a76be53..519dea6 100644 --- a/lib/AddressesApi.php +++ b/lib/AddressesApi.php @@ -12,9 +12,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 @@ -318,10 +318,11 @@ protected function addressesCreateRequest($body, $xRMGAuthToken) // for model (json/xml) if (isset($_tempBody)) { - if ($headers['Content-Type'] === 'application/json') { - $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody)); - } else { - $httpBody = $_tempBody; + // $_tempBody is the method argument, if present + $httpBody = $_tempBody; + // \stdClass has no __toString(), so we should encode it manually + if ($httpBody instanceof \stdClass && $headers['Content-Type'] === 'application/json') { + $httpBody = \GuzzleHttp\json_encode($httpBody); } } elseif (count($formParams) > 0) { if ($multipart) { @@ -615,10 +616,11 @@ protected function addressesDeleteRequest($xRMGAuthToken, $addressId) // for model (json/xml) if (isset($_tempBody)) { - if ($headers['Content-Type'] === 'application/json') { - $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody)); - } else { - $httpBody = $_tempBody; + // $_tempBody is the method argument, if present + $httpBody = $_tempBody; + // \stdClass has no __toString(), so we should encode it manually + if ($httpBody instanceof \stdClass && $headers['Content-Type'] === 'application/json') { + $httpBody = \GuzzleHttp\json_encode($httpBody); } } elseif (count($formParams) > 0) { if ($multipart) { @@ -896,10 +898,11 @@ protected function addressesGetRequest($xRMGAuthToken, $addressId) // for model (json/xml) if (isset($_tempBody)) { - if ($headers['Content-Type'] === 'application/json') { - $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody)); - } else { - $httpBody = $_tempBody; + // $_tempBody is the method argument, if present + $httpBody = $_tempBody; + // \stdClass has no __toString(), so we should encode it manually + if ($httpBody instanceof \stdClass && $headers['Content-Type'] === 'application/json') { + $httpBody = \GuzzleHttp\json_encode($httpBody); } } elseif (count($formParams) > 0) { if ($multipart) { @@ -1158,10 +1161,11 @@ protected function addressesGetAllRequest($xRMGAuthToken) // for model (json/xml) if (isset($_tempBody)) { - if ($headers['Content-Type'] === 'application/json') { - $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody)); - } else { - $httpBody = $_tempBody; + // $_tempBody is the method argument, if present + $httpBody = $_tempBody; + // \stdClass has no __toString(), so we should encode it manually + if ($httpBody instanceof \stdClass && $headers['Content-Type'] === 'application/json') { + $httpBody = \GuzzleHttp\json_encode($httpBody); } } elseif (count($formParams) > 0) { if ($multipart) { @@ -1469,10 +1473,11 @@ protected function addressesUpdateRequest($body, $xRMGAuthToken, $addressId) // for model (json/xml) if (isset($_tempBody)) { - if ($headers['Content-Type'] === 'application/json') { - $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody)); - } else { - $httpBody = $_tempBody; + // $_tempBody is the method argument, if present + $httpBody = $_tempBody; + // \stdClass has no __toString(), so we should encode it manually + if ($httpBody instanceof \stdClass && $headers['Content-Type'] === 'application/json') { + $httpBody = \GuzzleHttp\json_encode($httpBody); } } elseif (count($formParams) > 0) { if ($multipart) { diff --git a/lib/ApiException.php b/lib/ApiException.php index d3236f2..e90abff 100644 --- a/lib/ApiException.php +++ b/lib/ApiException.php @@ -12,9 +12,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/lib/Configuration.php b/lib/Configuration.php index 8cb3e6c..1b50b5f 100644 --- a/lib/Configuration.php +++ b/lib/Configuration.php @@ -12,9 +12,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 @@ -395,7 +395,7 @@ public static function toDebugReport() $report = 'PHP SDK (RoyalMail\Shipping\Rest\Api) Debug Report:' . PHP_EOL; $report .= ' OS: ' . php_uname() . PHP_EOL; $report .= ' PHP Version: ' . PHP_VERSION . PHP_EOL; - $report .= ' OpenAPI Spec Version: 3.0.12' . PHP_EOL; + $report .= ' OpenAPI Spec Version: 3.0.20' . PHP_EOL; $report .= ' Temp Folder Path: ' . self::getDefaultConfiguration()->getTempFolderPath() . PHP_EOL; return $report; diff --git a/lib/HeaderSelector.php b/lib/HeaderSelector.php index 83d2ddb..010233d 100644 --- a/lib/HeaderSelector.php +++ b/lib/HeaderSelector.php @@ -12,9 +12,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/lib/ItemsApi.php b/lib/ItemsApi.php index a3b3048..001de06 100644 --- a/lib/ItemsApi.php +++ b/lib/ItemsApi.php @@ -12,9 +12,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 @@ -318,10 +318,11 @@ protected function itemsCreateRequest($body, $xRMGAuthToken) // for model (json/xml) if (isset($_tempBody)) { - if ($headers['Content-Type'] === 'application/json') { - $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody)); - } else { - $httpBody = $_tempBody; + // $_tempBody is the method argument, if present + $httpBody = $_tempBody; + // \stdClass has no __toString(), so we should encode it manually + if ($httpBody instanceof \stdClass && $headers['Content-Type'] === 'application/json') { + $httpBody = \GuzzleHttp\json_encode($httpBody); } } elseif (count($formParams) > 0) { if ($multipart) { @@ -599,10 +600,11 @@ protected function itemsDeleteRequest($xRMGAuthToken, $itemId) // for model (json/xml) if (isset($_tempBody)) { - if ($headers['Content-Type'] === 'application/json') { - $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody)); - } else { - $httpBody = $_tempBody; + // $_tempBody is the method argument, if present + $httpBody = $_tempBody; + // \stdClass has no __toString(), so we should encode it manually + if ($httpBody instanceof \stdClass && $headers['Content-Type'] === 'application/json') { + $httpBody = \GuzzleHttp\json_encode($httpBody); } } elseif (count($formParams) > 0) { if ($multipart) { @@ -880,10 +882,11 @@ protected function itemsGetRequest($xRMGAuthToken, $itemId) // for model (json/xml) if (isset($_tempBody)) { - if ($headers['Content-Type'] === 'application/json') { - $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody)); - } else { - $httpBody = $_tempBody; + // $_tempBody is the method argument, if present + $httpBody = $_tempBody; + // \stdClass has no __toString(), so we should encode it manually + if ($httpBody instanceof \stdClass && $headers['Content-Type'] === 'application/json') { + $httpBody = \GuzzleHttp\json_encode($httpBody); } } elseif (count($formParams) > 0) { if ($multipart) { @@ -1142,10 +1145,11 @@ protected function itemsGetAllRequest($xRMGAuthToken) // for model (json/xml) if (isset($_tempBody)) { - if ($headers['Content-Type'] === 'application/json') { - $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody)); - } else { - $httpBody = $_tempBody; + // $_tempBody is the method argument, if present + $httpBody = $_tempBody; + // \stdClass has no __toString(), so we should encode it manually + if ($httpBody instanceof \stdClass && $headers['Content-Type'] === 'application/json') { + $httpBody = \GuzzleHttp\json_encode($httpBody); } } elseif (count($formParams) > 0) { if ($multipart) { @@ -1445,10 +1449,11 @@ protected function itemsUpdateRequest($body, $xRMGAuthToken, $itemId) // for model (json/xml) if (isset($_tempBody)) { - if ($headers['Content-Type'] === 'application/json') { - $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody)); - } else { - $httpBody = $_tempBody; + // $_tempBody is the method argument, if present + $httpBody = $_tempBody; + // \stdClass has no __toString(), so we should encode it manually + if ($httpBody instanceof \stdClass && $headers['Content-Type'] === 'application/json') { + $httpBody = \GuzzleHttp\json_encode($httpBody); } } elseif (count($formParams) > 0) { if ($multipart) { diff --git a/lib/ManifestsApi.php b/lib/ManifestsApi.php index 6e3cd07..6c4ceaf 100644 --- a/lib/ManifestsApi.php +++ b/lib/ManifestsApi.php @@ -12,9 +12,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 @@ -318,10 +318,11 @@ protected function manifestsCreateRequest($body, $xRMGAuthToken) // for model (json/xml) if (isset($_tempBody)) { - if ($headers['Content-Type'] === 'application/json') { - $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody)); - } else { - $httpBody = $_tempBody; + // $_tempBody is the method argument, if present + $httpBody = $_tempBody; + // \stdClass has no __toString(), so we should encode it manually + if ($httpBody instanceof \stdClass && $headers['Content-Type'] === 'application/json') { + $httpBody = \GuzzleHttp\json_encode($httpBody); } } elseif (count($formParams) > 0) { if ($multipart) { @@ -602,10 +603,11 @@ protected function manifestsCreateByCarrierRequest($body, $xRMGAuthToken) // for model (json/xml) if (isset($_tempBody)) { - if ($headers['Content-Type'] === 'application/json') { - $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody)); - } else { - $httpBody = $_tempBody; + // $_tempBody is the method argument, if present + $httpBody = $_tempBody; + // \stdClass has no __toString(), so we should encode it manually + if ($httpBody instanceof \stdClass && $headers['Content-Type'] === 'application/json') { + $httpBody = \GuzzleHttp\json_encode($httpBody); } } elseif (count($formParams) > 0) { if ($multipart) { @@ -886,10 +888,11 @@ protected function manifestsCreateByServiceRequest($body, $xRMGAuthToken) // for model (json/xml) if (isset($_tempBody)) { - if ($headers['Content-Type'] === 'application/json') { - $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody)); - } else { - $httpBody = $_tempBody; + // $_tempBody is the method argument, if present + $httpBody = $_tempBody; + // \stdClass has no __toString(), so we should encode it manually + if ($httpBody instanceof \stdClass && $headers['Content-Type'] === 'application/json') { + $httpBody = \GuzzleHttp\json_encode($httpBody); } } elseif (count($formParams) > 0) { if ($multipart) { diff --git a/lib/ObjectSerializer.php b/lib/ObjectSerializer.php index 8f0a095..32fa8b9 100644 --- a/lib/ObjectSerializer.php +++ b/lib/ObjectSerializer.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/lib/PackagingApi.php b/lib/PackagingApi.php index 8c42a8f..fe86a01 100644 --- a/lib/PackagingApi.php +++ b/lib/PackagingApi.php @@ -12,9 +12,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 @@ -318,10 +318,11 @@ protected function packagingCreateRequest($body, $xRMGAuthToken) // for model (json/xml) if (isset($_tempBody)) { - if ($headers['Content-Type'] === 'application/json') { - $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody)); - } else { - $httpBody = $_tempBody; + // $_tempBody is the method argument, if present + $httpBody = $_tempBody; + // \stdClass has no __toString(), so we should encode it manually + if ($httpBody instanceof \stdClass && $headers['Content-Type'] === 'application/json') { + $httpBody = \GuzzleHttp\json_encode($httpBody); } } elseif (count($formParams) > 0) { if ($multipart) { @@ -599,10 +600,11 @@ protected function packagingDeleteRequest($xRMGAuthToken, $packagingId) // for model (json/xml) if (isset($_tempBody)) { - if ($headers['Content-Type'] === 'application/json') { - $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody)); - } else { - $httpBody = $_tempBody; + // $_tempBody is the method argument, if present + $httpBody = $_tempBody; + // \stdClass has no __toString(), so we should encode it manually + if ($httpBody instanceof \stdClass && $headers['Content-Type'] === 'application/json') { + $httpBody = \GuzzleHttp\json_encode($httpBody); } } elseif (count($formParams) > 0) { if ($multipart) { @@ -880,10 +882,11 @@ protected function packagingGetRequest($xRMGAuthToken, $packagingId) // for model (json/xml) if (isset($_tempBody)) { - if ($headers['Content-Type'] === 'application/json') { - $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody)); - } else { - $httpBody = $_tempBody; + // $_tempBody is the method argument, if present + $httpBody = $_tempBody; + // \stdClass has no __toString(), so we should encode it manually + if ($httpBody instanceof \stdClass && $headers['Content-Type'] === 'application/json') { + $httpBody = \GuzzleHttp\json_encode($httpBody); } } elseif (count($formParams) > 0) { if ($multipart) { @@ -1142,10 +1145,11 @@ protected function packagingGetAllRequest($xRMGAuthToken) // for model (json/xml) if (isset($_tempBody)) { - if ($headers['Content-Type'] === 'application/json') { - $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody)); - } else { - $httpBody = $_tempBody; + // $_tempBody is the method argument, if present + $httpBody = $_tempBody; + // \stdClass has no __toString(), so we should encode it manually + if ($httpBody instanceof \stdClass && $headers['Content-Type'] === 'application/json') { + $httpBody = \GuzzleHttp\json_encode($httpBody); } } elseif (count($formParams) > 0) { if ($multipart) { @@ -1445,10 +1449,11 @@ protected function packagingUpdateRequest($body, $xRMGAuthToken, $packagingId) // for model (json/xml) if (isset($_tempBody)) { - if ($headers['Content-Type'] === 'application/json') { - $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody)); - } else { - $httpBody = $_tempBody; + // $_tempBody is the method argument, if present + $httpBody = $_tempBody; + // \stdClass has no __toString(), so we should encode it manually + if ($httpBody instanceof \stdClass && $headers['Content-Type'] === 'application/json') { + $httpBody = \GuzzleHttp\json_encode($httpBody); } } elseif (count($formParams) > 0) { if ($multipart) { diff --git a/lib/ShipmentsApi.php b/lib/ShipmentsApi.php index f606f7b..f2c40fa 100644 --- a/lib/ShipmentsApi.php +++ b/lib/ShipmentsApi.php @@ -12,9 +12,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 @@ -326,10 +326,11 @@ protected function shipmentsCancelRequest($body, $xRMGAuthToken) // for model (json/xml) if (isset($_tempBody)) { - if ($headers['Content-Type'] === 'application/json') { - $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody)); - } else { - $httpBody = $_tempBody; + // $_tempBody is the method argument, if present + $httpBody = $_tempBody; + // \stdClass has no __toString(), so we should encode it manually + if ($httpBody instanceof \stdClass && $headers['Content-Type'] === 'application/json') { + $httpBody = \GuzzleHttp\json_encode($httpBody); } } elseif (count($formParams) > 0) { if ($multipart) { @@ -610,10 +611,11 @@ protected function shipmentsCreateRequest($body, $xRMGAuthToken) // for model (json/xml) if (isset($_tempBody)) { - if ($headers['Content-Type'] === 'application/json') { - $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody)); - } else { - $httpBody = $_tempBody; + // $_tempBody is the method argument, if present + $httpBody = $_tempBody; + // \stdClass has no __toString(), so we should encode it manually + if ($httpBody instanceof \stdClass && $headers['Content-Type'] === 'application/json') { + $httpBody = \GuzzleHttp\json_encode($httpBody); } } elseif (count($formParams) > 0) { if ($multipart) { @@ -902,10 +904,11 @@ protected function shipmentsDeferRequest($body, $xRMGAuthToken) // for model (json/xml) if (isset($_tempBody)) { - if ($headers['Content-Type'] === 'application/json') { - $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody)); - } else { - $httpBody = $_tempBody; + // $_tempBody is the method argument, if present + $httpBody = $_tempBody; + // \stdClass has no __toString(), so we should encode it manually + if ($httpBody instanceof \stdClass && $headers['Content-Type'] === 'application/json') { + $httpBody = \GuzzleHttp\json_encode($httpBody); } } elseif (count($formParams) > 0) { if ($multipart) { @@ -1194,10 +1197,11 @@ protected function shipmentsHoldRequest($body, $xRMGAuthToken) // for model (json/xml) if (isset($_tempBody)) { - if ($headers['Content-Type'] === 'application/json') { - $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody)); - } else { - $httpBody = $_tempBody; + // $_tempBody is the method argument, if present + $httpBody = $_tempBody; + // \stdClass has no __toString(), so we should encode it manually + if ($httpBody instanceof \stdClass && $headers['Content-Type'] === 'application/json') { + $httpBody = \GuzzleHttp\json_encode($httpBody); } } elseif (count($formParams) > 0) { if ($multipart) { @@ -1505,10 +1509,11 @@ protected function shipmentsPrintDocumentRequest($body, $xRMGAuthToken, $shipmen // for model (json/xml) if (isset($_tempBody)) { - if ($headers['Content-Type'] === 'application/json') { - $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody)); - } else { - $httpBody = $_tempBody; + // $_tempBody is the method argument, if present + $httpBody = $_tempBody; + // \stdClass has no __toString(), so we should encode it manually + if ($httpBody instanceof \stdClass && $headers['Content-Type'] === 'application/json') { + $httpBody = \GuzzleHttp\json_encode($httpBody); } } elseif (count($formParams) > 0) { if ($multipart) { @@ -1816,10 +1821,11 @@ protected function shipmentsPrintLabelRequest($body, $xRMGAuthToken, $shipmentId // for model (json/xml) if (isset($_tempBody)) { - if ($headers['Content-Type'] === 'application/json') { - $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody)); - } else { - $httpBody = $_tempBody; + // $_tempBody is the method argument, if present + $httpBody = $_tempBody; + // \stdClass has no __toString(), so we should encode it manually + if ($httpBody instanceof \stdClass && $headers['Content-Type'] === 'application/json') { + $httpBody = \GuzzleHttp\json_encode($httpBody); } } elseif (count($formParams) > 0) { if ($multipart) { @@ -2108,10 +2114,11 @@ protected function shipmentsReleaseRequest($body, $xRMGAuthToken) // for model (json/xml) if (isset($_tempBody)) { - if ($headers['Content-Type'] === 'application/json') { - $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody)); - } else { - $httpBody = $_tempBody; + // $_tempBody is the method argument, if present + $httpBody = $_tempBody; + // \stdClass has no __toString(), so we should encode it manually + if ($httpBody instanceof \stdClass && $headers['Content-Type'] === 'application/json') { + $httpBody = \GuzzleHttp\json_encode($httpBody); } } elseif (count($formParams) > 0) { if ($multipart) { @@ -2392,10 +2399,11 @@ protected function shipmentsServiceAvailabilityRequest($body, $xRMGAuthToken) // for model (json/xml) if (isset($_tempBody)) { - if ($headers['Content-Type'] === 'application/json') { - $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody)); - } else { - $httpBody = $_tempBody; + // $_tempBody is the method argument, if present + $httpBody = $_tempBody; + // \stdClass has no __toString(), so we should encode it manually + if ($httpBody instanceof \stdClass && $headers['Content-Type'] === 'application/json') { + $httpBody = \GuzzleHttp\json_encode($httpBody); } } elseif (count($formParams) > 0) { if ($multipart) { diff --git a/lib/TokenApi.php b/lib/TokenApi.php index 0e952c4..fe3dfa4 100644 --- a/lib/TokenApi.php +++ b/lib/TokenApi.php @@ -12,9 +12,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 @@ -359,10 +359,11 @@ protected function authenticatePostRequest($xRMGSecurityUsername, $xRMGSecurityP // for model (json/xml) if (isset($_tempBody)) { - if ($headers['Content-Type'] === 'application/json') { - $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody)); - } else { - $httpBody = $_tempBody; + // $_tempBody is the method argument, if present + $httpBody = $_tempBody; + // \stdClass has no __toString(), so we should encode it manually + if ($httpBody instanceof \stdClass && $headers['Content-Type'] === 'application/json') { + $httpBody = \GuzzleHttp\json_encode($httpBody); } } elseif (count($formParams) > 0) { if ($multipart) { diff --git a/lib/models/Address.php b/lib/models/Address.php index d19e895..deb1ff0 100644 --- a/lib/models/Address.php +++ b/lib/models/Address.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/lib/models/AddressResponse.php b/lib/models/AddressResponse.php index 7db6758..a694c72 100644 --- a/lib/models/AddressResponse.php +++ b/lib/models/AddressResponse.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/lib/models/CreateShipmentCustomsInformation.php b/lib/models/CreateShipmentCustomsInformation.php new file mode 100644 index 0000000..df4eef0 --- /dev/null +++ b/lib/models/CreateShipmentCustomsInformation.php @@ -0,0 +1,532 @@ + 'string', +'preRegistrationType' => 'string', +'shippingCharges' => 'double', +'otherCharges' => 'double', +'quotedLandedCost' => 'double', +'invoiceNumber' => 'string', +'invoiceDate' => '\DateTime', +'exportLicence' => 'bool', +'addresseeIdentificationReferenceNumber' => 'string' ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'preRegistrationNumber' => null, +'preRegistrationType' => null, +'shippingCharges' => 'double', +'otherCharges' => 'double', +'quotedLandedCost' => 'double', +'invoiceNumber' => null, +'invoiceDate' => 'date-time', +'exportLicence' => null, +'addresseeIdentificationReferenceNumber' => null ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @var string[] + */ + protected static $attributeMap = [ + 'preRegistrationNumber' => 'PreRegistrationNumber', +'preRegistrationType' => 'PreRegistrationType', +'shippingCharges' => 'ShippingCharges', +'otherCharges' => 'OtherCharges', +'quotedLandedCost' => 'QuotedLandedCost', +'invoiceNumber' => 'InvoiceNumber', +'invoiceDate' => 'InvoiceDate', +'exportLicence' => 'ExportLicence', +'addresseeIdentificationReferenceNumber' => 'AddresseeIdentificationReferenceNumber' ]; + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @var string[] + */ + protected static $setters = [ + 'preRegistrationNumber' => 'setPreRegistrationNumber', +'preRegistrationType' => 'setPreRegistrationType', +'shippingCharges' => 'setShippingCharges', +'otherCharges' => 'setOtherCharges', +'quotedLandedCost' => 'setQuotedLandedCost', +'invoiceNumber' => 'setInvoiceNumber', +'invoiceDate' => 'setInvoiceDate', +'exportLicence' => 'setExportLicence', +'addresseeIdentificationReferenceNumber' => 'setAddresseeIdentificationReferenceNumber' ]; + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @var string[] + */ + protected static $getters = [ + 'preRegistrationNumber' => 'getPreRegistrationNumber', +'preRegistrationType' => 'getPreRegistrationType', +'shippingCharges' => 'getShippingCharges', +'otherCharges' => 'getOtherCharges', +'quotedLandedCost' => 'getQuotedLandedCost', +'invoiceNumber' => 'getInvoiceNumber', +'invoiceDate' => 'getInvoiceDate', +'exportLicence' => 'getExportLicence', +'addresseeIdentificationReferenceNumber' => 'getAddresseeIdentificationReferenceNumber' ]; + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ + public static function attributeMap() + { + return self::$attributeMap; + } + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ + public static function setters() + { + return self::$setters; + } + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ + public static function getters() + { + return self::$getters; + } + + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + + + + /** + * Associative array for storing property values + * + * @var mixed[] + */ + protected $container = []; + + /** + * Constructor + * + * @param mixed[] $data Associated array of property values + * initializing the model + */ + public function __construct(array $data = null) + { + $this->container['preRegistrationNumber'] = isset($data['preRegistrationNumber']) ? $data['preRegistrationNumber'] : null; + $this->container['preRegistrationType'] = isset($data['preRegistrationType']) ? $data['preRegistrationType'] : null; + $this->container['shippingCharges'] = isset($data['shippingCharges']) ? $data['shippingCharges'] : null; + $this->container['otherCharges'] = isset($data['otherCharges']) ? $data['otherCharges'] : null; + $this->container['quotedLandedCost'] = isset($data['quotedLandedCost']) ? $data['quotedLandedCost'] : null; + $this->container['invoiceNumber'] = isset($data['invoiceNumber']) ? $data['invoiceNumber'] : null; + $this->container['invoiceDate'] = isset($data['invoiceDate']) ? $data['invoiceDate'] : null; + $this->container['exportLicence'] = isset($data['exportLicence']) ? $data['exportLicence'] : null; + $this->container['addresseeIdentificationReferenceNumber'] = isset($data['addresseeIdentificationReferenceNumber']) ? $data['addresseeIdentificationReferenceNumber'] : null; + } + + /** + * Show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalidProperties = []; + + return $invalidProperties; + } + + /** + * Validate all the properties in the model + * return true if all passed + * + * @return bool True if all properties are valid + */ + public function valid() + { + return count($this->listInvalidProperties()) === 0; + } + + + /** + * Gets preRegistrationNumber + * + * @return string + */ + public function getPreRegistrationNumber() + { + return $this->container['preRegistrationNumber']; + } + + /** + * Sets preRegistrationNumber + * + * @param string $preRegistrationNumber A pre-registration number is only relevant if the INCOTERMS (International Commercial Terms) for the shipment are DDP (Delivery duty paid).

If not provided, and the INCOTERMS are set to DDP, any pre-registration numbers set up via your Customs Settings will be used. + * + * @return $this + */ + public function setPreRegistrationNumber($preRegistrationNumber) + { + $this->container['preRegistrationNumber'] = $preRegistrationNumber; + + return $this; + } + + /** + * Gets preRegistrationType + * + * @return string + */ + public function getPreRegistrationType() + { + return $this->container['preRegistrationType']; + } + + /** + * Sets preRegistrationType + * + * @param string $preRegistrationType The type of pre-registration number provided above.
Required if a pre-registration number has been provided.
Ignored if there is no pre-registration number. + * + * @return $this + */ + public function setPreRegistrationType($preRegistrationType) + { + $this->container['preRegistrationType'] = $preRegistrationType; + + return $this; + } + + /** + * Gets shippingCharges + * + * @return double + */ + public function getShippingCharges() + { + return $this->container['shippingCharges']; + } + + /** + * Sets shippingCharges + * + * @param double $shippingCharges Shipping Charges for International Shipments.
The postage amount paid by your customer. The amount can be 0.00 if you have offered your customer free delivery.
Used for the calculation of customs fees.

*The amount should be in the currency specified in the ShipmentInformation/Currency field.* + * + * @return $this + */ + public function setShippingCharges($shippingCharges) + { + $this->container['shippingCharges'] = $shippingCharges; + + return $this; + } + + /** + * Gets otherCharges + * + * @return double + */ + public function getOtherCharges() + { + return $this->container['otherCharges']; + } + + /** + * Sets otherCharges + * + * @param double $otherCharges Insurance and Other Costs for International Shipments.
If you have charged your customer an additional surcharge such as insurance, you must declare the amount here.
This field can be left blank, or be 0.00 if no other charges have been levied.

*Any value should be in the currency specified in the ShipmentInformation/Currency field.* + * + * @return $this + */ + public function setOtherCharges($otherCharges) + { + $this->container['otherCharges'] = $otherCharges; + + return $this; + } + + /** + * Gets quotedLandedCost + * + * @return double + */ + public function getQuotedLandedCost() + { + return $this->container['quotedLandedCost']; + } + + /** + * Sets quotedLandedCost + * + * @param double $quotedLandedCost Quoted Landed Cost
This will be the Value of Tax and Duties due to be paid for via the purchaser to the merchant relevant to international sales of goods.

*Any value should be in the currency specified in the ShipmentInformation/Currency field.* + * + * @return $this + */ + public function setQuotedLandedCost($quotedLandedCost) + { + $this->container['quotedLandedCost'] = $quotedLandedCost; + + return $this; + } + + /** + * Gets invoiceNumber + * + * @return string + */ + public function getInvoiceNumber() + { + return $this->container['invoiceNumber']; + } + + /** + * Sets invoiceNumber + * + * @param string $invoiceNumber Commercial Invoice Number for International Shipments.
When sending an item to an overseas address and a commercial invoice is available the Invoice Number and Date should be provided where possible. This supports customs processing in certain circumstances. + * + * @return $this + */ + public function setInvoiceNumber($invoiceNumber) + { + $this->container['invoiceNumber'] = $invoiceNumber; + + return $this; + } + + /** + * Gets invoiceDate + * + * @return \DateTime + */ + public function getInvoiceDate() + { + return $this->container['invoiceDate']; + } + + /** + * Sets invoiceDate + * + * @param \DateTime $invoiceDate Commercial Invoice Date - YYYY-MM-DD.
Required when a commercial invoice number is provided.
Ignored if no Invoice Number provided. + * + * @return $this + */ + public function setInvoiceDate($invoiceDate) + { + $this->container['invoiceDate'] = $invoiceDate; + + return $this; + } + + /** + * Gets exportLicence + * + * @return bool + */ + public function getExportLicence() + { + return $this->container['exportLicence']; + } + + /** + * Sets exportLicence + * + * @param bool $exportLicence Export Licence Required.
Customers exporting items requiring an export licence must flag the item as requiring an export licence here. This requirement is restricted to exporters of specific type of goods used predominantly for military purposes, as such will probably not apply to you. You can find out more about the type of items requiring an export licence on the UK Government website.

If an export licence is required, it should be affixed to the outside of your parcel. + * + * @return $this + */ + public function setExportLicence($exportLicence) + { + $this->container['exportLicence'] = $exportLicence; + + return $this; + } + + /** + * Gets addresseeIdentificationReferenceNumber + * + * @return string + */ + public function getAddresseeIdentificationReferenceNumber() + { + return $this->container['addresseeIdentificationReferenceNumber']; + } + + /** + * Sets addresseeIdentificationReferenceNumber + * + * @param string $addresseeIdentificationReferenceNumber Addressee Identification Reference Number (previously \"recipients purchasing ID\").
Recipient Purchasing IDs for International Shipments.
A small number of countries require their citizens to obtain a registration number before importing goods from overseas. When exporting items to countries with such a scheme in place there is a requirement to provide the recipients registration details to customs authorities. + * + * @return $this + */ + public function setAddresseeIdentificationReferenceNumber($addresseeIdentificationReferenceNumber) + { + $this->container['addresseeIdentificationReferenceNumber'] = $addresseeIdentificationReferenceNumber; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * + * @param integer $offset Offset + * + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * + * @param integer $offset Offset + * + * @return mixed + */ + public function offsetGet($offset) + { + return isset($this->container[$offset]) ? $this->container[$offset] : null; + } + + /** + * Sets value based on offset. + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * + * @return void + */ + public function offsetSet($offset, $value) + { + if (is_null($offset)) { + $this->container[] = $value; + } else { + $this->container[$offset] = $value; + } + } + + /** + * Unsets offset. + * + * @param integer $offset Offset + * + * @return void + */ + public function offsetUnset($offset) + { + unset($this->container[$offset]); + } + + /** + * Gets the string presentation of the object + * + * @return string + */ + public function __toString() + { + if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print + return json_encode( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); + } + + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); + } +} diff --git a/lib/models/CreateShipmentDestination.php b/lib/models/CreateShipmentDestination.php index e5629dd..87df74b 100644 --- a/lib/models/CreateShipmentDestination.php +++ b/lib/models/CreateShipmentDestination.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 @@ -35,7 +35,7 @@ * CreateShipmentDestination Class Doc Comment * * @category Class - * @description The destination address and contact details.<br />It is the shipper’s responsibility to provide accurate and concise information to ensure the best possible delivery experience for the consumer. + * @description The destination address and contact details.<br />It is the shippers responsibility to provide accurate and concise information to ensure the best possible delivery experience for the consumer. * @package RoyalMail\Shipping\Rest\Api * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen diff --git a/lib/models/CreateShipmentServiceOptions.php b/lib/models/CreateShipmentServiceOptions.php index e79e76f..e5a1341 100644 --- a/lib/models/CreateShipmentServiceOptions.php +++ b/lib/models/CreateShipmentServiceOptions.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 @@ -465,7 +465,7 @@ public function getConsequentialLoss() /** * Sets consequentialLoss * - * @param string $consequentialLoss Consequential Loss Enhancement
Available for Domestic Special Delivery Services Only.

**Level1** - £1,000
**Level2** - £2,500
**Level3** - £5,000
**Level4** - £7,500
**Level5** - £10,000

Returns an error if requested and the service does not allow it. + * @param string $consequentialLoss Consequential Loss Enhancement
Available for Domestic Special Delivery Services Only.

**Level1** - ??1,000
**Level2** - ??2,500
**Level3** - ??5,000
**Level4** - ??7,500
**Level5** - ??10,000

Returns an error if requested and the service does not allow it. * * @return $this */ @@ -522,7 +522,7 @@ public function getTrackingNotifications() /** * Sets trackingNotifications * - * @param string $trackingNotifications Tracking Notifications Enhancement
Available for Domestic Special Delivery and Domestic Tracked services only.
Returns an error if requested and the service does not allow it. + * @param string $trackingNotifications Tracking Notifications Enhancement
Available for Domestic Special Delivery and Domestic Tracked services.
The Email notification enhancement is also available for International Tracked and International Tracked and Signed services.
Returns an error if requested and the service does not allow it. * * @return $this */ diff --git a/lib/models/CreateShipmentShipment.php b/lib/models/CreateShipmentShipment.php index ca4c7ff..74d0979 100644 --- a/lib/models/CreateShipmentShipment.php +++ b/lib/models/CreateShipmentShipment.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 @@ -59,7 +59,8 @@ class CreateShipmentShipment implements ModelInterface, ArrayAccess protected static $swaggerTypes = [ 'shipper' => '\RoyalMail\Shipping\Rest\Api\models\Shipper', 'destination' => '\RoyalMail\Shipping\Rest\Api\models\CreateShipmentDestination', -'shipmentInformation' => '\RoyalMail\Shipping\Rest\Api\models\CreateShipmentShipmentInformation' ]; +'shipmentInformation' => '\RoyalMail\Shipping\Rest\Api\models\CreateShipmentShipmentInformation', +'customsInformation' => '\RoyalMail\Shipping\Rest\Api\models\CreateShipmentCustomsInformation' ]; /** * Array of property to format mappings. Used for (de)serialization @@ -69,7 +70,8 @@ class CreateShipmentShipment implements ModelInterface, ArrayAccess protected static $swaggerFormats = [ 'shipper' => null, 'destination' => null, -'shipmentInformation' => null ]; +'shipmentInformation' => null, +'customsInformation' => null ]; /** * Array of property to type mappings. Used for (de)serialization @@ -100,7 +102,8 @@ public static function swaggerFormats() protected static $attributeMap = [ 'shipper' => 'Shipper', 'destination' => 'Destination', -'shipmentInformation' => 'ShipmentInformation' ]; +'shipmentInformation' => 'ShipmentInformation', +'customsInformation' => 'CustomsInformation' ]; /** * Array of attributes to setter functions (for deserialization of responses) @@ -110,7 +113,8 @@ public static function swaggerFormats() protected static $setters = [ 'shipper' => 'setShipper', 'destination' => 'setDestination', -'shipmentInformation' => 'setShipmentInformation' ]; +'shipmentInformation' => 'setShipmentInformation', +'customsInformation' => 'setCustomsInformation' ]; /** * Array of attributes to getter functions (for serialization of requests) @@ -120,7 +124,8 @@ public static function swaggerFormats() protected static $getters = [ 'shipper' => 'getShipper', 'destination' => 'getDestination', -'shipmentInformation' => 'getShipmentInformation' ]; +'shipmentInformation' => 'getShipmentInformation', +'customsInformation' => 'getCustomsInformation' ]; /** * Array of attributes where the key is the local name, @@ -183,6 +188,7 @@ public function __construct(array $data = null) $this->container['shipper'] = isset($data['shipper']) ? $data['shipper'] : null; $this->container['destination'] = isset($data['destination']) ? $data['destination'] : null; $this->container['shipmentInformation'] = isset($data['shipmentInformation']) ? $data['shipmentInformation'] : null; + $this->container['customsInformation'] = isset($data['customsInformation']) ? $data['customsInformation'] : null; } /** @@ -286,6 +292,30 @@ public function setShipmentInformation($shipmentInformation) return $this; } + + /** + * Gets customsInformation + * + * @return \RoyalMail\Shipping\Rest\Api\models\CreateShipmentCustomsInformation + */ + public function getCustomsInformation() + { + return $this->container['customsInformation']; + } + + /** + * Sets customsInformation + * + * @param \RoyalMail\Shipping\Rest\Api\models\CreateShipmentCustomsInformation $customsInformation customsInformation + * + * @return $this + */ + public function setCustomsInformation($customsInformation) + { + $this->container['customsInformation'] = $customsInformation; + + return $this; + } /** * Returns true if offset exists. False otherwise. * diff --git a/lib/models/CreateShipmentShipmentInformation.php b/lib/models/CreateShipmentShipmentInformation.php index 48f97a8..dc35b46 100644 --- a/lib/models/CreateShipmentShipmentInformation.php +++ b/lib/models/CreateShipmentShipmentInformation.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 @@ -68,6 +68,7 @@ class CreateShipmentShipmentInformation implements ModelInterface, ArrayAccess 'reasonForExport' => 'string', 'value' => 'double', 'currency' => 'string', +'incoterms' => 'string', 'labelFormat' => 'string', 'silentPrintProfile' => 'string', 'shipmentAction' => 'string', @@ -91,6 +92,7 @@ class CreateShipmentShipmentInformation implements ModelInterface, ArrayAccess 'reasonForExport' => null, 'value' => 'double', 'currency' => null, +'incoterms' => null, 'labelFormat' => null, 'silentPrintProfile' => 'uuid', 'shipmentAction' => null, @@ -135,6 +137,7 @@ public static function swaggerFormats() 'reasonForExport' => 'ReasonForExport', 'value' => 'Value', 'currency' => 'Currency', +'incoterms' => 'Incoterms', 'labelFormat' => 'LabelFormat', 'silentPrintProfile' => 'SilentPrintProfile', 'shipmentAction' => 'ShipmentAction', @@ -158,6 +161,7 @@ public static function swaggerFormats() 'reasonForExport' => 'setReasonForExport', 'value' => 'setValue', 'currency' => 'setCurrency', +'incoterms' => 'setIncoterms', 'labelFormat' => 'setLabelFormat', 'silentPrintProfile' => 'setSilentPrintProfile', 'shipmentAction' => 'setShipmentAction', @@ -181,6 +185,7 @@ public static function swaggerFormats() 'reasonForExport' => 'getReasonForExport', 'value' => 'getValue', 'currency' => 'getCurrency', +'incoterms' => 'getIncoterms', 'labelFormat' => 'getLabelFormat', 'silentPrintProfile' => 'getSilentPrintProfile', 'shipmentAction' => 'getShipmentAction', @@ -232,6 +237,10 @@ public function getModelName() const WEIGHT_UNIT_OF_MEASURE_GRAMS = 'Grams'; const PRODUCT_NDX = 'NDX'; const PRODUCT_DOX = 'DOX'; +const INCOTERMS_DDP = 'DDP'; +const INCOTERMS_DAT = 'DAT'; +const INCOTERMS_DAP = 'DAP'; +const INCOTERMS_DDU = 'DDU'; const LABEL_FORMAT_PDF = 'PDF'; const LABEL_FORMAT_PNG = 'PNG'; const LABEL_FORMAT_DATASTREAM = 'DATASTREAM'; @@ -262,6 +271,19 @@ public function getProductAllowableValues() return [ self::PRODUCT_NDX, self::PRODUCT_DOX, ]; + } + /** + * Gets allowable values of the enum + * + * @return string[] + */ + public function getIncotermsAllowableValues() + { + return [ + self::INCOTERMS_DDP, +self::INCOTERMS_DAT, +self::INCOTERMS_DAP, +self::INCOTERMS_DDU, ]; } /** * Gets allowable values of the enum @@ -316,6 +338,7 @@ public function __construct(array $data = null) $this->container['reasonForExport'] = isset($data['reasonForExport']) ? $data['reasonForExport'] : null; $this->container['value'] = isset($data['value']) ? $data['value'] : null; $this->container['currency'] = isset($data['currency']) ? $data['currency'] : null; + $this->container['incoterms'] = isset($data['incoterms']) ? $data['incoterms'] : 'DDU'; $this->container['labelFormat'] = isset($data['labelFormat']) ? $data['labelFormat'] : 'PDF'; $this->container['silentPrintProfile'] = isset($data['silentPrintProfile']) ? $data['silentPrintProfile'] : null; $this->container['shipmentAction'] = isset($data['shipmentAction']) ? $data['shipmentAction'] : 'Process'; @@ -360,6 +383,14 @@ public function listInvalidProperties() ); } + $allowedValues = $this->getIncotermsAllowableValues(); + if (!is_null($this->container['incoterms']) && !in_array($this->container['incoterms'], $allowedValues, true)) { + $invalidProperties[] = sprintf( + "invalid value for 'incoterms', must be one of '%s'", + implode("', '", $allowedValues) + ); + } + $allowedValues = $this->getLabelFormatAllowableValues(); if (!is_null($this->container['labelFormat']) && !in_array($this->container['labelFormat'], $allowedValues, true)) { $invalidProperties[] = sprintf( @@ -662,7 +693,7 @@ public function getCurrency() /** * Sets currency * - * @param string $currency Currency
This currency will be used for all values across the shipment request.
3 digit ISO Currency Code.
Required for Non-Document International and BFPO Shipments, or when values are provided.
Ignored for Documents Only shipments. + * @param string $currency Currency
This currency will be used for all values across the shipment request, including customs charges.
3 digit ISO Currency Code.
Required for Non-Document International and BFPO Shipments, or when values are provided.
Ignored for Documents Only shipments. * * @return $this */ @@ -673,6 +704,39 @@ public function setCurrency($currency) return $this; } + /** + * Gets incoterms + * + * @return string + */ + public function getIncoterms() + { + return $this->container['incoterms']; + } + + /** + * Sets incoterms + * + * @param string $incoterms International Commercial Terms
Developed by International Chamber of Commerce and widely used in international and domestic contracts for the sale of goods.

**DDP** - Delivered Duty Paid.

**DAT** - Delivered At Terminal.

**DAP** - Delivered At Place.

**DDU** - Delivered Duty Unpaid. + * + * @return $this + */ + public function setIncoterms($incoterms) + { + $allowedValues = $this->getIncotermsAllowableValues(); + if (!is_null($incoterms) && !in_array($incoterms, $allowedValues, true)) { + throw new \InvalidArgumentException( + sprintf( + "Invalid value for 'incoterms', must be one of '%s'", + implode("', '", $allowedValues) + ) + ); + } + $this->container['incoterms'] = $incoterms; + + return $this; + } + /** * Gets labelFormat * diff --git a/lib/models/CreateShipmentShipmentPackage.php b/lib/models/CreateShipmentShipmentPackage.php index 51393d9..2a830af 100644 --- a/lib/models/CreateShipmentShipmentPackage.php +++ b/lib/models/CreateShipmentShipmentPackage.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/lib/models/ErrorDetail.php b/lib/models/ErrorDetail.php index faec61e..9041265 100644 --- a/lib/models/ErrorDetail.php +++ b/lib/models/ErrorDetail.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/lib/models/Item.php b/lib/models/Item.php index 4022a51..a7d5090 100644 --- a/lib/models/Item.php +++ b/lib/models/Item.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/lib/models/ItemResponse.php b/lib/models/ItemResponse.php index 42470ff..ca2c1dd 100644 --- a/lib/models/ItemResponse.php +++ b/lib/models/ItemResponse.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/lib/models/Manifest.php b/lib/models/Manifest.php index 86cd1c5..795cb6d 100644 --- a/lib/models/Manifest.php +++ b/lib/models/Manifest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/lib/models/ManifestCarrierCodesRequest.php b/lib/models/ManifestCarrierCodesRequest.php index ec2020e..62480dc 100644 --- a/lib/models/ManifestCarrierCodesRequest.php +++ b/lib/models/ManifestCarrierCodesRequest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/lib/models/ManifestRequest.php b/lib/models/ManifestRequest.php index 015a6f1..262e45e 100644 --- a/lib/models/ManifestRequest.php +++ b/lib/models/ManifestRequest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/lib/models/ManifestResponse.php b/lib/models/ManifestResponse.php index 867cfe9..6f5d58a 100644 --- a/lib/models/ManifestResponse.php +++ b/lib/models/ManifestResponse.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/lib/models/ManifestServiceCodesRequest.php b/lib/models/ManifestServiceCodesRequest.php index b309b58..13adc93 100644 --- a/lib/models/ManifestServiceCodesRequest.php +++ b/lib/models/ManifestServiceCodesRequest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/lib/models/ModelInterface.php b/lib/models/ModelInterface.php index 293fe3b..5bbc091 100644 --- a/lib/models/ModelInterface.php +++ b/lib/models/ModelInterface.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/lib/models/PackageResponse.php b/lib/models/PackageResponse.php index f3faa64..ee62ac7 100644 --- a/lib/models/PackageResponse.php +++ b/lib/models/PackageResponse.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/lib/models/Packaging.php b/lib/models/Packaging.php index f621d3c..83274d6 100644 --- a/lib/models/Packaging.php +++ b/lib/models/Packaging.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/lib/models/PackagingResponse.php b/lib/models/PackagingResponse.php index 6fd9083..c0b2949 100644 --- a/lib/models/PackagingResponse.php +++ b/lib/models/PackagingResponse.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/lib/models/PrintDocumentRequest.php b/lib/models/PrintDocumentRequest.php index 72cc7e9..0f2987d 100644 --- a/lib/models/PrintDocumentRequest.php +++ b/lib/models/PrintDocumentRequest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/lib/models/PrintDocumentResponse.php b/lib/models/PrintDocumentResponse.php index d621439..0a3efbd 100644 --- a/lib/models/PrintDocumentResponse.php +++ b/lib/models/PrintDocumentResponse.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/lib/models/PrintLabelRequest.php b/lib/models/PrintLabelRequest.php index 89017e6..265911c 100644 --- a/lib/models/PrintLabelRequest.php +++ b/lib/models/PrintLabelRequest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/lib/models/PrintLabelResponse.php b/lib/models/PrintLabelResponse.php index 2452a87..b919189 100644 --- a/lib/models/PrintLabelResponse.php +++ b/lib/models/PrintLabelResponse.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 @@ -74,6 +74,7 @@ class PrintLabelResponse implements ModelInterface, ArrayAccess 'primary1DBarcodeImage' => 'string', 'returnLabelImageFormat' => 'string', 'returnLabelImage' => 'string', +'routing' => '\RoyalMail\Shipping\Rest\Api\models\Routing', 'httpStatusCode' => 'int', 'httpStatusDescription' => 'string', 'message' => 'string', @@ -102,6 +103,7 @@ class PrintLabelResponse implements ModelInterface, ArrayAccess 'primary1DBarcodeImage' => null, 'returnLabelImageFormat' => null, 'returnLabelImage' => null, +'routing' => null, 'httpStatusCode' => 'int32', 'httpStatusDescription' => null, 'message' => null, @@ -151,6 +153,7 @@ public static function swaggerFormats() 'primary1DBarcodeImage' => 'Primary1DBarcodeImage', 'returnLabelImageFormat' => 'ReturnLabelImageFormat', 'returnLabelImage' => 'ReturnLabelImage', +'routing' => 'Routing', 'httpStatusCode' => 'HttpStatusCode', 'httpStatusDescription' => 'HttpStatusDescription', 'message' => 'Message', @@ -179,6 +182,7 @@ public static function swaggerFormats() 'primary1DBarcodeImage' => 'setPrimary1DBarcodeImage', 'returnLabelImageFormat' => 'setReturnLabelImageFormat', 'returnLabelImage' => 'setReturnLabelImage', +'routing' => 'setRouting', 'httpStatusCode' => 'setHttpStatusCode', 'httpStatusDescription' => 'setHttpStatusDescription', 'message' => 'setMessage', @@ -207,6 +211,7 @@ public static function swaggerFormats() 'primary1DBarcodeImage' => 'getPrimary1DBarcodeImage', 'returnLabelImageFormat' => 'getReturnLabelImageFormat', 'returnLabelImage' => 'getReturnLabelImage', +'routing' => 'getRouting', 'httpStatusCode' => 'getHttpStatusCode', 'httpStatusDescription' => 'getHttpStatusDescription', 'message' => 'getMessage', @@ -323,6 +328,7 @@ public function __construct(array $data = null) $this->container['primary1DBarcodeImage'] = isset($data['primary1DBarcodeImage']) ? $data['primary1DBarcodeImage'] : null; $this->container['returnLabelImageFormat'] = isset($data['returnLabelImageFormat']) ? $data['returnLabelImageFormat'] : null; $this->container['returnLabelImage'] = isset($data['returnLabelImage']) ? $data['returnLabelImage'] : null; + $this->container['routing'] = isset($data['routing']) ? $data['routing'] : null; $this->container['httpStatusCode'] = isset($data['httpStatusCode']) ? $data['httpStatusCode'] : null; $this->container['httpStatusDescription'] = isset($data['httpStatusDescription']) ? $data['httpStatusDescription'] : null; $this->container['message'] = isset($data['message']) ? $data['message'] : null; @@ -801,6 +807,30 @@ public function setReturnLabelImage($returnLabelImage) return $this; } + /** + * Gets routing + * + * @return \RoyalMail\Shipping\Rest\Api\models\Routing + */ + public function getRouting() + { + return $this->container['routing']; + } + + /** + * Sets routing + * + * @param \RoyalMail\Shipping\Rest\Api\models\Routing $routing routing + * + * @return $this + */ + public function setRouting($routing) + { + $this->container['routing'] = $routing; + + return $this; + } + /** * Gets httpStatusCode * diff --git a/lib/models/Routing.php b/lib/models/Routing.php index ea4a43b..eb2ba52 100644 --- a/lib/models/Routing.php +++ b/lib/models/Routing.php @@ -1,6 +1,6 @@
It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 @@ -32,7 +32,7 @@ use \RoyalMail\Shipping\Rest\Api\ObjectSerializer; /** - * Packaging Class Doc Comment + * Routing Class Doc Comment * * @category Class * @description Routing attributes for label gazzetter codes @@ -60,7 +60,7 @@ class Routing implements ModelInterface, ArrayAccess 'inwardCode' => 'string', 'outwardCode' => 'string', 'walk' => 'string', -'loop' => 'string' ]; +'loop' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization @@ -71,7 +71,7 @@ class Routing implements ModelInterface, ArrayAccess 'inwardCode' => null, 'outwardCode' => null, 'walk' => null, -'loop' => null ]; +'loop' => null ]; /** * Array of property to type mappings. Used for (de)serialization @@ -114,7 +114,7 @@ public static function swaggerFormats() 'inwardCode' => 'setInwardCode', 'outwardCode' => 'setOutwardCode', 'walk' => 'setWalk', -'loop' => 'setLoop' ]; +'loop' => 'setLoop' ]; /** * Array of attributes to getter functions (for serialization of requests) @@ -125,7 +125,7 @@ public static function swaggerFormats() 'inwardCode' => 'getInwardCode', 'outwardCode' => 'getOutwardCode', 'walk' => 'getWalk', -'loop' => 'getLoop' ]; +'loop' => 'getLoop' ]; /** * Array of attributes where the key is the local name, @@ -168,6 +168,8 @@ public function getModelName() return self::$swaggerModelName; } + + /** * Associative array for storing property values * @@ -239,7 +241,7 @@ public function getInwardCode() /** * Sets inwardCode * - * @param string $inwardCode + * @param string $inwardCode Inward Code
Only populated for Data Stream response where the service requires the Gazetteer codes on the label. * * @return $this */ @@ -249,6 +251,7 @@ public function setInwardCode($inwardCode) return $this; } + /** * Gets outwardCode * @@ -262,7 +265,7 @@ public function getOutwardCode() /** * Sets outwardCode * - * @param string $outwardCode + * @param string $outwardCode Outward Code
Only populated for Data Stream response where the service requires the Gazetteer codes on the label. * * @return $this */ @@ -272,6 +275,7 @@ public function setOutwardCode($outwardCode) return $this; } + /** * Gets walk * @@ -285,7 +289,7 @@ public function getWalk() /** * Sets walk * - * @param string $walk + * @param string $walk Walk
Only populated for Data Stream response where the service requires the Gazetteer codes on the label. * * @return $this */ @@ -295,6 +299,7 @@ public function setWalk($walk) return $this; } + /** * Gets loop * @@ -308,7 +313,7 @@ public function getLoop() /** * Sets loop * - * @param string $loop + * @param string $loop Loop
Only populated for Data Stream response where the service requires the Gazetteer codes on the label. * * @return $this */ @@ -318,7 +323,6 @@ public function setLoop($loop) return $this; } - /** * Returns true if offset exists. False otherwise. * diff --git a/lib/models/ServiceAvailabilityDestination.php b/lib/models/ServiceAvailabilityDestination.php index 131e193..fa2d376 100644 --- a/lib/models/ServiceAvailabilityDestination.php +++ b/lib/models/ServiceAvailabilityDestination.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/lib/models/ServiceAvailabilityFormat.php b/lib/models/ServiceAvailabilityFormat.php index 98d425b..115b9dc 100644 --- a/lib/models/ServiceAvailabilityFormat.php +++ b/lib/models/ServiceAvailabilityFormat.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/lib/models/ServiceAvailabilityOption.php b/lib/models/ServiceAvailabilityOption.php index 70de1c8..ce09505 100644 --- a/lib/models/ServiceAvailabilityOption.php +++ b/lib/models/ServiceAvailabilityOption.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/lib/models/ServiceAvailabilityResponse.php b/lib/models/ServiceAvailabilityResponse.php index 4215199..a4fcd12 100644 --- a/lib/models/ServiceAvailabilityResponse.php +++ b/lib/models/ServiceAvailabilityResponse.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/lib/models/ServiceAvailabilityServiceOptions.php b/lib/models/ServiceAvailabilityServiceOptions.php index f6d30ce..4460f9b 100644 --- a/lib/models/ServiceAvailabilityServiceOptions.php +++ b/lib/models/ServiceAvailabilityServiceOptions.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/lib/models/ServiceAvailabilityShipment.php b/lib/models/ServiceAvailabilityShipment.php index 81a67dd..d8ec115 100644 --- a/lib/models/ServiceAvailabilityShipment.php +++ b/lib/models/ServiceAvailabilityShipment.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/lib/models/ServiceAvailabilityShipmentInformation.php b/lib/models/ServiceAvailabilityShipmentInformation.php index 79e1c14..fedf0b8 100644 --- a/lib/models/ServiceAvailabilityShipmentInformation.php +++ b/lib/models/ServiceAvailabilityShipmentInformation.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/lib/models/ServiceAvailabilityShipmentPackage.php b/lib/models/ServiceAvailabilityShipmentPackage.php index 6596caa..00beb48 100644 --- a/lib/models/ServiceAvailabilityShipmentPackage.php +++ b/lib/models/ServiceAvailabilityShipmentPackage.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/lib/models/ShipmentCancelRequest.php b/lib/models/ShipmentCancelRequest.php index 7feaaf8..8eeaa6d 100644 --- a/lib/models/ShipmentCancelRequest.php +++ b/lib/models/ShipmentCancelRequest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/lib/models/ShipmentCreateResponse.php b/lib/models/ShipmentCreateResponse.php index 7d959e9..18c71a7 100644 --- a/lib/models/ShipmentCreateResponse.php +++ b/lib/models/ShipmentCreateResponse.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 @@ -398,7 +398,7 @@ public function setPackages($packages) return $this; } - + /** * Gets routing * @@ -412,7 +412,7 @@ public function getRouting() /** * Sets routing * - * @param \RoyalMail\Shipping\Rest\Api\models\Routing + * @param \RoyalMail\Shipping\Rest\Api\models\Routing $routing routing * * @return $this */ @@ -493,7 +493,7 @@ public function getCustomsDocuments() /** * Sets customsDocuments * - * @param string $customsDocuments Customs Documents
Base 64 encoded PDF
Any customs documents that have been created as a result of the request. + * @param string $customsDocuments Customs Documents
Any customs documents that have been created as a result of the request.
Depends on Label Image Format.

**PDF**
Base 64 encoded PDF

**PNG**
Base 64 encoded PNG

**ZPL 300 / 203 dpi**
Base 64 encoded PRN (text file)

**Data stream**
Not Included - see Packages for Data Stream responses * * @return $this */ diff --git a/lib/models/ShipmentDeferRequest.php b/lib/models/ShipmentDeferRequest.php index 46ef4b4..5e12948 100644 --- a/lib/models/ShipmentDeferRequest.php +++ b/lib/models/ShipmentDeferRequest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 @@ -66,7 +66,7 @@ class ShipmentDeferRequest implements ModelInterface, ArrayAccess * @var string[] */ protected static $swaggerFormats = [ - 'shipmentId' => 'string', + 'shipmentId' => null, 'shipmentDate' => 'date' ]; /** @@ -246,7 +246,7 @@ public function getShipmentDate() /** * Sets shipmentDate * - * @param \DateTime $shipmentDate Shipment Date
Date of despatch – YYYY-MM-DD
Cannot be in the past. Max 28 days in the future. + * @param \DateTime $shipmentDate Shipment Date
Date of despatch - YYYY-MM-DD
Cannot be in the past. Max 28 days in the future. * * @return $this */ diff --git a/lib/models/ShipmentHoldRequest.php b/lib/models/ShipmentHoldRequest.php index 2e7576e..cdec629 100644 --- a/lib/models/ShipmentHoldRequest.php +++ b/lib/models/ShipmentHoldRequest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/lib/models/ShipmentItem.php b/lib/models/ShipmentItem.php index 1fba8e2..9fb7890 100644 --- a/lib/models/ShipmentItem.php +++ b/lib/models/ShipmentItem.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/lib/models/ShipmentsCancelResponse.php b/lib/models/ShipmentsCancelResponse.php index ed7b668..c5fa8db 100644 --- a/lib/models/ShipmentsCancelResponse.php +++ b/lib/models/ShipmentsCancelResponse.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/lib/models/ShipmentsDeferResponse.php b/lib/models/ShipmentsDeferResponse.php index 3c1e64d..628340c 100644 --- a/lib/models/ShipmentsDeferResponse.php +++ b/lib/models/ShipmentsDeferResponse.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/lib/models/ShipmentsHoldResponse.php b/lib/models/ShipmentsHoldResponse.php index 0f1bca1..e406a0b 100644 --- a/lib/models/ShipmentsHoldResponse.php +++ b/lib/models/ShipmentsHoldResponse.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/lib/models/ShipmentsReleaseRequest.php b/lib/models/ShipmentsReleaseRequest.php index 578f4db..4bd2827 100644 --- a/lib/models/ShipmentsReleaseRequest.php +++ b/lib/models/ShipmentsReleaseRequest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/lib/models/ShipmentsReleaseResponse.php b/lib/models/ShipmentsReleaseResponse.php index 3346dde..2916998 100644 --- a/lib/models/ShipmentsReleaseResponse.php +++ b/lib/models/ShipmentsReleaseResponse.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/lib/models/Shipper.php b/lib/models/Shipper.php index bccdffe..d61e4de 100644 --- a/lib/models/Shipper.php +++ b/lib/models/Shipper.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 @@ -59,6 +59,7 @@ class Shipper implements ModelInterface, ArrayAccess protected static $swaggerTypes = [ 'addressId' => 'string', 'shipperReference' => 'string', +'shipperReference2' => 'string', 'shipperDepartment' => 'string', 'companyName' => 'string', 'contactName' => 'string', @@ -81,6 +82,7 @@ class Shipper implements ModelInterface, ArrayAccess protected static $swaggerFormats = [ 'addressId' => null, 'shipperReference' => null, +'shipperReference2' => null, 'shipperDepartment' => null, 'companyName' => null, 'contactName' => null, @@ -124,6 +126,7 @@ public static function swaggerFormats() protected static $attributeMap = [ 'addressId' => 'AddressId', 'shipperReference' => 'ShipperReference', +'shipperReference2' => 'ShipperReference2', 'shipperDepartment' => 'ShipperDepartment', 'companyName' => 'CompanyName', 'contactName' => 'ContactName', @@ -146,6 +149,7 @@ public static function swaggerFormats() protected static $setters = [ 'addressId' => 'setAddressId', 'shipperReference' => 'setShipperReference', +'shipperReference2' => 'setShipperReference2', 'shipperDepartment' => 'setShipperDepartment', 'companyName' => 'setCompanyName', 'contactName' => 'setContactName', @@ -168,6 +172,7 @@ public static function swaggerFormats() protected static $getters = [ 'addressId' => 'getAddressId', 'shipperReference' => 'getShipperReference', +'shipperReference2' => 'getShipperReference2', 'shipperDepartment' => 'getShipperDepartment', 'companyName' => 'getCompanyName', 'contactName' => 'getContactName', @@ -242,6 +247,7 @@ public function __construct(array $data = null) { $this->container['addressId'] = isset($data['addressId']) ? $data['addressId'] : null; $this->container['shipperReference'] = isset($data['shipperReference']) ? $data['shipperReference'] : null; + $this->container['shipperReference2'] = isset($data['shipperReference2']) ? $data['shipperReference2'] : null; $this->container['shipperDepartment'] = isset($data['shipperDepartment']) ? $data['shipperDepartment'] : null; $this->container['companyName'] = isset($data['companyName']) ? $data['companyName'] : null; $this->container['contactName'] = isset($data['contactName']) ? $data['contactName'] : null; @@ -329,6 +335,30 @@ public function setShipperReference($shipperReference) return $this; } + /** + * Gets shipperReference2 + * + * @return string + */ + public function getShipperReference2() + { + return $this->container['shipperReference2']; + } + + /** + * Sets shipperReference2 + * + * @param string $shipperReference2 Shipper Reference 2
Your second reference for this shipment. This field is used for tracking shipment usually the EBAY VTN number provided to the consumer.
Optional + * + * @return $this + */ + public function setShipperReference2($shipperReference2) + { + $this->container['shipperReference2'] = $shipperReference2; + + return $this; + } + /** * Gets shipperDepartment * diff --git a/test/Api/AddressesApiTest.php b/test/Api/AddressesApiTest.php index 6344014..e130d82 100644 --- a/test/Api/AddressesApiTest.php +++ b/test/Api/AddressesApiTest.php @@ -12,9 +12,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Api/ItemsApiTest.php b/test/Api/ItemsApiTest.php index ff60d00..9836842 100644 --- a/test/Api/ItemsApiTest.php +++ b/test/Api/ItemsApiTest.php @@ -12,9 +12,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Api/ManifestsApiTest.php b/test/Api/ManifestsApiTest.php index a94effd..5d692f1 100644 --- a/test/Api/ManifestsApiTest.php +++ b/test/Api/ManifestsApiTest.php @@ -12,9 +12,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Api/PackagingApiTest.php b/test/Api/PackagingApiTest.php index 1ff2aef..99bcf61 100644 --- a/test/Api/PackagingApiTest.php +++ b/test/Api/PackagingApiTest.php @@ -12,9 +12,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Api/ShipmentsApiTest.php b/test/Api/ShipmentsApiTest.php index b9f5c57..42382ef 100644 --- a/test/Api/ShipmentsApiTest.php +++ b/test/Api/ShipmentsApiTest.php @@ -12,9 +12,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Api/TokenApiTest.php b/test/Api/TokenApiTest.php index 1546c1a..6d385ad 100644 --- a/test/Api/TokenApiTest.php +++ b/test/Api/TokenApiTest.php @@ -12,9 +12,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Model/AddressResponseTest.php b/test/Model/AddressResponseTest.php index 120cf23..61d1c65 100644 --- a/test/Model/AddressResponseTest.php +++ b/test/Model/AddressResponseTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Model/AddressTest.php b/test/Model/AddressTest.php index 5728c9f..e9e3058 100644 --- a/test/Model/AddressTest.php +++ b/test/Model/AddressTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Model/CreateShipmentCustomsInformationTest.php b/test/Model/CreateShipmentCustomsInformationTest.php new file mode 100644 index 0000000..eaa3366 --- /dev/null +++ b/test/Model/CreateShipmentCustomsInformationTest.php @@ -0,0 +1,140 @@ +
It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 @@ -32,7 +32,7 @@ * CreateShipmentDestinationTest Class Doc Comment * * @category Class - * @description The destination address and contact details.<br />It is the shipper’s responsibility to provide accurate and concise information to ensure the best possible delivery experience for the consumer. + * @description The destination address and contact details.<br />It is the shipper???s responsibility to provide accurate and concise information to ensure the best possible delivery experience for the consumer. * @package RoyalMail\Shipping\Rest\Api * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen diff --git a/test/Model/CreateShipmentServiceOptionsTest.php b/test/Model/CreateShipmentServiceOptionsTest.php index f935a69..fbb8404 100644 --- a/test/Model/CreateShipmentServiceOptionsTest.php +++ b/test/Model/CreateShipmentServiceOptionsTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Model/CreateShipmentShipmentInformationTest.php b/test/Model/CreateShipmentShipmentInformationTest.php index bb8561a..b818bed 100644 --- a/test/Model/CreateShipmentShipmentInformationTest.php +++ b/test/Model/CreateShipmentShipmentInformationTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 @@ -152,6 +152,13 @@ public function testPropertyCurrency() { } + /** + * Test attribute "incoterms" + */ + public function testPropertyIncoterms() + { + } + /** * Test attribute "labelFormat" */ diff --git a/test/Model/CreateShipmentShipmentPackageTest.php b/test/Model/CreateShipmentShipmentPackageTest.php index a5558cd..b8d0159 100644 --- a/test/Model/CreateShipmentShipmentPackageTest.php +++ b/test/Model/CreateShipmentShipmentPackageTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Model/CreateShipmentShipmentTest.php b/test/Model/CreateShipmentShipmentTest.php index b2602f4..be1816b 100644 --- a/test/Model/CreateShipmentShipmentTest.php +++ b/test/Model/CreateShipmentShipmentTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 @@ -95,4 +95,11 @@ public function testPropertyDestination() public function testPropertyShipmentInformation() { } + + /** + * Test attribute "customsInformation" + */ + public function testPropertyCustomsInformation() + { + } } diff --git a/test/Model/ErrorDetailTest.php b/test/Model/ErrorDetailTest.php index c53fd94..27ddf7c 100644 --- a/test/Model/ErrorDetailTest.php +++ b/test/Model/ErrorDetailTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Model/ItemResponseTest.php b/test/Model/ItemResponseTest.php index 81db116..e568517 100644 --- a/test/Model/ItemResponseTest.php +++ b/test/Model/ItemResponseTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Model/ItemTest.php b/test/Model/ItemTest.php index 0f932f3..eb06eeb 100644 --- a/test/Model/ItemTest.php +++ b/test/Model/ItemTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Model/ManifestCarrierCodesRequestTest.php b/test/Model/ManifestCarrierCodesRequestTest.php index 732a54d..cd89eb4 100644 --- a/test/Model/ManifestCarrierCodesRequestTest.php +++ b/test/Model/ManifestCarrierCodesRequestTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Model/ManifestRequestTest.php b/test/Model/ManifestRequestTest.php index cebed90..17ba500 100644 --- a/test/Model/ManifestRequestTest.php +++ b/test/Model/ManifestRequestTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Model/ManifestResponseTest.php b/test/Model/ManifestResponseTest.php index 46687af..a9f349f 100644 --- a/test/Model/ManifestResponseTest.php +++ b/test/Model/ManifestResponseTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Model/ManifestServiceCodesRequestTest.php b/test/Model/ManifestServiceCodesRequestTest.php index 5f1dcf9..4e6c6b6 100644 --- a/test/Model/ManifestServiceCodesRequestTest.php +++ b/test/Model/ManifestServiceCodesRequestTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Model/ManifestTest.php b/test/Model/ManifestTest.php index 1960975..b63bcab 100644 --- a/test/Model/ManifestTest.php +++ b/test/Model/ManifestTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Model/PackageResponseTest.php b/test/Model/PackageResponseTest.php index 10c1057..f7fb5b3 100644 --- a/test/Model/PackageResponseTest.php +++ b/test/Model/PackageResponseTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Model/PackagingResponseTest.php b/test/Model/PackagingResponseTest.php index f8087be..6d33d78 100644 --- a/test/Model/PackagingResponseTest.php +++ b/test/Model/PackagingResponseTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Model/PackagingTest.php b/test/Model/PackagingTest.php index 3d35845..81d4f7d 100644 --- a/test/Model/PackagingTest.php +++ b/test/Model/PackagingTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Model/PrintDocumentRequestTest.php b/test/Model/PrintDocumentRequestTest.php index 90185ac..fefb31e 100644 --- a/test/Model/PrintDocumentRequestTest.php +++ b/test/Model/PrintDocumentRequestTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Model/PrintDocumentResponseTest.php b/test/Model/PrintDocumentResponseTest.php index fcdc8b3..f6b555d 100644 --- a/test/Model/PrintDocumentResponseTest.php +++ b/test/Model/PrintDocumentResponseTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Model/PrintLabelRequestTest.php b/test/Model/PrintLabelRequestTest.php index 55c1456..41d33f3 100644 --- a/test/Model/PrintLabelRequestTest.php +++ b/test/Model/PrintLabelRequestTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Model/PrintLabelResponseTest.php b/test/Model/PrintLabelResponseTest.php index 9d32e5b..8b5300a 100644 --- a/test/Model/PrintLabelResponseTest.php +++ b/test/Model/PrintLabelResponseTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 @@ -194,6 +194,13 @@ public function testPropertyReturnLabelImage() { } + /** + * Test attribute "routing" + */ + public function testPropertyRouting() + { + } + /** * Test attribute "httpStatusCode" */ diff --git a/test/Model/RoutingTest.php b/test/Model/RoutingTest.php new file mode 100644 index 0000000..b481c5e --- /dev/null +++ b/test/Model/RoutingTest.php @@ -0,0 +1,105 @@ +
It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Model/ServiceAvailabilityFormatTest.php b/test/Model/ServiceAvailabilityFormatTest.php index 887f55a..42052ae 100644 --- a/test/Model/ServiceAvailabilityFormatTest.php +++ b/test/Model/ServiceAvailabilityFormatTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Model/ServiceAvailabilityOptionTest.php b/test/Model/ServiceAvailabilityOptionTest.php index d65faf1..3bfa596 100644 --- a/test/Model/ServiceAvailabilityOptionTest.php +++ b/test/Model/ServiceAvailabilityOptionTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Model/ServiceAvailabilityResponseTest.php b/test/Model/ServiceAvailabilityResponseTest.php index d96a77a..cf82ec1 100644 --- a/test/Model/ServiceAvailabilityResponseTest.php +++ b/test/Model/ServiceAvailabilityResponseTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Model/ServiceAvailabilityServiceOptionsTest.php b/test/Model/ServiceAvailabilityServiceOptionsTest.php index 9f1ccb5..be0c900 100644 --- a/test/Model/ServiceAvailabilityServiceOptionsTest.php +++ b/test/Model/ServiceAvailabilityServiceOptionsTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Model/ServiceAvailabilityShipmentInformationTest.php b/test/Model/ServiceAvailabilityShipmentInformationTest.php index eb424b7..a6a1df6 100644 --- a/test/Model/ServiceAvailabilityShipmentInformationTest.php +++ b/test/Model/ServiceAvailabilityShipmentInformationTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Model/ServiceAvailabilityShipmentPackageTest.php b/test/Model/ServiceAvailabilityShipmentPackageTest.php index 5187316..2d0f34e 100644 --- a/test/Model/ServiceAvailabilityShipmentPackageTest.php +++ b/test/Model/ServiceAvailabilityShipmentPackageTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Model/ServiceAvailabilityShipmentTest.php b/test/Model/ServiceAvailabilityShipmentTest.php index 79f1085..44a324c 100644 --- a/test/Model/ServiceAvailabilityShipmentTest.php +++ b/test/Model/ServiceAvailabilityShipmentTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Model/ShipmentCancelRequestTest.php b/test/Model/ShipmentCancelRequestTest.php index 0b48d3f..9eb6ee1 100644 --- a/test/Model/ShipmentCancelRequestTest.php +++ b/test/Model/ShipmentCancelRequestTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Model/ShipmentCreateResponseTest.php b/test/Model/ShipmentCreateResponseTest.php index c1d0ade..b272dae 100644 --- a/test/Model/ShipmentCreateResponseTest.php +++ b/test/Model/ShipmentCreateResponseTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 @@ -96,6 +96,13 @@ public function testPropertyPackages() { } + /** + * Test attribute "routing" + */ + public function testPropertyRouting() + { + } + /** * Test attribute "labelImageFormat" */ diff --git a/test/Model/ShipmentDeferRequestTest.php b/test/Model/ShipmentDeferRequestTest.php index 7a6fafe..1b97624 100644 --- a/test/Model/ShipmentDeferRequestTest.php +++ b/test/Model/ShipmentDeferRequestTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Model/ShipmentHoldRequestTest.php b/test/Model/ShipmentHoldRequestTest.php index aaad311..d02990d 100644 --- a/test/Model/ShipmentHoldRequestTest.php +++ b/test/Model/ShipmentHoldRequestTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Model/ShipmentItemTest.php b/test/Model/ShipmentItemTest.php index fd41a98..3a387ca 100644 --- a/test/Model/ShipmentItemTest.php +++ b/test/Model/ShipmentItemTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Model/ShipmentsCancelResponseTest.php b/test/Model/ShipmentsCancelResponseTest.php index 2af9050..9db919e 100644 --- a/test/Model/ShipmentsCancelResponseTest.php +++ b/test/Model/ShipmentsCancelResponseTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Model/ShipmentsDeferResponseTest.php b/test/Model/ShipmentsDeferResponseTest.php index 975004b..1186fe2 100644 --- a/test/Model/ShipmentsDeferResponseTest.php +++ b/test/Model/ShipmentsDeferResponseTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Model/ShipmentsHoldResponseTest.php b/test/Model/ShipmentsHoldResponseTest.php index 48874cc..ef72593 100644 --- a/test/Model/ShipmentsHoldResponseTest.php +++ b/test/Model/ShipmentsHoldResponseTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Model/ShipmentsReleaseRequestTest.php b/test/Model/ShipmentsReleaseRequestTest.php index 60555f1..f143df6 100644 --- a/test/Model/ShipmentsReleaseRequestTest.php +++ b/test/Model/ShipmentsReleaseRequestTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Model/ShipmentsReleaseResponseTest.php b/test/Model/ShipmentsReleaseResponseTest.php index 63f425e..a1c59d4 100644 --- a/test/Model/ShipmentsReleaseResponseTest.php +++ b/test/Model/ShipmentsReleaseResponseTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 diff --git a/test/Model/ShipperTest.php b/test/Model/ShipperTest.php index b342f54..ab68d88 100644 --- a/test/Model/ShipperTest.php +++ b/test/Model/ShipperTest.php @@ -13,9 +13,9 @@ /** * Royal Mail API Shipping V3 (REST) * - * This API specification details the requirements for integrating with **Royal Mail API Shipping V3**.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. + * API Shipping V3 (REST) provides the functionality for customers to take a shipping transaction from creation to collection. It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services. Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic and international items with Royal Mail. Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers??? own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler. This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help. * - * OpenAPI spec version: 3.0.12 + * OpenAPI spec version: 3.0.20 * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.8 @@ -89,6 +89,13 @@ public function testPropertyShipperReference() { } + /** + * Test attribute "shipperReference2" + */ + public function testPropertyShipperReference2() + { + } + /** * Test attribute "shipperDepartment" */