@datenkraft/bb-fulfillment-api-ts-client
Version:
The fulfillment API TS Client enables you to work with the fulfillment API
100 lines (99 loc) • 3.83 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.
*/
/**
* Meta data of the shop.
* @export
* @interface ShopMeta
*/
export interface ShopMeta {
[key: string]: any;
/**
* Domain of the Shopify shop.
* @type {string}
* @memberof ShopMeta
*/
'shopifyShopDomain'?: string | null;
/**
* Flag to mark a shop used for testing.
* @type {boolean}
* @memberof ShopMeta
*/
'testShop'?: boolean | null;
/**
* Date time to indicate that the test shop will not be reset before this time.
* @type {string}
* @memberof ShopMeta
*/
'testShopResetNotBefore'?: string | null;
/**
* Flag to mark a shop in sandbox mode.
* @type {boolean}
* @memberof ShopMeta
*/
'sandboxMode'?: boolean | null;
/**
* Flag to mark if a test suffix should be added to internal references.
* @type {boolean}
* @memberof ShopMeta
*/
'addTestSuffixToInternalReference'?: boolean | null;
/**
* Flag to mark the shop as part of a Shopify installation that uses multiple shops.
* @type {boolean}
* @memberof ShopMeta
*/
'shopifyMultiShop'?: boolean | null;
/**
* Flag to mark the shop as the default shop for a Shopify installation that uses multiple shops.\\ The default shop is used for e.g. fetching stock levels.
* @type {boolean}
* @memberof ShopMeta
*/
'shopifyDefaultShop'?: boolean | null;
/**
* The order country code (ISO 3166-1 alpha-2) to identify which shop to use in a Shopify installation that uses multiple shops.\\ If a Shopify order matches this country code, it will be assigned to this shop.
* @type {string}
* @memberof ShopMeta
*/
'shopifyOrderCountryCode'?: string | null;
/**
* Flag to indicate whether firstname, lastname, and invoiceAddress fields are available for order customers or not.
* @type {boolean}
* @memberof ShopMeta
*/
'invoiceEnabled'?: boolean | null;
/**
* Overwrite currency of shopify orders.
* @type {string}
* @memberof ShopMeta
*/
'defaultCurrency'?: ShopMetaDefaultCurrencyEnum;
/**
* Flag to mark if it is allowed to set a customer\'s email in a third party app or via the API. If false the shop email will be used as default.
* @type {boolean}
* @memberof ShopMeta
*/
'overwriteCustomerEmailEnabled'?: boolean | null;
/**
* Text to be added to the beginning of the orderNotes of every order created for the shop.
* @type {string}
* @memberof ShopMeta
*/
'orderNotesPrecedingText'?: string | null;
}
export declare const ShopMetaDefaultCurrencyEnum: {
readonly Gbp: "GBP";
readonly Sek: "SEK";
readonly Pln: "PLN";
readonly Null: "null";
readonly UnknownDefaultOpenApi: "11184809";
};
export type ShopMetaDefaultCurrencyEnum = typeof ShopMetaDefaultCurrencyEnum[keyof typeof ShopMetaDefaultCurrencyEnum];