@datenkraft/bb-fulfillment-api-ts-client
Version:
The fulfillment API TS Client enables you to work with the fulfillment API
100 lines (99 loc) • 4.41 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 { BaseOrderCustomerInvoiceAddress } from './base-order-customer-invoice-address';
import { OrderCustomerDeliveryAddress } from './order-customer-delivery-address';
/**
*
* @export
* @interface BaseOrderCustomer
*/
export interface BaseOrderCustomer {
/**
*
* @type {string}
* @memberof BaseOrderCustomer
*/
'gender': BaseOrderCustomerGenderEnum;
/**
* The language code for any customer communications (ISO 639-1). Currently only \'de\' is supported
* @type {string}
* @memberof BaseOrderCustomer
*/
'languageCode': string;
/**
* The external id of the order customer
* @type {string}
* @memberof BaseOrderCustomer
*/
'externalCustomerId'?: string | null;
/**
*
* @type {OrderCustomerDeliveryAddress}
* @memberof BaseOrderCustomer
*/
'deliveryAddress': OrderCustomerDeliveryAddress;
/**
* The customer\'s email
* @type {string}
* @memberof BaseOrderCustomer
*/
'email'?: string | null;
/**
* The customer\\\'s phone number. Note that only the DIN 5008 format is supported.\\ Parenthesis for example are not valid.
* @type {string}
* @memberof BaseOrderCustomer
*/
'phone'?: string | null;
/**
* The customer\'s first name.\\ Note: This field is required for invoicing and whether it is available or not depends on the used shopCode.\\ Use the GET /shop endpoint to check if the meta.invoiceEnabled of the shop is set to true.
* @type {string}
* @memberof BaseOrderCustomer
*/
'firstname'?: string | null;
/**
* The customer\'s last name.\\ Note: This field is required for invoicing and whether it is available or not depends on the used shopCode.\\ Use the GET /shop endpoint to check if the meta.invoiceEnabled of the shop is set to true.
* @type {string}
* @memberof BaseOrderCustomer
*/
'lastname'?: string | null;
/**
* The customer\'s title.\\ Note: This field is required for invoicing and whether it is available or not depends on the used shopCode.\\ Use the GET /shop endpoint to check if the meta.invoiceEnabled of the shop is set to true.
* @type {string}
* @memberof BaseOrderCustomer
*/
'title'?: string | null;
/**
* The customer\'s company name.\\ Note: This field is required for invoicing and whether it is available or not depends on the used shopCode.\\ Use the GET /shop endpoint to check if the meta.invoiceEnabled of the shop is set to true.
* @type {string}
* @memberof BaseOrderCustomer
*/
'company'?: string | null;
/**
* The customer\'s company vat number (might be validated).\\ Note: This field is required for invoicing and whether it is available or not depends on the used shopCode.\\ Use the GET /shop endpoint to check if the meta.invoiceEnabled of the shop is set to true.
* @type {string}
* @memberof BaseOrderCustomer
*/
'companyVatNumber'?: string | null;
/**
*
* @type {BaseOrderCustomerInvoiceAddress}
* @memberof BaseOrderCustomer
*/
'invoiceAddress'?: BaseOrderCustomerInvoiceAddress | null;
}
export declare const BaseOrderCustomerGenderEnum: {
readonly Male: "male";
readonly Female: "female";
readonly Unknown: "unknown";
readonly UnknownDefaultOpenApi: "11184809";
};
export type BaseOrderCustomerGenderEnum = typeof BaseOrderCustomerGenderEnum[keyof typeof BaseOrderCustomerGenderEnum];