Istores API Documentation
MyIstores Api

Schemas

BaseResponseTop

  • successboolean
    Example: true

BaseResponseBottom

  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

BaseResponsePagination

  • resultsnumber
    Example: 233
  • pagesnumber
    Example: 100
  • pagenumber
    Example: 4
  • per_pagenumber
    Example: 2

CustomFieldResponse403

  • successboolean
    Example: false
  • responseobject

CustomFieldResponse200

  • successboolean
    Example: true
  • responseobject

CustomFieldPostResponse200

  • successboolean
    Example: true
  • responseobject

CustomFieldLocations

  • successboolean
    Example: true
  • responseobject

CustomFieldTypes

  • successboolean
    Example: true
  • responseobject

CustomFieldSingle

  • successboolean
    Example: true
  • responseobject

CustomerListRequest

  • limitnumber · int64

    The limit of the results return - can be between 0 and 100

    Example: 15
    Default: 10
  • pagenumber · int64

    The page/index of the results related to the result number

    Example: 2
    Default: 0
  • searchstring

    Search the customers by name or email - case sensitive

    Example: Jhon
  • directionstring · enum

    The direction of return results by the customer creation date

    Enum values:
    desc
    asc

CustomerListResponse

  • customer_idnumber · int64

    Customer unique id - use to delete/get/edit customer

    Example: 123
  • customer_group_idnumber · int64

    Customer group id

    Example: 23
  • namestring

    Full customer name

    Example: Jhon Doe
  • emailstring · email

    Customers email

  • telephonestring

    Customer`s phone

    Example: 0544884654
  • date_addedstring · date

    Date customer added or registered

  • addressesobject[]

CustomerSingleResponse

  • customer_idnumber · int64

    Customer unique id - use to delete/get/edit customer

    Example: 123
  • customer_group_idnumber · int64

    Customer group id

    Example: 23
  • namestring

    Full customer name

    Example: Jhon Doe
  • emailstring · email

    Customers email

  • telephonestring

    Customer`s phone

    Example: 0544884654
  • date_addedstring · date

    Date customer added or registered

  • addressesobject[]

CustomerCreate

  • firstnamestring

    Customer first name

    Example: Jhon
  • lastnamestring

    Customer last name

    Example: Doe
  • emailstring

    Customers email

  • telephonestring

    Customers telephone

    Example: 0544884547
  • passwordstring

    Password that will be related to this customer to login to the store

    Example: 12345678
  • confirmstring

    Password confirmation

    Example: 12345678
  • responder_listnumber · int64

    Responder list id for subscription to newsletter

    Example: 3221
  • addressobject

    Object of the main address will be related to the new customer

CustomerEdit

  • firstnamestring

    Customer first name

    Example: Jhon
  • lastnamestring

    Customer last name

    Example: Doe
  • emailstring

    Customers email

  • telephonestring

    Customers telephone

    Example: 0544884547
  • passwordstring

    Password that will be related to this customer to login to the store (If you dont want to change password dont pass this and confirm field)

    Example: 12345678
  • confirmstring

    Password confirmation

    Example: 12345678
  • addressobject

    Object of the main address will be related to the new customer

PaymentData

  • unique_idstring
  • langstring
  • auth_numberinteger

    the auth number of the order

  • responce_macstring

    responses code that get back from CG after transaction

  • terminal_numinteger

    the terminal num (updated once a day)

  • mutav_nointeger

    The dealer num

  • card_tokeninteger

    the card token can be use for delayed order transacrions

  • card_expinteger

    First two numbers are month , 2nd two numbers are year

  • card_maskinteger

    The card number with mask at the middle (not full number)

  • tx_idstring

    successfully transactions give back special transaction id that can be used for refunding and more

  • number_of_paymentinteger
  • first_paymentinteger

    Relevant only if there is payment_lastname

  • periodical_paymentinteger

    Relevant only if there is payment_lastname

  • mpiValidationstring · enum

    Describe the type of the transaction

    Enum values:
    AutoComm
    Verify

StockStatusList

  • successboolean
    Example: true
  • statusesobject[]
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

customFieldResponse

  • custom_field_idinteger

    Represents order custom field id

  • custom_field_value_idinteger

    Represents custom field value id

  • namestring

    The name of the custom field

    Example: Shoes size
  • valuestring

    The value of the field

    Example: XL
  • typestring

    The type of the field entered

    Example: text
  • locationstring

    The location of the field in the checkout page

    Example: address
  • slugstring

    Permament slug for api usage

    Example: house-number

LanguageList

  • successboolean
    Example: true
  • languagesobject[]

    Array of language objects

  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

CurrencyList

  • successboolean
    Example: true
  • currenciesobject[]
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

DimensionList

  • successboolean
    Example: true
  • weightsobject[]

    Array of valid weight classes inc their description

  • lengthsobject[]

    Array of valid length dimension classes

  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

CouponListRequest

  • pageinteger · min: 1 · max: 9999

    The start page for list pagination

    Example: 1
    Default: 1
  • limitinteger · min: 1 · max: 100

    The results count limit between 1 - 100

    Example: 50
    Default: 50
  • date_startstring · date

    Set the min date the coupon is valid from for usage

    Example: 2021-04-03
  • date_endstring · date

    Set the max date the coupon is valid from for usage

    Example: 2021-04-03
  • order_used_startstring · date

    The mininmum date for the order related to current coupon

    Example: 2021-04-03
  • order_used_endstring · date

    The maximum date for the order related to current coupon

    Example: 2021-04-03
  • date_added_startstring · date

    The mininmum date from the coupon added to system

    Example: 2021-04-03
  • date_added_endstring · date

    The maximum date from the coupon added to system

    Example: 2021-04-03
  • namestring

    The name of the coupon or part of it

    Example: summer sale
  • codestring

    The code of the coupon or part of it

    Example: SUMMER1012
  • typestring · enum

    The type of the coupon for filter

    Enum values:
    percent
    P
    fixed
    F
    gift
    D
  • order_idinteger · int32

    The order id related to the coupon

    Example: 54222

CouponResponseStructureArray

CouponResponseStructure

  • coupon_idinteger

    The id represent the coupon for CRUD and etc

    Example: 23
  • namestring

    The coupon name

    Example: Gift for november
  • codestring

    The Coupon code

    Example: JHG34G
  • typestring · enum

    The type of the coupon (The letters at the example are the same as the string before)

    Enum values:
    percent
    P
    fixed
    F
    gift
    D
  • discountnumber · int64

    The discount value of the coupon (the behaviour depends on the coupon type)

    Example: 44
  • loggedinteger · enum · int32

    1 - The coupon only for logged customers | 2 - coupon available for everyone

    Enum values:
    0
    1
  • shippinginteger · enum · int32

    0 - Exclude shipping | 1 - Free shipping | 2 - Include the shipping at the math action for this coupon

    Enum values:
    0
    1
    2
  • totalinteger · int32

    The minimum total sum the customer have to reach in his cart to apply the coupon

    Example: 100
  • date_startstring · date

    The date the coupon is available from

    Example: 2021-04-03
  • date_endstring · date

    The maximum date the coupon is available

    Example: 2021-04-03
  • date_addedstring · date

    The date the coupon added

    Example: 2021-04-03
  • uses_totalstring

    The maximum total uses for this coupon

    Example: 3
  • uses_customerstring

    The maximum uses available for each registered customer (if the coupon only for registered customers)

    Example: 10
  • statusinteger · enum · int32

    1 - The coupon is active | 0 - The coupon not active

    Enum values:
    0
    1
  • multiple_dealsinteger · int32

    1 - The coupon enables more discounts | 0 - If coupon active other discounts will not work

    Example: 1
  • total_usedinteger · int32

    The total times the current coupon used at the system

    Example: 45

ShippingSingleResponse

  • display_namestring

    The display name of the shipping

    Example: My brand shipping
  • codestring

    Unique code for shipping for other systems usage

    Example: xyz_shipping
  • sort_orderinteger

    The sort order of the shipping compared to other shipping methods

    Example: 1
  • from_sumnumber · int64

    If there is from sum requirement for current shipping

    Example: 450
  • limit_sumnumber · int64

    If there is limit sum requirement for current shipping

    Example: 850
  • statusinteger

    The status of the shipping (1 - active and used, 0 - disabled)

    Example: 1
  • typeinteger

    The shipping type (0 - regular cart shipping, 1 - product related shipping type)

    Example: 1
  • costnumber · int64

    The shipping cost in system's currency

    Example: 265
  • tax_class_idinteger

    The id of the tax class

    Example: 0
  • shipping_feed_statusboolean · int32

    0 - not showing in feeds, 1 - showing in feeds

    Example: 1
  • settingsobject

    object with different shipping extra settings

  • descriptionsobject

    Object with current shipping descriptions

    Example: {"1":"Shipping description language id 1","3":"Shipping description language id 3"}
  • titlesobject

    Object with current shipping titles

    Example: {"1":"Shipping title language id 1","3":"Shipping title language id 3"}
  • additional_notesobject

    Object with current shipping additional_notes

    Example: {"1":"Shipping title additional_note id 1","3":"Shipping title additional_note id 3"}

ShippingMethodListResponse

  • shipping_idinteger

    The shipping ID (used for /shipping/{shipping_id} request)

    Example: 33
  • display_namestring

    The display name of the shipping

    Example: My brand shipping
  • codestring

    Unique code for shipping for other systems usage

    Example: xyz_shipping
  • sort_orderinteger

    The sort order of the shipping compared to other shipping methods

    Example: 1
  • from_sumnumber · int64

    If there is from sum requirement for current shipping

    Example: 450
  • limit_sumnumber · int64

    If there is limit sum requirement for current shipping

    Example: 850
  • statusinteger

    The status of the shipping (1 - active and used, 0 - disabled)

    Example: 1
  • typeinteger

    The shipping type (0 - regular cart shipping, 1 - product related shipping type)

    Example: 1
  • costnumber · int64

    The shipping cost in system's currency

    Example: 265
  • tax_class_idinteger

    The id of the tax class

    Example: 0
  • shipping_feed_statusboolean · int32

    0 - not showing in feeds, 1 - showing in feeds

    Example: 1
  • settingsobject

    object with different shipping extra settings

CustomFieldCrudStructure

  • nameobject

    Object of names by lagnuage id

    Example: {"3":"House num"}
  • typestring

    Fill the type of the custom field (there is api request for valid list of types)

    Example: radio
  • locationstring

    The location of the custom field (now only 'address available')

    Example: address
  • validationstring

    A valid regex pattern for the custom field (leave empty to allow all chars)

    Example:
  • sort_orderinteger

    The order of the custom field in the relation to another fields

  • slugstring

    A valid slug without sapcing for inner proccesses and API (you can leave it empty, the system will create it automaticly)

  • statusinteger · boolean

    The status of the custom field ('1' means its active)

  • requiredinteger · boolean

    If field is required pass '1'

  • custom_field_valueobject[]

    Array of objects with data of the custom field values (only if its multi value field like radio or checkbox)

webhookSingle

  • webhook_idinteger

    The ID of the webhook used for single webhook actions

    Example: 4
  • namestring

    Webhook name to recognize

    Example: Webhook name
  • descriptionstring

    Webhook description

    Example: Webhook description
  • eventsinteger[]
  • actionstring

    Request action (post/get/put/delete)

    Example: post
  • urlstring

    Valid url for webhook

    Example: https://webhook.site/7b152643-b570-46dd-976c-bee83497af41
  • headersobject[]
  • content_typestring

    The body content type (system/custom)

    Example: system

webhookListRequest

  • offsetinteger

    The offset of the results (start from offset and get the limit)

    Example: 0
  • limitinteger · max: 50

    The limit of results for pagination

    Example: 20
  • searchstring

    Search webhooks by name or description

    Example: my webhook 2

webhookCrudResponse

  • successstring
    Example: true
  • responseobject

webhookCreateUpdateRequest

  • namestring

    The name of the webhook

    Example: webhook1
  • descriptionstring

    The description of the webhook

    Example: description1
  • eventsinteger[]

    Array of evnt ids (check webhook event request)

    Example: [1,2]
  • actionstring

    The action of the webhook request (post/put/delete/get)

    Example: post
  • urlstring

    The url of the webhook request

    Example: https://webhook.site/7b152643-b570-46dd-976c-bee83497af41
  • headersobject[]
  • content_typestring

    The body sent type can be "json" / "system"

    Example: system

webhookEventListResponse

  • event_idinteger

    The event id used to create/update webhooks

    Example: 1
  • event_slugstring

    The event short description formated to slug

    Example: new_order
  • event_groupstring

    The event group current slug related to (not used)

    Example: orders

ProductSingleResponse

  • successboolean
    Example: true
  • productobject
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

ProductBulkEditResponse

  • successboolean
    Example: true
  • responsestring
    Example: Product bulk edit complete
  • updated_productsinteger[]

    List of items that updated

    Example: [64222,53331]
  • nothing_to_update_productsinteger[]

    List of items that were nothing to update

    Example: [54222,23331]
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

ProductBulkEditRequest

  • product_idinteger

    Product ID that we update

    Example: 23331
  • quantityinteger

    Updated product's quantity

    Example: 3
  • pricenumber · float

    Product's price

    Example: 56.76

ProductListResponse

  • successboolean
    Example: true
  • Productsobject[]
  • resultsnumber
    Example: 233
  • pagesnumber
    Example: 100
  • pagenumber
    Example: 4
  • per_pagenumber
    Example: 2
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

ProductAddRequest

  • product_descriptionobject · required
    Example: {"3":{"name":"Green socks","description":"My brand socks"}}
  • skustring

    The SKU od the product

    Example: dkasj234
  • modelstring
  • minimuminteger

    minimum items to add to cart

    Example: 10
  • upcstring

    UPC code for current product

  • weightinteger · float

    Numeric value of the weight of the product, if not passed it is zero

    Example: 40
  • weight_class_idinteger · int32

    The id of the weight class you are using for current product (There is separate API request that return all the weight classes, check "misc/dimension_lst")

    Example: 3
  • lengthinteger · float

    Numeric value of the length of the product, if not passed it is zero

    Example: 15
  • widthinteger · float

    Numeric value of the width of the product, if not passed it is zero

    Example: 15
  • heightinteger · float

    Numeric value of the height of the product, if not passed it is zero

    Example: 15
  • length_class_idinteger · int32

    The id of the length class you are using for current product (There is separate API request that return all the weight classes, check "misc/dimension_lst")

    Example: 3
  • stock_statusinteger

    Valid stock status id (you can find them in separate API call the returns stock status ids)

    Example: 7
  • subtractinteger · boolean

    Pass '1' if you want to activate subtruct feature, if not pass '0'

  • sort_orderinteger

    The order of the product related to another products

    Example: 9
  • statusinteger · boolean

    If you want disactivate the product pass '0' else pass '1'

  • keywordstring

    Keyword related to SEO

    Example: food
  • quantityinteger

    The quantity of your product

    Example: 10
  • hiddeninteger · boolean

    Hide your product from the customers by passing '1' else pass '0'

    Example: 0
  • imagestring

    Valid URL for valid image format (jpg,jpeg,png)

  • imagesobject[]
  • pricenumber · float
    Example: 56.76
  • product_pricingobject
  • product_relatedinteger[]
    Example: [12,15,33]
  • product_categoryinteger[]
    Example: [555,444,123]
  • product_attributesobject[]
  • product_specialobject[]
  • product_optionobject[]

    Array of options objects

  • shipping_productinteger[]

    Array of numeric shipping ids that valid for product (type 1 and above)

    Example: [12,45,77]
  • sticker_statusinteger · boolean

    Defines if the sticker enabled / enabled/disabled

  • sticker_typestring · enum

    Defines wich type of sticker

    Enum values:
    percent
    sum
    custom
  • sticker_textobject

    The custom option text (for each language)

  • sticker_settingsobject

    All the sticker text styling options

ProductEditRequest

  • skustring

    The SKU od the product

    Example: dkasj234
  • modelstring
  • minimuminteger

    minimum items to add to cart

    Example: 10
  • upcstring

    UPC code for current product

  • weightinteger · float

    Numeric value of the weight of the product, if not passed it is zero

    Example: 40
  • weight_class_idinteger · int32

    The id of the weight class you are using for current product (There is separate API request that return all the weight classes, check "misc/dimension_lst")

    Example: 3
  • lengthinteger · float

    Numeric value of the length of the product, if not passed it is zero

    Example: 15
  • widthinteger · float

    Numeric value of the width of the product, if not passed it is zero

    Example: 15
  • heightinteger · float

    Numeric value of the height of the product, if not passed it is zero

    Example: 15
  • length_class_idinteger · int32

    The id of the length class you are using for current product (There is separate API request that return all the weight classes, check "misc/dimension_lst")

    Example: 3
  • stock_statusinteger

    Valid stock status id (you can find them in separate API call the returns stock status ids)

    Example: 7
  • subtractinteger · boolean

    Pass '1' if you want to activate subtruct feature, if not pass '0'

  • sort_orderinteger

    The order of the product related to another products

    Example: 9
  • statusinteger · boolean

    If you want disactivate the product pass '0' else pass '1'

  • keywordstring

    Keyword related to SEO

    Example: food
  • quantityinteger

    The quantity of your product

    Example: 10
  • hiddeninteger · boolean

    Hide your product from the customers by passing '1' else pass '0'

    Example: 0
  • imagestring

    Valid URL for valid image format (jpg,jpeg,png)

  • imagesobject[]

    Array of additional images sent for each product (optional)

  • pricenumber · float
    Example: 56.76
  • product_pricingobject
  • product_relatedinteger[]
    Example: [12,15,33]
  • product_categoryinteger[]
    Example: [555,444,123]
  • product_descriptionobject
    Example: {"3":{"name":"Green socks","description":"My brand socks"}}
  • sticker_statusinteger · boolean

    Defines if the the sticker enabled/disabled

  • sticker_typestring · enum

    Defines the type of the sticker

    Enum values:
    percent
    sum
    custom
  • sticker_textobject

    The text appears on sticker (referenced by language id) in case of custom text chosen

  • sticker_settingsobject

    The sticker text styling

  • product_optionobject[]

    Array of options objects (If you want to empty the option pass empty array !)

  • shipping_productinteger[]

    Array of numeric shipping ids that valid for product (type 1 and above)

    Example: [12,45,77]
  • product_specialobject[]

ProductLanguageObject

  • language_idobject · required

    Valid language id that activated in your system

ProductAttributes

  • attribute_idinteger
  • namestring
  • attributesobject

ProductSpecials

  • priceinteger · float

    The price of the discount for current product must be float type more then zero

    Example: 0
  • date_startstring · date

    Start date for current discount is required, format {Y-m-d} see example below

    Example: 2018-12-02
  • date_endstring · date

    End date for current discount is required, format {Y-m-d} see example below

    Example: 2018-12-02

ProductOptionsValues

  • option_value_idinteger

    The id of the current option value related to the father option (shown from list)

    Example: 44
  • quantityinteger

    The quantity of the current value (not required)

  • subtractinteger · boolean

    Set '1' if this value is subtractable or '0' if not

    Example: 1
  • priceinteger · float

    If there is additional price for current value or maybe discount add it here

    Example: 12.99
  • price_prefixstring · enum

    Set "+" (plus) if the price is additional or "-" (minus) if the price will be less for current value

    Enum values:
    +
    -
  • imagestring

    Valid url if an image will be related to current value (available only for "select" type of option for now)

    Example: https://www.exampleweb.com/example_img.jpg
  • groupsobject[]

    Array of related options and option values to current value that will be subtracted together. Requires the "Advanced Inventory Management" app to be activated

ProductCrudOptionObject

  • product_option_idnumber

    Product option id (if exist)

    Example: 23
  • namestring

    The name of the option (chosen from option list may include multiple languages)

    Example: size
  • option_idstring

    The option id (return from option list GET request) have to be numeric string

    Example: 123
  • typestring

    The option type (Also return from option GET list each option has type)

    Example: checkbox
  • requiredinteger · boolean

    Set '1' if this option is required to proceed the product purchase

  • product_option_valueobject[]

    Array of option values that will be shown related to product

CategorySingleSingle

  • successboolean
    Example: true
  • category_idinteger
    Example: 45
  • sort_orderinteger
    Example: 10
  • topinteger
    Example: 0
  • parent_idinteger
    Example: 2
  • statusinteger
    Example: 1
  • imagestring
    Example: https://example.com/images/sample-image.png
  • keywordstring
    Example: new-keyword-123
  • homefeaturedinteger
    Example: 1
  • hiddeninteger
    Example: 1
  • urlstring
    Example: https://example.com/new-category-url
  • descriptionobject

    The key of the object represent the language id

    Example: {"3":{"name":"Canned Goods","description":"Assorted canned goods.","meta_title":"Canned Goods","meta_description":"Variety of canned goods.","meta_keyword":"Canned,Goods,Food"}}
  • category_filtersobject
    Example: {"30":{"filter_id":30,"filter_name":"Added Value","filter_group_id":16,"filter_group_name":"Value Group"}}
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

CategoryCreateEdit

  • descriptionsobject

    Object with language ids as index

    Example: {"3":{"name":"T-shirts","description":"My T-shirts description","meta_title":"T-shirts","meta_description":"My T-shirts description","meta_keyword":"My,T-shirts,clothes"}}
  • parent_idstring

    Set parent category (from your own categories ids), set 0 to ignore this option

    Example: 2
    Default: 0
  • keywordstring

    Set url keyword

    Example: my-category
  • imagestring

    Inser valid image url (best to use cloudinary service to upload there first)

  • topinteger · boolean

    Show/Hide this category at the top bar (0/1)

  • sort_orderinteger

    Set category order number (affect the visual part in the store)

    Example: 12
  • homefeaturedinteger · boolean

    Show/Hide this category at the main page (1/0)

  • statusinteger · boolean

    Enable/Disable this category (1/0)

  • hiddeninteger · boolean

    Show/Hide the category from the store area (will be available by direct link to)

CategoryListResponse

  • successboolean
    Example: true
  • responseobject[]
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

CategoryMutualResponse

  • category_idinteger
    Example: 45
  • sort_orderinteger
    Example: 10
  • topinteger
    Example: 0
  • parent_idinteger
    Example: 2
  • statusinteger
    Example: 1
  • imagestring
    Example: https://example.com/images/sample-image.png
  • keywordstring
    Example: new-keyword-123
  • homefeaturedinteger
    Example: 1
  • hiddeninteger
    Example: 1
  • urlstring
    Example: https://example.com/new-category-url

OrderListResponse

  • successboolean
    Example: true
  • responseobject[]

    array with all orders

  • resultsnumber
    Example: 233
  • pagesnumber
    Example: 100
  • pagenumber
    Example: 4
  • per_pagenumber
    Example: 2
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

OrderSingleResponse

  • successboolean
    Example: true
  • responseobject
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

OrderProductsHistories

  • notifystring

    If notifed the customer about the status change it will be "yes" in local language

    Example: true
  • statusstring

    The status that set in current change

    Example: paid
  • date_addedstring · date

    The date when the status changed for current object

    Example: 14/06/2020

OrderTotalsData

  • titlestring

    Description of the total

    Example: Discount for coupon
  • valueinteger

    The value is the sum that current total paid/discounted

    Example: 245
  • codestring

    The code of current total item

    Example: shipping

OrderProductsData

  • order_product_idinteger
  • product_idinteger

    The product id

  • namestring

    The product name

  • modelstring
  • skustring
  • quantityinteger

    The quantity of this product at the current order

  • priceinteger

    The price of this current product

  • specialinteger

    Represents special price if was enabled

  • original_priceinteger

    Assiciated with the special (show the original price)

  • weightinteger · float

    Numeric value of the weight of the product, if not passed it is zero

    Example: 40
  • weight_class_idinteger · int32

    The id of the weight class you are using for current product (There is separate API request that return all the weight classes, check "misc/dimension_lst")

    Example: 3
  • lengthinteger · float

    Numeric value of the length of the product, if not passed it is zero

    Example: 15
  • widthinteger · float

    Numeric value of the width of the product, if not passed it is zero

    Example: 15
  • heightinteger · float

    Numeric value of the height of the product, if not passed it is zero

    Example: 15
  • length_class_idinteger · int32

    The id of the length class you are using for current product (There is separate API request that return all the weight classes, check "misc/dimension_lst")

    Example: 3
  • optionobject[]

OrderCreateDocRequest

  • doc_typestring · enum

    The document type must be one of (invrec,invoice,receipt,refund)

    Enum values:
    invrec
    invoice
    receipt
    refund
    Example: invoice
  • company_personal_namestring

    Not required field that allows you to override the exist name with new personal/company name for invoice

    Example: My Company LTD
  • company_personal_idstring

    Not required field that allows you to override the esit persona; id with new personal/company Bn Number

    Example: 23455234234
  • telephonestring

    Not required field that allows you to override order's phone for the document

    Example: 0548654366
  • emailstring

    Not required field that allows you to override order's email for the document receiver

  • refund_sum

OrderCreateShippingRequest

  • providerstring · enum

    Required field what shipping provider to create

    Enum values:
    chita
    Example: chita
  • packages_numberinteger

    The package number you will send and will be charged for (and get sticker for each package)

    Example: 3
  • shipping_typestring · enum

    The shipping type for current provider not required

    Enum values:
    door_to_door
    lockers
    Example: door_to_door

OrderProviderShippingRequest

  • providerstring · enum

    Required field what shipping provider to create

    Enum values:
    chita
    Example: chita

OrderCreateDocResponse

  • successboolean
    Example: true
  • responseobject
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

OrderCreateShippingResponse

  • successboolean
    Example: true
  • responseobject
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

OrderStatusShippingResponse

  • successboolean
    Example: true
  • responseobject
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

OrderStatusList

  • successboolean
    Example: true
  • responseobject
    Example: {"1":[{"order_status_id":2,"name":"Processing"},{"order_status_id":3,"name":"Shipped"}]}
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

OrderStatusUpdateRequest

  • order_status_idinteger · required

    Number that represent valid order status id (you can find API call for this statuses)

    Example: 2
  • commentstring

    Comment that will appear in the order status history related to the status you update

    Example: Sent to customer X
  • notifyinteger · enum

    Pass 1 if you want to notifiy the customer abouth the status change

    Enum values:
    0
    1
    Default: 0
  • sms_notifyinteger · enum

    Pass 1 if you want to notify client by sms

    Enum values:
    0
    1
    Default: 0
  • sms_contentstring · max: 150

    Message that will be sent to the customer associated with current order

    Example: Thank you, your order complete!
    Default: null

OrderHistoryUpdateRequest

  • commentstring · required

    Comment that will appear in the order status history related to the status you update

    Example: Sent to customer X

CustomOrderListRequest

  • date_fromstring

    Valid date (year-month-day) wich we start the filter from

    Example: 2020-01-20
  • date_tostring

    Valid date (year-month-day) wich we end the filter

    Example: 2020-01-25
  • limitinteger · min: 1 · max: 100

    Limit orders per page (minimum 1)

    Example: 10
  • pageinteger · min: 1

    Limit orders per page (minimum 1)

    Example: 1

CustomOrderListResponse

  • successboolean
    Example: true
  • responseobject[]

    array with all orders

  • resultsnumber
    Example: 233
  • pagesnumber
    Example: 100
  • pagenumber
    Example: 4
  • per_pagenumber
    Example: 2
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

CustomOrderSingleResponse

  • successboolean
    Example: true
  • responseobject
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

OptionListResponse

  • successboolean
    Example: true
  • responseobject[]
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

OptionSingleResponse

  • successboolean
    Example: true
  • responseobject
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

OptionCreateRequest

  • typestring · enum · required
    Enum values:
    select
    radio
    checkbox
    text
    file
    date
    time
    datetime
  • option_descriptionobject[] · required
  • option_valueobject[]

OptionCreateResponse

  • successboolean
    Example: true
  • responseinteger

    Created option id

  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

OptionUpdateRequest

  • typestring · enum · required
    Enum values:
    select
    radio
    checkbox
    text
    file
    date
    time
    datetime
  • option_descriptionobject[] · required
  • option_valueobject[]

OptionUpdateResponse

  • successboolean
    Example: true
  • responseobject
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

OptionDeleteResponse

  • successboolean
    Example: true
  • responseboolean
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49