liferay-headless-rest-client/dist/clients/headless-commerce-admin-shipment-v1.0/types.gen.d.ts

A collection of Headless Clients used in Liferay Portal

export type ShipmentItem={readonly actions?:{[key:string]:{[key:string]:string;};};readonly createDate?:string;externalReferenceCode?:string;readonly id?:number;readonly modifiedDate?:string;orderItemExternalReferenceCode?:string;orderItemId?:number;quantity:number;shipmentExternalReferenceCode?:string;readonly shipmentId?:number;unitOfMeasureKey?:string;readonly userName?:string;validateInventory?:boolean;warehouseExternalReferenceCode?:string;warehouseId?:number;readonly'x-class-name'?:string;};export type Facet={facetCriteria?:string;facetValues?:Array<FacetValue>;};export type FacetValue={numberOfOccurrences?:number;term?:string;};export type PageShipmentItem={items?:Array<ShipmentItem>;lastPage?:number;totalCount?:number;actions?:{[key:string]:{[key:string]:string;};};facets?:Array<Facet>;page?:number;pageSize?:number;};export type CustomField={readonly'x-class-name'?:string;customValue?:CustomValue;readonly dataType?:string;name?:string;};export type CustomValue={readonly'x-class-name'?:string;data?:{[key:string]:unknown;};data_i18n?:{[key:string]:string;};geo?:Geo;};export type Geo={readonly'x-class-name'?:string;latitude?:number;longitude?:number;};export type Shipment={readonly accountId?:number;readonly actions?:{[key:string]:{[key:string]:string;};};carrier?:string;readonly createDate?:string;customFields?:Array<CustomField>;expectedDate?:string;externalReferenceCode?:string;readonly id?:number;readonly modifiedDate?:string;orderExternalReferenceCode?:string;orderId?:number;shipmentItems?:Array<ShipmentItem>;shippingAddress?:ShippingAddress;shippingAddressId?:number;shippingDate?:string;shippingMethodId?:number;readonly shippingOptionName?:string;status?:Status;trackingNumber?:string;trackingURL?:string;readonly userName?:string;readonly'x-class-name'?:string;};export type ShippingAddress={city:string;countryISOCode:string;description?:string;externalReferenceCode?:string;id?:number;latitude?:number;longitude?:number;name:string;phoneNumber?:string;regionISOCode?:string;street1:string;street2?:string;street3?:string;zip?:string;readonly'x-class-name'?:string;};export type Status={readonly code?:number;label?:string;label_i18n?:string;readonly'x-class-name'?:string;};export type PageShipment={items?:Array<Shipment>;lastPage?:number;totalCount?:number;actions?:{[key:string]:{[key:string]:string;};};facets?:Array<Facet>;page?:number;pageSize?:number;};export type DeleteShipmentItemData={body?:never;path:{shipmentItemId:string;};query?:never;url:'/o/headless-commerce-admin-shipment/v1.0/shipment-items/{shipmentItemId}';};export type DeleteShipmentItemResponses={default:unknown;};export type GetShipmentItemData={body?:never;path:{shipmentItemId:string;};query?:never;url:'/o/headless-commerce-admin-shipment/v1.0/shipment-items/{shipmentItemId}';};export type GetShipmentItemResponses={default:ShipmentItem;};export type GetShipmentItemResponse=GetShipmentItemResponses[keyof GetShipmentItemResponses];export type PatchShipmentItemData={body?:ShipmentItem;path:{shipmentItemId:string;};query?:never;url:'/o/headless-commerce-admin-shipment/v1.0/shipment-items/{shipmentItemId}';};export type PatchShipmentItemResponses={default:ShipmentItem;};export type PatchShipmentItemResponse=PatchShipmentItemResponses[keyof PatchShipmentItemResponses];export type DeleteShipmentItemBatchData={body?:{[key:string]:unknown;};path?:never;query?:{callbackURL?:string;};url:'/o/headless-commerce-admin-shipment/v1.0/shipment-items/batch';};export type DeleteShipmentItemBatchResponses={default:unknown;};export type DeleteShipmentItemByExternalReferenceCodeData={body?:never;path:{externalReferenceCode:string;};query?:never;url:'/o/headless-commerce-admin-shipment/v1.0/shipment-items/by-externalReferenceCode/{externalReferenceCode}';};export type DeleteShipmentItemByExternalReferenceCodeResponses={default:unknown;};export type GetShipmentByExternalReferenceCodeItemData={body?:never;path:{externalReferenceCode:string;};query?:never;url:'/o/headless-commerce-admin-shipment/v1.0/shipment-items/by-externalReferenceCode/{externalReferenceCode}';};export type GetShipmentByExternalReferenceCodeItemResponses={default:ShipmentItem;};export type GetShipmentByExternalReferenceCodeItemResponse=GetShipmentByExternalReferenceCodeItemResponses[keyof GetShipmentByExternalReferenceCodeItemResponses];export type PatchShipmentItemByExternalReferenceCodeData={body?:ShipmentItem;path:{externalReferenceCode:string;};query?:never;url:'/o/headless-commerce-admin-shipment/v1.0/shipment-items/by-externalReferenceCode/{externalReferenceCode}';};export type PatchShipmentItemByExternalReferenceCodeResponses={default:ShipmentItem;};export type PatchShipmentItemByExternalReferenceCodeResponse=PatchShipmentItemByExternalReferenceCodeResponses[keyof PatchShipmentItemByExternalReferenceCodeResponses];export type GetShipmentByExternalReferenceCodeItemsPageData={body?:never;path:{externalReferenceCode:string;};query?:{page?:string;pageSize?:string;nestedFields?:string;};url:'/o/headless-commerce-admin-shipment/v1.0/shipments/by-externalReferenceCode/{externalReferenceCode}/items';};export type GetShipmentByExternalReferenceCodeItemsPageResponses={default:PageShipmentItem;};export type GetShipmentByExternalReferenceCodeItemsPageResponse=GetShipmentByExternalReferenceCodeItemsPageResponses[keyof GetShipmentByExternalReferenceCodeItemsPageResponses];export type PostShipmentItemByExternalReferenceCodeData={body?:ShipmentItem;path:{externalReferenceCode:string;};query?:never;url:'/o/headless-commerce-admin-shipment/v1.0/shipments/by-externalReferenceCode/{externalReferenceCode}/items';};export type PostShipmentItemByExternalReferenceCodeResponses={default:ShipmentItem;};export type PostShipmentItemByExternalReferenceCodeResponse=PostShipmentItemByExternalReferenceCodeResponses[keyof PostShipmentItemByExternalReferenceCodeResponses];export type PutShipmentByExternalReferenceCodeItemData={body?:ShipmentItem;path:{externalReferenceCode:string;};query?:never;url:'/o/headless-commerce-admin-shipment/v1.0/shipments/by-externalReferenceCode/{externalReferenceCode}/items';};export type PutShipmentByExternalReferenceCodeItemResponses={default:ShipmentItem;};export type PutShipmentByExternalReferenceCodeItemResponse=PutShipmentByExternalReferenceCodeItemResponses[keyof PutShipmentByExternalReferenceCodeItemResponses];export type GetShipmentItemsPageData={body?:never;path:{shipmentId:string;};query?:{page?:string;pageSize?:string;nestedFields?:string;};url:'/o/headless-commerce-admin-shipment/v1.0/shipments/{shipmentId}/items';};export type GetShipmentItemsPageResponses={default:PageShipmentItem;};export type GetShipmentItemsPageResponse=GetShipmentItemsPageResponses[keyof GetShipmentItemsPageResponses];export type PostShipmentItemData={body?:ShipmentItem;path:{shipmentId:string;};query?:never;url:'/o/headless-commerce-admin-shipment/v1.0/shipments/{shipmentId}/items';};export type PostShipmentItemResponses={default:ShipmentItem;};export type PostShipmentItemResponse=PostShipmentItemResponses[keyof PostShipmentItemResponses];export type DeleteShipmentData={body?:never;path:{shipmentId:string;};query?:never;url:'/o/headless-commerce-admin-shipment/v1.0/shipments/{shipmentId}';};export type DeleteShipmentResponses={default:unknown;};export type GetShipmentData={body?:never;path:{shipmentId:string;};query?:never;url:'/o/headless-commerce-admin-shipment/v1.0/shipments/{shipmentId}';};export type GetShipmentResponses={default:Shipment;};export type GetShipmentResponse=GetShipmentResponses[keyof GetShipmentResponses];export type PatchShipmentData={body?:Shipment;path:{shipmentId:string;};query?:never;url:'/o/headless-commerce-admin-shipment/v1.0/shipments/{shipmentId}';};export type PatchShipmentResponses={default:Shipment;};export type PatchShipmentResponse=PatchShipmentResponses[keyof PatchShipmentResponses];export type DeleteShipmentBatchData={body?:{[key:string]:unknown;};path?:never;query?:{callbackURL?:string;};url:'/o/headless-commerce-admin-shipment/v1.0/shipments/batch';};export type DeleteShipmentBatchResponses={default:unknown;};export type PostShipmentBatchData={body?:{[key:string]:unknown;};path?:never;query?:{callbackURL?:string;};url:'/o/headless-commerce-admin-shipment/v1.0/shipments/batch';};export type PostShipmentBatchResponses={default:unknown;};export type DeleteShipmentByExternalReferenceCodeData={body?:never;path:{externalReferenceCode:string;};query?:never;url:'/o/headless-commerce-admin-shipment/v1.0/shipments/by-externalReferenceCode/{externalReferenceCode}';};export type DeleteShipmentByExternalReferenceCodeResponses={default:unknown;};export type GetShipmentByExternalReferenceCodeData={body?:never;path:{externalReferenceCode:string;};query?:never;url:'/o/headless-commerce-admin-shipment/v1.0/shipments/by-externalReferenceCode/{externalReferenceCode}';};export type GetShipmentByExternalReferenceCodeResponses={default:Shipment;};export type GetShipmentByExternalReferenceCodeResponse=GetShipmentByExternalReferenceCodeResponses[keyof GetShipmentByExternalReferenceCodeResponses];export type PatchShipmentByExternalReferenceCodeData={body?:Shipment;path:{externalReferenceCode:string;};query?:never;url:'/o/headless-commerce-admin-shipment/v1.0/shipments/by-externalReferenceCode/{externalReferenceCode}';};export type PatchShipmentByExternalReferenceCodeResponses={default:Shipment;};export type PatchShipmentByExternalReferenceCodeResponse=PatchShipmentByExternalReferenceCodeResponses[keyof PatchShipmentByExternalReferenceCodeResponses];export type PutShipmentByExternalReferenceCodeData={body?:Shipment;path:{externalReferenceCode:string;};query?:never;url:'/o/headless-commerce-admin-shipment/v1.0/shipments/by-externalReferenceCode/{externalReferenceCode}';};export type PutShipmentByExternalReferenceCodeResponses={default:Shipment;};export type PutShipmentByExternalReferenceCodeResponse=PutShipmentByExternalReferenceCodeResponses[keyof PutShipmentByExternalReferenceCodeResponses];export type GetShipmentsPageData={body?:never;path?:never;query?:{filter?:string;page?:string;pageSize?:string;search?:string;sort?:string;nestedFields?:string;};url:'/o/headless-commerce-admin-shipment/v1.0/shipments';};export type GetShipmentsPageResponses={default:PageShipment;};export type GetShipmentsPageResponse=GetShipmentsPageResponses[keyof GetShipmentsPageResponses];export type PostShipmentData={body?:Shipment;path?:never;query?:never;url:'/o/headless-commerce-admin-shipment/v1.0/shipments';};export type PostShipmentResponses={default:Shipment;};export type PostShipmentResponse=PostShipmentResponses[keyof PostShipmentResponses];export type PostShipmentByExternalReferenceCodeStatusDeliveredData={body?:never;path:{externalReferenceCode:string;};query?:never;url:'/o/headless-commerce-admin-shipment/v1.0/shipments/by-externalReferenceCode/{externalReferenceCode}/status-delivered';};export type PostShipmentByExternalReferenceCodeStatusDeliveredResponses={default:Shipment;};export type PostShipmentByExternalReferenceCodeStatusDeliveredResponse=PostShipmentByExternalReferenceCodeStatusDeliveredResponses[keyof PostShipmentByExternalReferenceCodeStatusDeliveredResponses];export type PostShipmentByExternalReferenceCodeStatusFinishProcessingData={body?:never;path:{externalReferenceCode:string;};query?:never;url:'/o/headless-commerce-admin-shipment/v1.0/shipments/by-externalReferenceCode/{externalReferenceCode}/status-finish-processing';};export type PostShipmentByExternalReferenceCodeStatusFinishProcessingResponses={default:Shipment;};export type PostShipmentByExternalReferenceCodeStatusFinishProcessingResponse=PostShipmentByExternalReferenceCodeStatusFinishProcessingResponses[keyof PostShipmentByExternalReferenceCodeStatusFinishProcessingResponses];export type PostShipmentByExternalReferenceCodeStatusShippedData={body?:never;path:{externalReferenceCode:string;};query?:never;url:'/o/headless-commerce-admin-shipment/v1.0/shipments/by-externalReferenceCode/{externalReferenceCode}/status-shipped';};export type PostShipmentByExternalReferenceCodeStatusShippedResponses={default:Shipment;};export type PostShipmentByExternalReferenceCodeStatusShippedResponse=PostShipmentByExternalReferenceCodeStatusShippedResponses[keyof PostShipmentByExternalReferenceCodeStatusShippedResponses];export type PostShipmentStatusDeliveredData={body?:never;path:{shipmentId:string;};query?:never;url:'/o/headless-commerce-admin-shipment/v1.0/shipments/{shipmentId}/status-delivered';};export type PostShipmentStatusDeliveredResponses={default:Shipment;};export type PostShipmentStatusDeliveredResponse=PostShipmentStatusDeliveredResponses[keyof PostShipmentStatusDeliveredResponses];export type PostShipmentStatusFinishProcessingData={body?:never;path:{shipmentId:string;};query?:never;url:'/o/headless-commerce-admin-shipment/v1.0/shipments/{shipmentId}/status-finish-processing';};export type PostShipmentStatusFinishProcessingResponses={default:Shipment;};export type PostShipmentStatusFinishProcessingResponse=PostShipmentStatusFinishProcessingResponses[keyof PostShipmentStatusFinishProcessingResponses];export type PostShipmentStatusShippedData={body?:never;path:{shipmentId:string;};query?:never;url:'/o/headless-commerce-admin-shipment/v1.0/shipments/{shipmentId}/status-shipped';};export type PostShipmentStatusShippedResponses={default:Shipment;};export type PostShipmentStatusShippedResponse=PostShipmentStatusShippedResponses[keyof PostShipmentStatusShippedResponses];export type PostShipmentsPageExportBatchData={body?:never;path?:never;query?:{filter?:string;search?:string;sort?:string;callbackURL?:string;contentType?:string;fieldNames?:string;};url:'/o/headless-commerce-admin-shipment/v1.0/shipments/export-batch';};export type PostShipmentsPageExportBatchResponses={default:unknown;};export type GetShipmentByExternalReferenceCodeShippingAddressData={body?:never;path:{externalReferenceCode:string;};query?:never;url:'/o/headless-commerce-admin-shipment/v1.0/shipments/by-externalReferenceCode/{externalReferenceCode}/shipping-address';};export type GetShipmentByExternalReferenceCodeShippingAddressResponses={default:ShippingAddress;};export type GetShipmentByExternalReferenceCodeShippingAddressResponse=GetShipmentByExternalReferenceCodeShippingAddressResponses[keyof GetShipmentByExternalReferenceCodeShippingAddressResponses];export type PatchShipmentByExternalReferenceCodeShippingAddressData={body?:ShippingAddress;path:{externalReferenceCode:string;};query?:never;url:'/o/headless-commerce-admin-shipment/v1.0/shipments/by-externalReferenceCode/{externalReferenceCode}/shipping-address';};export type PatchShipmentByExternalReferenceCodeShippingAddressResponses={default:ShippingAddress;};export type PatchShipmentByExternalReferenceCodeShippingAddressResponse=PatchShipmentByExternalReferenceCodeShippingAddressResponses[keyof PatchShipmentByExternalReferenceCodeShippingAddressResponses];export type GetShipmentShippingAddressData={body?:never;path:{shipmentId:string;};query?:never;url:'/o/headless-commerce-admin-shipment/v1.0/shipments/{shipmentId}/shipping-address';};export type GetShipmentShippingAddressResponses={default:ShippingAddress;};export type GetShipmentShippingAddressResponse=GetShipmentShippingAddressResponses[keyof GetShipmentShippingAddressResponses];export type PatchShipmentShippingAddressData={body?:ShippingAddress;path:{shipmentId:string;};query?:never;url:'/o/headless-commerce-admin-shipment/v1.0/shipments/{shipmentId}/shipping-address';};export type PatchShipmentShippingAddressResponses={default:ShippingAddress;};export type PatchShipmentShippingAddressResponse=PatchShipmentShippingAddressResponses[keyof PatchShipmentShippingAddressResponses];export type ClientOptions={baseUrl:'http://localhost:8080'|(string&{});};