yellowgrid-api-ts 3.2.231-dev.0 → 3.2.232-dev.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/api.ts +1697 -1675
- package/dist/api.d.ts +1666 -1666
- package/dist/api.js +90 -68
- package/docs/AbstractOrderRequestDTO.md +4 -4
- package/docs/AccountAddressesDTO.md +3 -3
- package/docs/AccountContactEntity.md +13 -13
- package/docs/AccountContactModel.md +13 -13
- package/docs/AccountContactRequestModel.md +9 -9
- package/docs/AccountDetailedSummaryDTO.md +9 -9
- package/docs/AccountFinanceDTO.md +10 -10
- package/docs/AccountRequestModel.md +11 -11
- package/docs/AccountSummaryDTO.md +3 -3
- package/docs/AccountsResponseModel.md +4 -4
- package/docs/AddressDTO.md +6 -6
- package/docs/AddressModel.md +5 -5
- package/docs/AddressRequestModel.md +4 -4
- package/docs/AdminCustomerRmasModel.md +4 -4
- package/docs/AdminNumberPortDTO.md +7 -7
- package/docs/AdminOrderRequestDTO.md +4 -4
- package/docs/AdminRmaDTO.md +19 -19
- package/docs/AdminRmaItemDTO.md +6 -6
- package/docs/AdminRmaNoteDTO.md +4 -4
- package/docs/AdminRmaSummaryDTO.md +6 -6
- package/docs/AdminUserModel.md +5 -5
- package/docs/AgentHoursGraphModel.md +4 -4
- package/docs/AgentHoursGraphMonthModel.md +2 -2
- package/docs/ApiLogEntity.md +12 -12
- package/docs/AreaCodeModel.md +2 -2
- package/docs/AttachmentModel.md +5 -5
- package/docs/AttributeSetEnum.md +2 -2
- package/docs/AuditLogEntity.md +9 -9
- package/docs/AuthCodeResponseModel.md +1 -1
- package/docs/AxisDataDTO.md +1 -1
- package/docs/BasicItemDTO.md +2 -2
- package/docs/BasicProductDTO.md +2 -2
- package/docs/BatchDTO.md +17 -17
- package/docs/BatchEntity.md +17 -17
- package/docs/CallBarringModel.md +5 -5
- package/docs/ClientDetailsModel.md +7 -7
- package/docs/ClientModel.md +4 -4
- package/docs/CompanyContractModel.md +5 -5
- package/docs/ContactInfoModel.md +5 -5
- package/docs/ConversationModel.md +8 -8
- package/docs/CourierPriceEntity.md +10 -10
- package/docs/CreditAccountEntity.md +23 -23
- package/docs/CreditNoteDTO.md +1 -1
- package/docs/CreditNoteEntity.md +5 -5
- package/docs/CreditNoteItemDTO.md +1 -1
- package/docs/CreditNoteItemEntity.md +6 -6
- package/docs/CreditNoteItemModel.md +6 -6
- package/docs/CreditNoteModel.md +5 -5
- package/docs/CrmActivitiesResponseDTO.md +2 -2
- package/docs/CrmActivityDTO.md +3 -3
- package/docs/CrmContactDTO.md +7 -7
- package/docs/CrmDateActivitiesDTO.md +1 -1
- package/docs/CrmNoteEntity.md +10 -10
- package/docs/CrmNoteModel.md +10 -10
- package/docs/CustomerCoordinatesDTO.md +5 -5
- package/docs/CustomerInformationModel.md +4 -4
- package/docs/CustomerItemRequestDTO.md +2 -2
- package/docs/CustomerListAccountDTO.md +13 -13
- package/docs/CustomerOrderRequestDTO.md +4 -4
- package/docs/CustomerPriceListEnum.md +2 -2
- package/docs/CustomerRmasModel.md +4 -4
- package/docs/CustomerSummaryReportDTO.md +6 -6
- package/docs/DdiRangeRequestModel.md +3 -3
- package/docs/DdiRangesRequestModel.md +1 -1
- package/docs/DetailedItemRequestDTO.md +2 -2
- package/docs/DetailedOrderRequestDTO.md +4 -4
- package/docs/DivertRequestModel.md +1 -1
- package/docs/DivertResponseModel.md +2 -2
- package/docs/EdTechProClientEntity.md +4 -4
- package/docs/EdTechProSchoolModel.md +11 -11
- package/docs/EdTechProSchoolsModel.md +4 -4
- package/docs/EdTechProSetupModel.md +5 -5
- package/docs/EmailRequestModel.md +1 -1
- package/docs/EventDTO.md +8 -8
- package/docs/EventRequestDTO.md +3 -3
- package/docs/EventSubscriptionModel.md +2 -2
- package/docs/EventUpdateDTO.md +4 -4
- package/docs/EventUpdateEntity.md +5 -5
- package/docs/EventUpdateRequestDTO.md +3 -3
- package/docs/ExpiringKeyDTO.md +5 -5
- package/docs/FraudManagementModel.md +2 -2
- package/docs/FreshdeskCompanyTicketsModel.md +4 -4
- package/docs/FreshdeskTicketEntity.md +6 -6
- package/docs/FtpAccountsEntity.md +5 -5
- package/docs/GenericFileModel.md +3 -3
- package/docs/GraphDTO.md +6 -6
- package/docs/HostingChangeResponseModel.md +5 -5
- package/docs/HostingRegionDTO.md +3 -3
- package/docs/InstallationDetailsDTO.md +3 -3
- package/docs/InstanceAutoFailoverEntity.md +5 -5
- package/docs/InstanceDeletionScheduleEntity.md +4 -4
- package/docs/InstanceEntity.md +21 -21
- package/docs/InstanceFailoverEntity.md +11 -11
- package/docs/InstanceMonitoringEntity.md +3 -3
- package/docs/InstanceMonitoringLogEntity.md +6 -6
- package/docs/InstanceScheduledTasksEntity.md +6 -6
- package/docs/InstanceTcxDetailsEntity.md +10 -10
- package/docs/InstanceUserCredentialsEntity.md +5 -5
- package/docs/ItemDTO.md +2 -2
- package/docs/ItemDiscountEntity.md +6 -6
- package/docs/ItemEntity.md +21 -21
- package/docs/ItemResolutionRequestModel.md +1 -1
- package/docs/LinkedOrderEntity.md +2 -2
- package/docs/MFARequiredModel.md +2 -2
- package/docs/MacAddressDTO.md +2 -2
- package/docs/MacAddressRequestModel.md +1 -1
- package/docs/MonthlyUsageModel.md +2 -2
- package/docs/MultiTenantChangeResponseModel.md +4 -4
- package/docs/NameRequestModel.md +1 -1
- package/docs/NavigationModel.md +4 -4
- package/docs/NoteRequestModel.md +1 -1
- package/docs/NumberPortDTO.md +7 -7
- package/docs/NumberPortNoteDTO.md +5 -5
- package/docs/NumberPortRangeDTO.md +2 -2
- package/docs/NumberPortingApi.md +21 -21
- package/docs/NumberPortsModel.md +4 -4
- package/docs/OfflineInstancesEntity.md +5 -5
- package/docs/OrderDTO.md +3 -3
- package/docs/OrderDetailsDTO.md +10 -10
- package/docs/OrderEntity.md +56 -56
- package/docs/OrderItemDTO.md +2 -2
- package/docs/OrderRequestModel.md +6 -6
- package/docs/OrderSummariesModel.md +4 -4
- package/docs/OrderSummaryDTO.md +10 -10
- package/docs/OrderTotalModel.md +7 -7
- package/docs/OrderedItemEntity.md +14 -14
- package/docs/OrderedItemModel.md +14 -14
- package/docs/PartnerDTO.md +10 -10
- package/docs/PasswordSenderDTO.md +2 -2
- package/docs/PasswordSenderEntity.md +7 -7
- package/docs/PortalAccountModel.md +23 -23
- package/docs/PortalLoginModel.md +7 -7
- package/docs/PostGenerateReport200Response.md +8 -8
- package/docs/PriceListItemModel.md +2 -2
- package/docs/PrinterEntity.md +5 -5
- package/docs/PrizesEntity.md +6 -6
- package/docs/ProductDetailedSummaryDTO.md +2 -2
- package/docs/ProductPriceListItemModel.md +2 -2
- package/docs/ProductSearchResultsModel.md +1 -1
- package/docs/ProductSerialInfoDTO.md +4 -4
- package/docs/ProductSerialInfoModel.md +3 -3
- package/docs/ProductSummaryDTO.md +2 -2
- package/docs/PromoCodesEntity.md +12 -12
- package/docs/PromoItemsEntity.md +8 -8
- package/docs/ProspectDTO.md +7 -7
- package/docs/ProspectEntity.md +11 -11
- package/docs/ProvisioningModel.md +3 -3
- package/docs/ProvisioningRequestEntity.md +3 -3
- package/docs/ReasonRequestModel.md +1 -1
- package/docs/RecordingBackupAzureModel.md +4 -4
- package/docs/RemoteStorageDTO.md +4 -4
- package/docs/ReportRequestDTO.md +1 -1
- package/docs/ResolutionRequestModel.md +1 -1
- package/docs/ResourceNotReadyException.md +3 -3
- package/docs/RmaCollectionDTO.md +4 -4
- package/docs/RmaCreditItemRequestDTO.md +3 -3
- package/docs/RmaDTO.md +12 -12
- package/docs/RmaItemDTO.md +6 -6
- package/docs/RmaItemRequestDTO.md +1 -1
- package/docs/RmaOrderDTO.md +3 -3
- package/docs/RmaOrderItemDTO.md +9 -9
- package/docs/RmaOrderSummaryDTO.md +3 -3
- package/docs/RmaReplacementOrderItemDTO.md +2 -2
- package/docs/RmaReplacementOrderRequestDTO.md +1 -1
- package/docs/RmaRequestDTO.md +8 -8
- package/docs/RmaReturnDTO.md +6 -6
- package/docs/RmaSummaryDTO.md +6 -6
- package/docs/RmaSummaryItemDTO.md +2 -2
- package/docs/RootAccessModel.md +3 -3
- package/docs/S3BucketEntity.md +4 -4
- package/docs/ScannedItemModel.md +1 -1
- package/docs/ScopeModel.md +2 -2
- package/docs/SerialNumberRequestModel.md +1 -1
- package/docs/SeriesDTO.md +3 -3
- package/docs/ServiceHealthDTO.md +2 -2
- package/docs/ServiceStatusDTO.md +4 -4
- package/docs/ShipmentAddressEntity.md +11 -11
- package/docs/ShipmentDTO.md +4 -4
- package/docs/ShipmentEntity.md +12 -12
- package/docs/ShipmentItemDTO.md +2 -2
- package/docs/ShipmentItemEntity.md +5 -5
- package/docs/ShipmentItemModel.md +5 -5
- package/docs/ShipmentModel.md +12 -12
- package/docs/ShipmentRequestDTO.md +4 -4
- package/docs/ShippingConsignmentModel.md +4 -4
- package/docs/ShippingInformationDTO.md +3 -3
- package/docs/ShippingRequestDTO.md +3 -3
- package/docs/ShippingServiceDTO.md +2 -2
- package/docs/ShippingServiceModel.md +4 -4
- package/docs/ShippingServicesModel.md +1 -1
- package/docs/SipTrunkChangeResponseModel.md +5 -5
- package/docs/SipTrunkCreationRequestModel.md +6 -6
- package/docs/SipTrunkEntity.md +12 -12
- package/docs/SipTrunksResponseModel.md +4 -4
- package/docs/SmsAccountDTO.md +6 -6
- package/docs/SmsAccountEntity.md +6 -6
- package/docs/SmsAccountRequestDTO.md +5 -5
- package/docs/SmsDataModel.md +1 -1
- package/docs/SmsMessageModel.md +3 -3
- package/docs/SmsNumbersEntity.md +2 -2
- package/docs/SmsPayloadModel.md +3 -3
- package/docs/SmsPhoneNumberModel.md +1 -1
- package/docs/SmsResponseModel.md +3 -3
- package/docs/SmsWhitelistEntity.md +2 -2
- package/docs/StockOrderCourierEntity.md +4 -4
- package/docs/StockOrderDeductionModel.md +4 -4
- package/docs/StockOrderDeductionRequestModel.md +2 -2
- package/docs/StockOrderDeductionsEntity.md +4 -4
- package/docs/StockOrderEntity.md +22 -22
- package/docs/StockOrderItemEntity.md +7 -7
- package/docs/StockOrderItemModel.md +7 -7
- package/docs/StockOrderItemRequestModel.md +4 -4
- package/docs/StockOrderModel.md +14 -14
- package/docs/StockOrderProductEntity.md +6 -6
- package/docs/StockOrderRequestModel.md +3 -3
- package/docs/StockOrderSupplierEntity.md +9 -9
- package/docs/StockOrderSupplierModel.md +9 -9
- package/docs/StockOrdersModel.md +4 -4
- package/docs/StockProductModel.md +6 -6
- package/docs/StockProductPriceModel.md +1 -1
- package/docs/StockProductSummariesModel.md +4 -4
- package/docs/StockProductSummaryModel.md +6 -6
- package/docs/StockReportItemModel.md +6 -6
- package/docs/StockReportModel.md +5 -5
- package/docs/StockTransactionsEntity.md +8 -8
- package/docs/SupplierEntity.md +9 -9
- package/docs/SupplierItemEntity.md +8 -8
- package/docs/SupplierItemModel.md +8 -8
- package/docs/SupplierItemsResultsDTO.md +1 -1
- package/docs/SupplierModel.md +9 -9
- package/docs/SupplierProductModel.md +3 -3
- package/docs/SupplierProductResultsModel.md +4 -4
- package/docs/SupportTicketModel.md +10 -10
- package/docs/TableDTO.md +3 -3
- package/docs/TableDataDTO.md +1 -1
- package/docs/TableHistoryEntity.md +8 -8
- package/docs/TableRowDTO.md +1 -1
- package/docs/TcxBackupEntity.md +9 -9
- package/docs/TcxBackupModel.md +9 -9
- package/docs/TcxBillingEntity.md +10 -10
- package/docs/TcxBulkLicenceDetailsModel.md +2 -2
- package/docs/TcxDeadLicenceEntity.md +3 -3
- package/docs/TcxExtsEntity.md +8 -8
- package/docs/TcxInstallationModel.md +17 -17
- package/docs/TcxInstallationsModel.md +4 -4
- package/docs/TcxKeySummaryDTO.md +3 -3
- package/docs/TcxKeysEntity.md +6 -6
- package/docs/TcxLicenceDetailsErrorModel.md +4 -4
- package/docs/TcxLicenceDetailsModel.md +11 -11
- package/docs/TcxMacsEntity.md +3 -3
- package/docs/TcxMultiTenantModel.md +7 -7
- package/docs/TcxMultiTenantUserModel.md +3 -3
- package/docs/TcxMultiTenantsModel.md +4 -4
- package/docs/TcxNumbersEntity.md +3 -3
- package/docs/TcxOfficeHoursEntity.md +15 -15
- package/docs/TcxPhoneModel.md +6 -6
- package/docs/TcxPhonesEntity.md +6 -6
- package/docs/TcxRemoteStorageModel.md +4 -4
- package/docs/TcxSbcDTO.md +7 -7
- package/docs/TcxSbcEntity.md +16 -16
- package/docs/TcxSbcModel.md +16 -16
- package/docs/TcxSbcResponseDTO.md +2 -2
- package/docs/TcxSetupEntity.md +25 -25
- package/docs/TcxSetupsModel.md +4 -4
- package/docs/TcxSipTrunksEntity.md +13 -13
- package/docs/TcxTemplateXmlEnum.md +2 -2
- package/docs/TcxUsersEntity.md +6 -6
- package/docs/TcxWizardConfigModel.md +2 -2
- package/docs/TcxWizardModel.md +9 -9
- package/docs/TechSupportCompanySummaryDTO.md +5 -5
- package/docs/TicketSummaryModel.md +6 -6
- package/docs/TicketTimeDTO.md +9 -9
- package/docs/TicketsApi.md +10 -10
- package/docs/TokenResponseModel.md +3 -3
- package/docs/UpgradeOrderResponseModel.md +2 -2
- package/docs/UpgradeRequestModel.md +4 -4
- package/docs/UserEntity.md +10 -10
- package/docs/XeroLogEntity.md +10 -10
- package/package.json +1 -1
|
@@ -6,7 +6,7 @@ RMA Resolution Request Model
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**resolution** | **number** | RMA Reason | [
|
|
9
|
+
**resolution** | **number** | RMA Reason | [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
@@ -6,9 +6,9 @@ Resource Not Ready
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**message** | **string** | Message | [
|
|
10
|
-
**resourceId** | **string** | Resource ID | [
|
|
11
|
-
**status** | **string** | Status | [
|
|
9
|
+
**message** | **string** | Message | [default to undefined]
|
|
10
|
+
**resourceId** | **string** | Resource ID | [default to undefined]
|
|
11
|
+
**status** | **string** | Status | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
package/docs/RmaCollectionDTO.md
CHANGED
|
@@ -6,10 +6,10 @@ RMA Collection Request
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**address** | [**AddressDTO**](AddressDTO.md) | | [
|
|
10
|
-
**boxes** | **number** | Number of boxes | [
|
|
11
|
-
**collectionTimeFrom** | **string** | Date Time | [
|
|
12
|
-
**collectionTimeTo** | **string** | Date Time | [
|
|
9
|
+
**address** | [**AddressDTO**](AddressDTO.md) | | [default to undefined]
|
|
10
|
+
**boxes** | **number** | Number of boxes | [default to undefined]
|
|
11
|
+
**collectionTimeFrom** | **string** | Date Time | [default to undefined]
|
|
12
|
+
**collectionTimeTo** | **string** | Date Time | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -6,9 +6,9 @@ RMA Credit Request Item
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**rmaItemId** | **number** | RMA Item ID | [
|
|
10
|
-
**refundPercentage** | **number** | Refund Percentage | [
|
|
11
|
-
**returnStock** | **boolean** | Return Item to Stock | [
|
|
9
|
+
**rmaItemId** | **number** | RMA Item ID | [default to undefined]
|
|
10
|
+
**refundPercentage** | **number** | Refund Percentage | [default to undefined]
|
|
11
|
+
**returnStock** | **boolean** | Return Item to Stock | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
package/docs/RmaDTO.md
CHANGED
|
@@ -6,19 +6,19 @@ RMA
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | RMA ID | [
|
|
10
|
-
**contactName** | **string** | Contact Name | [
|
|
11
|
-
**contactEmail** | **string** | Contact Email | [
|
|
12
|
-
**orderId** | **number** | Associated Order ID | [
|
|
13
|
-
**reason** | **number** | RMA Reason | [
|
|
14
|
-
**faultReport** | **string** | Fault Report | [
|
|
15
|
-
**ticketId** | **number** | Ticket ID | [
|
|
16
|
-
**resolution** | **number** | RMA Resolution | [
|
|
17
|
-
**status** | **number** | RMA Status | [
|
|
18
|
-
**statusText** | **string** | RMA Status Text | [
|
|
19
|
-
**approved** | **boolean** | RMA Approval Status | [
|
|
9
|
+
**id** | **number** | RMA ID | [default to undefined]
|
|
10
|
+
**contactName** | **string** | Contact Name | [default to undefined]
|
|
11
|
+
**contactEmail** | **string** | Contact Email | [default to undefined]
|
|
12
|
+
**orderId** | **number** | Associated Order ID | [default to undefined]
|
|
13
|
+
**reason** | **number** | RMA Reason | [default to undefined]
|
|
14
|
+
**faultReport** | **string** | Fault Report | [default to undefined]
|
|
15
|
+
**ticketId** | **number** | Ticket ID | [default to undefined]
|
|
16
|
+
**resolution** | **number** | RMA Resolution | [default to undefined]
|
|
17
|
+
**status** | **number** | RMA Status | [default to undefined]
|
|
18
|
+
**statusText** | **string** | RMA Status Text | [default to undefined]
|
|
19
|
+
**approved** | **boolean** | RMA Approval Status | [default to undefined]
|
|
20
20
|
**address** | [**AddressDTO**](AddressDTO.md) | RMA Return Address | [optional] [default to undefined]
|
|
21
|
-
**items** | [**Array<RmaItemDTO>**](RmaItemDTO.md) | RMA Items | [
|
|
21
|
+
**items** | [**Array<RmaItemDTO>**](RmaItemDTO.md) | RMA Items | [default to undefined]
|
|
22
22
|
|
|
23
23
|
## Example
|
|
24
24
|
|
package/docs/RmaItemDTO.md
CHANGED
|
@@ -6,14 +6,14 @@ RMA Item
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | RMA Item ID | [
|
|
10
|
-
**itemId** | **number** | RMA Order Item ID | [
|
|
11
|
-
**itemName** | **string** | RMA Item Name | [
|
|
9
|
+
**id** | **number** | RMA Item ID | [default to undefined]
|
|
10
|
+
**itemId** | **number** | RMA Order Item ID | [default to undefined]
|
|
11
|
+
**itemName** | **string** | RMA Item Name | [default to undefined]
|
|
12
12
|
**macAddress** | **string** | RMA Item MAC Address | [optional] [default to undefined]
|
|
13
13
|
**serialNumber** | **string** | RMA Item Serial Number | [optional] [default to undefined]
|
|
14
|
-
**received** | **boolean** | RMA Item Received Status | [
|
|
15
|
-
**status** | **number** | RMA Item Status | [
|
|
16
|
-
**statusText** | **string** | RMA Item Status Text | [
|
|
14
|
+
**received** | **boolean** | RMA Item Received Status | [default to undefined]
|
|
15
|
+
**status** | **number** | RMA Item Status | [default to undefined]
|
|
16
|
+
**statusText** | **string** | RMA Item Status Text | [default to undefined]
|
|
17
17
|
|
|
18
18
|
## Example
|
|
19
19
|
|
|
@@ -6,7 +6,7 @@ RMA Request Item
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**itemId** | **number** | RMA Item ID | [
|
|
9
|
+
**itemId** | **number** | RMA Item ID | [default to undefined]
|
|
10
10
|
**macAddress** | **string** | RMA Item MAC Address | [optional] [default to undefined]
|
|
11
11
|
**serialNumber** | **string** | RMA Item Serial Number | [optional] [default to undefined]
|
|
12
12
|
|
package/docs/RmaOrderDTO.md
CHANGED
|
@@ -6,9 +6,9 @@ RMA Order
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | Order ID | [
|
|
10
|
-
**reference** | **string** | Order Reference | [
|
|
11
|
-
**orderDate** | **string** | Date Time | [
|
|
9
|
+
**id** | **number** | Order ID | [default to undefined]
|
|
10
|
+
**reference** | **string** | Order Reference | [default to undefined]
|
|
11
|
+
**orderDate** | **string** | Date Time | [default to undefined]
|
|
12
12
|
**warrantyExpired** | **boolean** | Warranty Expired | [optional] [default to undefined]
|
|
13
13
|
**items** | [**Array<RmaOrderItemDTO>**](RmaOrderItemDTO.md) | RMA Order Items | [optional] [default to undefined]
|
|
14
14
|
|
package/docs/RmaOrderItemDTO.md
CHANGED
|
@@ -6,15 +6,15 @@ RMA Order Item
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**itemId** | **number** | Item ID | [
|
|
10
|
-
**name** | **string** | Item Name | [
|
|
11
|
-
**sku** | **string** | Item Sku | [
|
|
12
|
-
**orderedQuantity** | **number** | Ordered Quantity | [
|
|
13
|
-
**alreadyReturnedQuantity** | **number** | Returned Quantity | [
|
|
14
|
-
**availableReturnQuantity** | **number** | Available Return Quantity | [
|
|
15
|
-
**serialInfo** | [**ProductSerialInfoDTO**](ProductSerialInfoDTO.md) | | [
|
|
16
|
-
**endOfLife** | **boolean** | End of Life | [
|
|
17
|
-
**unlikelyReturn** | **boolean** | Unlikely Return | [
|
|
9
|
+
**itemId** | **number** | Item ID | [default to undefined]
|
|
10
|
+
**name** | **string** | Item Name | [default to undefined]
|
|
11
|
+
**sku** | **string** | Item Sku | [default to undefined]
|
|
12
|
+
**orderedQuantity** | **number** | Ordered Quantity | [default to undefined]
|
|
13
|
+
**alreadyReturnedQuantity** | **number** | Returned Quantity | [default to undefined]
|
|
14
|
+
**availableReturnQuantity** | **number** | Available Return Quantity | [default to undefined]
|
|
15
|
+
**serialInfo** | [**ProductSerialInfoDTO**](ProductSerialInfoDTO.md) | | [default to undefined]
|
|
16
|
+
**endOfLife** | **boolean** | End of Life | [default to undefined]
|
|
17
|
+
**unlikelyReturn** | **boolean** | Unlikely Return | [default to undefined]
|
|
18
18
|
|
|
19
19
|
## Example
|
|
20
20
|
|
|
@@ -6,9 +6,9 @@ RMA Order Summary
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | Order ID | [
|
|
10
|
-
**reference** | **string** | Order Reference | [
|
|
11
|
-
**orderDate** | **string** | Date Time | [
|
|
9
|
+
**id** | **number** | Order ID | [default to undefined]
|
|
10
|
+
**reference** | **string** | Order Reference | [default to undefined]
|
|
11
|
+
**orderDate** | **string** | Date Time | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -6,8 +6,8 @@ RMA Replacement Order Item
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **string** | Replaced RMA Item ID | [
|
|
10
|
-
**sku** | **string** | Replacement RMA Item SKU | [
|
|
9
|
+
**id** | **string** | Replaced RMA Item ID | [default to undefined]
|
|
10
|
+
**sku** | **string** | Replacement RMA Item SKU | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -6,7 +6,7 @@ RMA Replacement Order Request
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**items** | [**Array<RmaReplacementOrderItemDTO>**](RmaReplacementOrderItemDTO.md) | RMA Replacement Order Items | [
|
|
9
|
+
**items** | [**Array<RmaReplacementOrderItemDTO>**](RmaReplacementOrderItemDTO.md) | RMA Replacement Order Items | [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
package/docs/RmaRequestDTO.md
CHANGED
|
@@ -5,14 +5,14 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**contactName** | **string** | Contact Name | [
|
|
9
|
-
**contactEmail** | **string** | Contact Email | [
|
|
10
|
-
**orderId** | **number** | Associated Order ID | [
|
|
11
|
-
**reason** | **number** | RMA Reason | [
|
|
12
|
-
**faultReport** | **string** | Fault Report | [
|
|
13
|
-
**requestedResolution** | **number** | RMA Resolution | [
|
|
14
|
-
**items** | [**Array<RmaItemRequestDTO>**](RmaItemRequestDTO.md) | RMA Items | [
|
|
15
|
-
**address** | [**AddressDTO**](AddressDTO.md) | | [
|
|
8
|
+
**contactName** | **string** | Contact Name | [default to undefined]
|
|
9
|
+
**contactEmail** | **string** | Contact Email | [default to undefined]
|
|
10
|
+
**orderId** | **number** | Associated Order ID | [default to undefined]
|
|
11
|
+
**reason** | **number** | RMA Reason | [default to undefined]
|
|
12
|
+
**faultReport** | **string** | Fault Report | [default to undefined]
|
|
13
|
+
**requestedResolution** | **number** | RMA Resolution | [default to undefined]
|
|
14
|
+
**items** | [**Array<RmaItemRequestDTO>**](RmaItemRequestDTO.md) | RMA Items | [default to undefined]
|
|
15
|
+
**address** | [**AddressDTO**](AddressDTO.md) | | [default to undefined]
|
|
16
16
|
|
|
17
17
|
## Example
|
|
18
18
|
|
package/docs/RmaReturnDTO.md
CHANGED
|
@@ -6,12 +6,12 @@ RMA Return Request
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**address** | [**AddressDTO**](AddressDTO.md) | | [
|
|
10
|
-
**items** | **Array<number>** | RMA Item IDs | [
|
|
11
|
-
**service** | **string** | Shipping Service Code | [
|
|
12
|
-
**boxes** | **number** | Number of boxes to ship | [
|
|
13
|
-
**contactEmail** | **string** | Contact Email | [
|
|
14
|
-
**contactTelephone** | **string** | Contact Telephone | [
|
|
9
|
+
**address** | [**AddressDTO**](AddressDTO.md) | | [default to undefined]
|
|
10
|
+
**items** | **Array<number>** | RMA Item IDs | [default to undefined]
|
|
11
|
+
**service** | **string** | Shipping Service Code | [default to undefined]
|
|
12
|
+
**boxes** | **number** | Number of boxes to ship | [default to undefined]
|
|
13
|
+
**contactEmail** | **string** | Contact Email | [default to undefined]
|
|
14
|
+
**contactTelephone** | **string** | Contact Telephone | [default to undefined]
|
|
15
15
|
|
|
16
16
|
## Example
|
|
17
17
|
|
package/docs/RmaSummaryDTO.md
CHANGED
|
@@ -6,12 +6,12 @@ RMA Summary DTO
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | RMA ID | [
|
|
10
|
-
**orderId** | **number** | Order ID | [
|
|
11
|
-
**orderReference** | **string** | Order Reference | [
|
|
12
|
-
**status** | **number** | RMA Status | [
|
|
13
|
-
**statusText** | **string** | Status Text | [
|
|
14
|
-
**items** | [**Array<RmaSummaryItemDTO>**](RmaSummaryItemDTO.md) | RMA Summary Items | [
|
|
9
|
+
**id** | **number** | RMA ID | [default to undefined]
|
|
10
|
+
**orderId** | **number** | Order ID | [default to undefined]
|
|
11
|
+
**orderReference** | **string** | Order Reference | [default to undefined]
|
|
12
|
+
**status** | **number** | RMA Status | [default to undefined]
|
|
13
|
+
**statusText** | **string** | Status Text | [default to undefined]
|
|
14
|
+
**items** | [**Array<RmaSummaryItemDTO>**](RmaSummaryItemDTO.md) | RMA Summary Items | [default to undefined]
|
|
15
15
|
|
|
16
16
|
## Example
|
|
17
17
|
|
|
@@ -6,8 +6,8 @@ RMA Item Summary
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**itemName** | **string** | RMA Item Name | [
|
|
10
|
-
**quantity** | **number** | RMA Item Quantity | [
|
|
9
|
+
**itemName** | **string** | RMA Item Name | [default to undefined]
|
|
10
|
+
**quantity** | **number** | RMA Item Quantity | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
package/docs/RootAccessModel.md
CHANGED
|
@@ -6,9 +6,9 @@ Root Access Model
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**username** | **string** | Username | [
|
|
10
|
-
**password** | **string** | Password | [
|
|
11
|
-
**expiryDate** | **string** | Expiry Date | [
|
|
9
|
+
**username** | **string** | Username | [default to undefined]
|
|
10
|
+
**password** | **string** | Password | [default to undefined]
|
|
11
|
+
**expiryDate** | **string** | Expiry Date | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
package/docs/S3BucketEntity.md
CHANGED
|
@@ -6,10 +6,10 @@ S3 Bucket
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**name** | **string** | name | [
|
|
10
|
-
**region** | **string** | region | [
|
|
11
|
-
**accessKeyId** | **string** | accessKeyId | [
|
|
12
|
-
**secretAccessKey** | **string** | secretAccessKey | [
|
|
9
|
+
**name** | **string** | name | [default to undefined]
|
|
10
|
+
**region** | **string** | region | [default to undefined]
|
|
11
|
+
**accessKeyId** | **string** | accessKeyId | [default to undefined]
|
|
12
|
+
**secretAccessKey** | **string** | secretAccessKey | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
package/docs/ScannedItemModel.md
CHANGED
|
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**title** | **string** | Title | [optional] [default to undefined]
|
|
10
10
|
**sku** | **string** | SKU | [optional] [default to undefined]
|
|
11
11
|
**tcxLabel** | **string** | 3CX Label | [optional] [default to undefined]
|
|
12
|
-
**serialNumbers** | **Array<string>** | Serial Numbers | [
|
|
12
|
+
**serialNumbers** | **Array<string>** | Serial Numbers | [default to undefined]
|
|
13
13
|
**macAddress** | **string** | MAC Address | [optional] [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
package/docs/ScopeModel.md
CHANGED
|
@@ -6,8 +6,8 @@ OAuth2 Scope
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **string** | ID | [
|
|
10
|
-
**description** | **string** | Description | [
|
|
9
|
+
**id** | **string** | ID | [default to undefined]
|
|
10
|
+
**description** | **string** | Description | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -6,7 +6,7 @@ Serial Number Request
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**serialNumber** | **string** | Serial Number | [
|
|
9
|
+
**serialNumber** | **string** | Serial Number | [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
package/docs/SeriesDTO.md
CHANGED
|
@@ -6,10 +6,10 @@ Graph Series Data
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**name** | **string** | Name | [
|
|
10
|
-
**type** | **string** | Type | [
|
|
9
|
+
**name** | **string** | Name | [default to undefined]
|
|
10
|
+
**type** | **string** | Type | [default to undefined]
|
|
11
11
|
**stack** | **string** | Stack | [optional] [default to undefined]
|
|
12
|
-
**data** | **Array<string>** | Data | [
|
|
12
|
+
**data** | **Array<string>** | Data | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
package/docs/ServiceHealthDTO.md
CHANGED
|
@@ -6,8 +6,8 @@ Service Health DTO
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**services** | [**Array<ServiceStatusDTO>**](ServiceStatusDTO.md) | | [
|
|
10
|
-
**globalStatus** | **number** | | [
|
|
9
|
+
**services** | [**Array<ServiceStatusDTO>**](ServiceStatusDTO.md) | | [default to undefined]
|
|
10
|
+
**globalStatus** | **number** | | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
package/docs/ServiceStatusDTO.md
CHANGED
|
@@ -6,10 +6,10 @@ Service Status DTO
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**statusName** | **string** | Service Status Description | [
|
|
10
|
-
**name** | **string** | Service Name | [
|
|
11
|
-
**status** | **string** | Service Status | [
|
|
12
|
-
**events** | [**Array<EventDTO>**](EventDTO.md) | Service Events | [
|
|
9
|
+
**statusName** | **string** | Service Status Description | [default to undefined]
|
|
10
|
+
**name** | **string** | Service Name | [default to undefined]
|
|
11
|
+
**status** | **string** | Service Status | [default to undefined]
|
|
12
|
+
**events** | [**Array<EventDTO>**](EventDTO.md) | Service Events | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -6,17 +6,17 @@ ShipmentAddressEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**shipmentId** | **number** | shipmentId | [
|
|
11
|
-
**shipName** | **string** | shipName | [
|
|
12
|
-
**shipCompany** | **string** | shipCompany | [
|
|
13
|
-
**shipAddress1** | **string** | shipAddress1 | [
|
|
14
|
-
**shipAddress2** | **string** | shipAddress2 | [
|
|
15
|
-
**shipCity** | **string** | shipCity | [
|
|
16
|
-
**shipStateRegion** | **string** | shipStateRegion | [
|
|
17
|
-
**shipPostalCode** | **string** | shipPostalCode | [
|
|
18
|
-
**shipCountry** | **string** | shipCountry | [
|
|
19
|
-
**shipPhoneNumber** | **string** | shipPhoneNumber | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**shipmentId** | **number** | shipmentId | [default to undefined]
|
|
11
|
+
**shipName** | **string** | shipName | [default to undefined]
|
|
12
|
+
**shipCompany** | **string** | shipCompany | [default to undefined]
|
|
13
|
+
**shipAddress1** | **string** | shipAddress1 | [default to undefined]
|
|
14
|
+
**shipAddress2** | **string** | shipAddress2 | [default to undefined]
|
|
15
|
+
**shipCity** | **string** | shipCity | [default to undefined]
|
|
16
|
+
**shipStateRegion** | **string** | shipStateRegion | [default to undefined]
|
|
17
|
+
**shipPostalCode** | **string** | shipPostalCode | [default to undefined]
|
|
18
|
+
**shipCountry** | **string** | shipCountry | [default to undefined]
|
|
19
|
+
**shipPhoneNumber** | **string** | shipPhoneNumber | [default to undefined]
|
|
20
20
|
|
|
21
21
|
## Example
|
|
22
22
|
|
package/docs/ShipmentDTO.md
CHANGED
|
@@ -12,10 +12,10 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**reference** | **string** | Courier Reference | [optional] [default to undefined]
|
|
13
13
|
**tracking** | **string** | Courier Tracking | [optional] [default to undefined]
|
|
14
14
|
**trackingUrl** | **string** | Courier Tracking URL | [optional] [default to undefined]
|
|
15
|
-
**requestedDate** | **string** | Date Time | [
|
|
16
|
-
**scannedItems** | [**Array<ScannedItemModel>**](ScannedItemModel.md) | Scanned Items | [
|
|
17
|
-
**items** | [**Array<ShipmentItemModel>**](ShipmentItemModel.md) | Items | [
|
|
18
|
-
**address** | [**AddressModel**](AddressModel.md) | | [
|
|
15
|
+
**requestedDate** | **string** | Date Time | [default to undefined]
|
|
16
|
+
**scannedItems** | [**Array<ScannedItemModel>**](ScannedItemModel.md) | Scanned Items | [default to undefined]
|
|
17
|
+
**items** | [**Array<ShipmentItemModel>**](ShipmentItemModel.md) | Items | [default to undefined]
|
|
18
|
+
**address** | [**AddressModel**](AddressModel.md) | | [default to undefined]
|
|
19
19
|
**boxes** | **number** | Boxes Shipped | [optional] [default to undefined]
|
|
20
20
|
|
|
21
21
|
## Example
|
package/docs/ShipmentEntity.md
CHANGED
|
@@ -6,18 +6,18 @@ ShipmentsEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**batchId** | **number** | batchId | [
|
|
11
|
-
**courier** | **string** | courier | [
|
|
12
|
-
**courierService** | **string** | courierService | [
|
|
13
|
-
**courierServiceDesc** | **string** | courierServiceDesc | [
|
|
14
|
-
**courierReference** | **string** | courierReference | [
|
|
15
|
-
**courierTracking** | **string** | courierTracking | [
|
|
16
|
-
**courierBoxes** | **number** | courierBoxes | [
|
|
17
|
-
**scannedData** | **string** | mac | [
|
|
18
|
-
**dateShipped** | **string** | date | [
|
|
19
|
-
**requestDate** | **string** | requestDate | [
|
|
20
|
-
**provId** | **number** | provId | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**batchId** | **number** | batchId | [default to undefined]
|
|
11
|
+
**courier** | **string** | courier | [default to undefined]
|
|
12
|
+
**courierService** | **string** | courierService | [default to undefined]
|
|
13
|
+
**courierServiceDesc** | **string** | courierServiceDesc | [default to undefined]
|
|
14
|
+
**courierReference** | **string** | courierReference | [default to undefined]
|
|
15
|
+
**courierTracking** | **string** | courierTracking | [default to undefined]
|
|
16
|
+
**courierBoxes** | **number** | courierBoxes | [default to undefined]
|
|
17
|
+
**scannedData** | **string** | mac | [default to undefined]
|
|
18
|
+
**dateShipped** | **string** | date | [default to undefined]
|
|
19
|
+
**requestDate** | **string** | requestDate | [default to undefined]
|
|
20
|
+
**provId** | **number** | provId | [default to undefined]
|
|
21
21
|
|
|
22
22
|
## Example
|
|
23
23
|
|
package/docs/ShipmentItemDTO.md
CHANGED
|
@@ -6,8 +6,8 @@ Shipment Item
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**itemId** | **number** | Item ID | [
|
|
10
|
-
**quantity** | **number** | Quantity | [
|
|
9
|
+
**itemId** | **number** | Item ID | [default to undefined]
|
|
10
|
+
**quantity** | **number** | Quantity | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -6,11 +6,11 @@ ShipmentItemsEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**shipmentId** | **number** | shipmentId | [
|
|
11
|
-
**batchId** | **number** | batchId | [
|
|
12
|
-
**quantity** | **number** | quantity | [
|
|
13
|
-
**itemId** | **number** | item | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**shipmentId** | **number** | shipmentId | [default to undefined]
|
|
11
|
+
**batchId** | **number** | batchId | [default to undefined]
|
|
12
|
+
**quantity** | **number** | quantity | [default to undefined]
|
|
13
|
+
**itemId** | **number** | item | [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
@@ -6,11 +6,11 @@ Shipment Item
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**shipmentId** | **number** | shipmentId | [
|
|
11
|
-
**batchId** | **number** | batchId | [
|
|
12
|
-
**quantity** | **number** | quantity | [
|
|
13
|
-
**itemId** | **number** | item | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**shipmentId** | **number** | shipmentId | [default to undefined]
|
|
11
|
+
**batchId** | **number** | batchId | [default to undefined]
|
|
12
|
+
**quantity** | **number** | quantity | [default to undefined]
|
|
13
|
+
**itemId** | **number** | item | [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
package/docs/ShipmentModel.md
CHANGED
|
@@ -6,18 +6,18 @@ Shipment
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**batchId** | **number** | batchId | [
|
|
11
|
-
**courier** | **string** | courier | [
|
|
12
|
-
**courierService** | **string** | courierService | [
|
|
13
|
-
**courierServiceDesc** | **string** | courierServiceDesc | [
|
|
14
|
-
**courierReference** | **string** | courierReference | [
|
|
15
|
-
**courierTracking** | **string** | courierTracking | [
|
|
16
|
-
**courierBoxes** | **number** | courierBoxes | [
|
|
17
|
-
**scannedData** | **string** | mac | [
|
|
18
|
-
**dateShipped** | **string** | date | [
|
|
19
|
-
**requestDate** | **string** | requestDate | [
|
|
20
|
-
**provId** | **number** | provId | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**batchId** | **number** | batchId | [default to undefined]
|
|
11
|
+
**courier** | **string** | courier | [default to undefined]
|
|
12
|
+
**courierService** | **string** | courierService | [default to undefined]
|
|
13
|
+
**courierServiceDesc** | **string** | courierServiceDesc | [default to undefined]
|
|
14
|
+
**courierReference** | **string** | courierReference | [default to undefined]
|
|
15
|
+
**courierTracking** | **string** | courierTracking | [default to undefined]
|
|
16
|
+
**courierBoxes** | **number** | courierBoxes | [default to undefined]
|
|
17
|
+
**scannedData** | **string** | mac | [default to undefined]
|
|
18
|
+
**dateShipped** | **string** | date | [default to undefined]
|
|
19
|
+
**requestDate** | **string** | requestDate | [default to undefined]
|
|
20
|
+
**provId** | **number** | provId | [default to undefined]
|
|
21
21
|
|
|
22
22
|
## Example
|
|
23
23
|
|
|
@@ -6,12 +6,12 @@ Shipment Request
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**courier** | **string** | Courier | [
|
|
9
|
+
**courier** | **string** | Courier | [default to undefined]
|
|
10
10
|
**address** | [**AddressModel**](AddressModel.md) | Address | [optional] [default to undefined]
|
|
11
|
-
**scannedLines** | **Array<string>** | Scanned Lines | [
|
|
12
|
-
**service** | **string** | Service | [
|
|
11
|
+
**scannedLines** | **Array<string>** | Scanned Lines | [default to undefined]
|
|
12
|
+
**service** | **string** | Service | [default to undefined]
|
|
13
13
|
**shipDate** | **string** | Ship Date | [optional] [default to undefined]
|
|
14
|
-
**items** | [**Array<ShipmentItemDTO>**](ShipmentItemDTO.md) | Items | [
|
|
14
|
+
**items** | [**Array<ShipmentItemDTO>**](ShipmentItemDTO.md) | Items | [default to undefined]
|
|
15
15
|
|
|
16
16
|
## Example
|
|
17
17
|
|
|
@@ -5,10 +5,10 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**service** | [**ShippingServiceModel**](ShippingServiceModel.md) | | [
|
|
9
|
-
**id** | **string** | ID/Number | [
|
|
10
|
-
**trackingNumber** | **string** | Tracking Number | [
|
|
11
|
-
**parcelIds** | **Array<string>** | Parcels | [
|
|
8
|
+
**service** | [**ShippingServiceModel**](ShippingServiceModel.md) | | [default to undefined]
|
|
9
|
+
**id** | **string** | ID/Number | [default to undefined]
|
|
10
|
+
**trackingNumber** | **string** | Tracking Number | [default to undefined]
|
|
11
|
+
**parcelIds** | **Array<string>** | Parcels | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -6,9 +6,9 @@ Shipping Information
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**items** | [**Array<BasicItemDTO>**](BasicItemDTO.md) | Items | [
|
|
10
|
-
**postalCode** | **string** | Destination Post Code | [
|
|
11
|
-
**iso** | **string** | Destination ISO | [
|
|
9
|
+
**items** | [**Array<BasicItemDTO>**](BasicItemDTO.md) | Items | [default to undefined]
|
|
10
|
+
**postalCode** | **string** | Destination Post Code | [default to undefined]
|
|
11
|
+
**iso** | **string** | Destination ISO | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -5,9 +5,9 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**courier** | **string** | Courier | [
|
|
9
|
-
**service** | **string** | Courier Service | [
|
|
10
|
-
**boxes** | **number** | Boxes | [
|
|
8
|
+
**courier** | **string** | Courier | [default to undefined]
|
|
9
|
+
**service** | **string** | Courier Service | [default to undefined]
|
|
10
|
+
**boxes** | **number** | Boxes | [default to undefined]
|
|
11
11
|
**printer** | **number** | Printer | [optional] [default to undefined]
|
|
12
12
|
**shipment** | [**ShipmentRequestDTO**](ShipmentRequestDTO.md) | | [optional] [default to undefined]
|
|
13
13
|
|
|
@@ -6,8 +6,8 @@ Shipping Service
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**courier** | **string** | Courier | [
|
|
10
|
-
**serviceName** | **string** | Service Name | [
|
|
9
|
+
**courier** | **string** | Courier | [default to undefined]
|
|
10
|
+
**serviceName** | **string** | Service Name | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|