@datenkraft/bb-fulfillment-api-ts-client
Version:
The fulfillment API TS Client enables you to work with the fulfillment API
93 lines (92 loc) • 3.29 kB
TypeScript
/**
* Fulfillment API
* - alpha: Currently developed API version. Subject to major changes. - beta: A semi-stable early access version. New features can be added. Breaking changes are possible. - stable: The API is recommended for use in production. [Changelog](https://fulfillment-api.steve.niceshops.com/v2/docs/changelog.html) All data is transferred in UTF-8 encoding.\\ The API uses stateless HTTP. No cookies have to be kept.\\ Authentication via OAuth2 client credentials flow. [Privacy Policy](https://www.niceshops.com/en/dienstleistungen/data-privacy-policy) [Fulfillment API PHP client @Packagist](https://packagist.org/packages/datenkraft/bb-fulfillment-api-php-client)
*
* The version of the OpenAPI document: v2.beta
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { DeliveryShipmentJournal } from './delivery-shipment-journal';
import { DeliveryShipmentPackaging } from './delivery-shipment-packaging';
import { ShipmentLine } from './shipment-line';
/**
* A shipments defines a single delivered entity (package, parcel, pallet, ...)
* @export
* @interface DeliveryShipment
*/
export interface DeliveryShipment {
/**
* The shipment number
* @type {string}
* @memberof DeliveryShipment
*/
'number'?: string;
/**
* Status of the delivery. - delivered: The delivery is packed and ready to be picked up by the delivery service.
* @type {string}
* @memberof DeliveryShipment
*/
'status'?: DeliveryShipmentStatusEnum;
/**
* The delivery service used to send this delivery.\\ The codes of supported delivery services can be retrieved from the \'GET /delivery-service\' endpoint.
* @type {string}
* @memberof DeliveryShipment
*/
'deliveryService'?: string | null;
/**
* Carrier specific tracking code
* @type {string}
* @memberof DeliveryShipment
*/
'code'?: string;
/**
* Link to the carrier\'s specific tracking site
* @type {string}
* @memberof DeliveryShipment
*/
'link'?: string;
/**
*
* @type {number}
* @memberof DeliveryShipment
*/
'weight'?: number;
/**
* Weight unit
* @type {string}
* @memberof DeliveryShipment
*/
'weightUnit'?: string;
/**
* Shipment lines
* @type {Array<ShipmentLine>}
* @memberof DeliveryShipment
*/
'shipmentLines'?: Array<ShipmentLine>;
/**
* External id of the shipment
* @type {string}
* @memberof DeliveryShipment
*/
'externalShipmentId'?: string | null;
/**
* Journal entries regarding the shipment
* @type {Array<DeliveryShipmentJournal>}
* @memberof DeliveryShipment
*/
'journal'?: Array<DeliveryShipmentJournal>;
/**
*
* @type {DeliveryShipmentPackaging}
* @memberof DeliveryShipment
*/
'packaging'?: DeliveryShipmentPackaging;
}
export declare const DeliveryShipmentStatusEnum: {
readonly Delivered: "delivered";
readonly UnknownDefaultOpenApi: "11184809";
};
export type DeliveryShipmentStatusEnum = typeof DeliveryShipmentStatusEnum[keyof typeof DeliveryShipmentStatusEnum];