Sign in
inventory

Changed on

Create a material

post/api/inventory/material/

Request

  • The document declares no server URL.
  • Auth: none declared

Headers

Authorizationstring

Authorization token

Request body

identifierstring nullable
namestring nullable required
name_shortstring nullable
unitstring nullable
supplierstring nullable
supplier_relationinteger nullable
product_typestring nullable
price_purchasestring decimal
price_purchase_currency'USD' | 'EUR' | 'GBP'
  • USD - USD
  • EUR - EUR
  • GBP - GBP
price_sellingstring decimal
price_selling_currency'USD' | 'EUR' | 'GBP'
  • USD - USD
  • EUR - EUR
  • GBP - GBP
price_selling_altstring decimal
price_selling_alt_currency'USD' | 'EUR' | 'GBP'
  • USD - USD
  • EUR - EUR
  • GBP - GBP
price_purchase_exstring decimal
price_purchase_ex_currency'USD' | 'EUR' | 'GBP'
  • USD - USD
  • EUR - EUR
  • GBP - GBP
price_selling_exstring decimal
price_selling_ex_currency'USD' | 'EUR' | 'GBP'
  • USD - USD
  • EUR - EUR
  • GBP - GBP
price_selling_alt_exstring decimal
price_selling_alt_ex_currency'USD' | 'EUR' | 'GBP'
  • USD - USD
  • EUR - EUR
  • GBP - GBP
external_identifierstring nullable
imagestring nullable

Base64 on the way in, a URL on the way out. Sending a data URI ("data:image/png;base64,...") or a bare base64 payload both store the image; reading the field back gives the stored file's URL.

Response

idinteger required
identifierstring nullable
show_namestring nullable required
namestring nullable required
name_shortstring nullable
unitstring nullable
supplierstring nullable
supplier_relationinteger nullable
product_typestring nullable
price_purchasestring decimal
price_purchase_currency'USD' | 'EUR' | 'GBP'
  • USD - USD
  • EUR - EUR
  • GBP - GBP
price_sellingstring decimal
price_selling_currency'USD' | 'EUR' | 'GBP'
  • USD - USD
  • EUR - EUR
  • GBP - GBP
price_selling_altstring decimal
price_selling_alt_currency'USD' | 'EUR' | 'GBP'
  • USD - USD
  • EUR - EUR
  • GBP - GBP
price_purchase_exstring decimal
price_purchase_ex_currency'USD' | 'EUR' | 'GBP'
  • USD - USD
  • EUR - EUR
  • GBP - GBP
price_selling_exstring decimal
price_selling_ex_currency'USD' | 'EUR' | 'GBP'
  • USD - USD
  • EUR - EUR
  • GBP - GBP
price_selling_alt_exstring decimal
price_selling_alt_ex_currency'USD' | 'EUR' | 'GBP'
  • USD - USD
  • EUR - EUR
  • GBP - GBP
external_identifierstring nullable
imagestring nullable

Base64 on the way in, a URL on the way out. Sending a data URI ("data:image/png;base64,...") or a bare base64 payload both store the image; reading the field back gives the stored file's URL.

Changes

  • a6565d9d759fRevision changes
    • breaking

      request property was restricted to a list of enum values (media type: application/json)

    • breaking

      request property was restricted to a list of enum values (media type: application/x-www-form-urlencoded)

    • breaking

      request property was restricted to a list of enum values (media type: multipart/form-data)

    • breaking

      request property was restricted to a list of enum values (media type: application/json)

    • breaking

      request property was restricted to a list of enum values (media type: application/x-www-form-urlencoded)

    • breaking

      request property was restricted to a list of enum values (media type: multipart/form-data)

    • breaking

      request property was restricted to a list of enum values (media type: application/json)

    • breaking

      request property was restricted to a list of enum values (media type: application/x-www-form-urlencoded)

    • breaking

      request property was restricted to a list of enum values (media type: multipart/form-data)

    • breaking

      request property was restricted to a list of enum values (media type: application/json)

    • breaking

      request property was restricted to a list of enum values (media type: application/x-www-form-urlencoded)

    • breaking

      request property was restricted to a list of enum values (media type: multipart/form-data)

    • breaking

      request property was restricted to a list of enum values (media type: application/json)

    • breaking

      request property was restricted to a list of enum values (media type: application/x-www-form-urlencoded)

    • breaking

      request property was restricted to a list of enum values (media type: multipart/form-data)

    • breaking

      request property was restricted to a list of enum values (media type: application/json)

    • breaking

      request property was restricted to a list of enum values (media type: application/x-www-form-urlencoded)

    • breaking

      request property was restricted to a list of enum values (media type: multipart/form-data)

    • breaking

      the request property became not nullable (media type: application/json)

    • breaking

      the request property became not nullable (media type: application/x-www-form-urlencoded)

    • breaking

      the request property became not nullable (media type: multipart/form-data)

    • breaking

      the request property became not nullable (media type: application/json)

    • breaking

      the request property became not nullable (media type: application/x-www-form-urlencoded)

    • breaking

      the request property became not nullable (media type: multipart/form-data)

    • breaking

      the request property became not nullable (media type: application/json)

    • breaking

      the request property became not nullable (media type: application/x-www-form-urlencoded)

    • breaking

      the request property became not nullable (media type: multipart/form-data)

    • breaking

      the request property became not nullable (media type: application/json)

    • breaking

      the request property became not nullable (media type: application/x-www-form-urlencoded)

    • breaking

      the request property became not nullable (media type: multipart/form-data)

    • breaking

      the request property became not nullable (media type: application/json)

    • breaking

      the request property became not nullable (media type: application/x-www-form-urlencoded)

    • breaking

      the request property became not nullable (media type: multipart/form-data)

    • breaking

      the request property became not nullable (media type: application/json)

    • breaking

      the request property became not nullable (media type: application/x-www-form-urlencoded)

    • breaking

      the request property became not nullable (media type: multipart/form-data)

    • breaking

      the request property type changed from no type to string (media type: application/json)

    • breaking

      the request property type changed from no type to string (media type: application/json)

    • breaking

      the request property type changed from no type to string (media type: application/json)

    • breaking

      the request property type changed from no type to string (media type: application/json)

    • breaking

      the request property type changed from no type to string (media type: application/json)

    • breaking

      the request property type changed from no type to string (media type: application/json)

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • warning

      removed from the request property allOf list (media type: application/json)

    • warning

      removed from the request property allOf list (media type: application/x-www-form-urlencoded)

    • warning

      removed from the request property allOf list (media type: multipart/form-data)

    • warning

      removed from the request property allOf list (media type: application/json)

    • warning

      removed from the request property allOf list (media type: application/x-www-form-urlencoded)

    • warning

      removed from the request property allOf list (media type: multipart/form-data)

    • warning

      removed from the request property allOf list (media type: application/json)

    • warning

      removed from the request property allOf list (media type: application/x-www-form-urlencoded)

    • warning

      removed from the request property allOf list (media type: multipart/form-data)

    • warning

      removed from the request property allOf list (media type: application/json)

    • warning

      removed from the request property allOf list (media type: application/x-www-form-urlencoded)

    • warning

      removed from the request property allOf list (media type: multipart/form-data)

    • warning

      removed from the request property allOf list (media type: application/json)

    • warning

      removed from the request property allOf list (media type: application/x-www-form-urlencoded)

    • warning

      removed from the request property allOf list (media type: multipart/form-data)

    • warning

      removed from the request property allOf list (media type: application/json)

    • warning

      removed from the request property allOf list (media type: application/x-www-form-urlencoded)

    • warning

      removed from the request property allOf list (media type: multipart/form-data)

    • warning

      added the new EUR enum value to the response property for the response status

    • warning

      added the new EUR enum value to the response property for the response status

    • warning

      added the new EUR enum value to the response property for the response status

    • warning

      added the new EUR enum value to the response property for the response status

    • warning

      added the new EUR enum value to the response property for the response status

    • warning

      added the new EUR enum value to the response property for the response status

    • warning

      added the new GBP enum value to the response property for the response status

    • warning

      added the new GBP enum value to the response property for the response status

    • warning

      added the new GBP enum value to the response property for the response status

    • warning

      added the new GBP enum value to the response property for the response status

    • warning

      added the new GBP enum value to the response property for the response status

    • warning

      added the new GBP enum value to the response property for the response status

    • warning

      added the new USD enum value to the response property for the response status

    • warning

      added the new USD enum value to the response property for the response status

    • warning

      added the new USD enum value to the response property for the response status

    • warning

      added the new USD enum value to the response property for the response status

    • warning

      added the new USD enum value to the response property for the response status

    • warning

      added the new USD enum value to the response property for the response status

    • info

      added the new EUR enum value to the request property (media type: application/json)

    • info

      added the new EUR enum value to the request property (media type: application/x-www-form-urlencoded)

    • info

      added the new EUR enum value to the request property (media type: multipart/form-data)

    • info

      added the new EUR enum value to the request property (media type: application/json)

    • info

      added the new EUR enum value to the request property (media type: application/x-www-form-urlencoded)

    • info

      added the new EUR enum value to the request property (media type: multipart/form-data)

    • info

      added the new EUR enum value to the request property (media type: application/json)

    • info

      added the new EUR enum value to the request property (media type: application/x-www-form-urlencoded)

    • info

      added the new EUR enum value to the request property (media type: multipart/form-data)

    • info

      added the new EUR enum value to the request property (media type: application/json)

    • info

      added the new EUR enum value to the request property (media type: application/x-www-form-urlencoded)

    • info

      added the new EUR enum value to the request property (media type: multipart/form-data)

    • info

      added the new EUR enum value to the request property (media type: application/json)

    • info

      added the new EUR enum value to the request property (media type: application/x-www-form-urlencoded)

    • info

      added the new EUR enum value to the request property (media type: multipart/form-data)

    • info

      added the new EUR enum value to the request property (media type: application/json)

    • info

      added the new EUR enum value to the request property (media type: application/x-www-form-urlencoded)

    • info

      added the new EUR enum value to the request property (media type: multipart/form-data)

    • info

      added the new GBP enum value to the request property (media type: application/json)

    • info

      added the new GBP enum value to the request property (media type: application/x-www-form-urlencoded)

    • info

      added the new GBP enum value to the request property (media type: multipart/form-data)

    • info

      added the new GBP enum value to the request property (media type: application/json)

    • info

      added the new GBP enum value to the request property (media type: application/x-www-form-urlencoded)

    • info

      added the new GBP enum value to the request property (media type: multipart/form-data)

    • info

      added the new GBP enum value to the request property (media type: application/json)

    • info

      added the new GBP enum value to the request property (media type: application/x-www-form-urlencoded)

    • info

      added the new GBP enum value to the request property (media type: multipart/form-data)

    • info

      added the new GBP enum value to the request property (media type: application/json)

    • info

      added the new GBP enum value to the request property (media type: application/x-www-form-urlencoded)

    • info

      added the new GBP enum value to the request property (media type: multipart/form-data)

    • info

      added the new GBP enum value to the request property (media type: application/json)

    • info

      added the new GBP enum value to the request property (media type: application/x-www-form-urlencoded)

    • info

      added the new GBP enum value to the request property (media type: multipart/form-data)

    • info

      added the new GBP enum value to the request property (media type: application/json)

    • info

      added the new GBP enum value to the request property (media type: application/x-www-form-urlencoded)

    • info

      added the new GBP enum value to the request property (media type: multipart/form-data)

    • info

      added the new USD enum value to the request property (media type: application/json)

    • info

      added the new USD enum value to the request property (media type: application/x-www-form-urlencoded)

    • info

      added the new USD enum value to the request property (media type: multipart/form-data)

    • info

      added the new USD enum value to the request property (media type: application/json)

    • info

      added the new USD enum value to the request property (media type: application/x-www-form-urlencoded)

    • info

      added the new USD enum value to the request property (media type: multipart/form-data)

    • info

      added the new USD enum value to the request property (media type: application/json)

    • info

      added the new USD enum value to the request property (media type: application/x-www-form-urlencoded)

    • info

      added the new USD enum value to the request property (media type: multipart/form-data)

    • info

      added the new USD enum value to the request property (media type: application/json)

    • info

      added the new USD enum value to the request property (media type: application/x-www-form-urlencoded)

    • info

      added the new USD enum value to the request property (media type: multipart/form-data)

    • info

      added the new USD enum value to the request property (media type: application/json)

    • info

      added the new USD enum value to the request property (media type: application/x-www-form-urlencoded)

    • info

      added the new USD enum value to the request property (media type: multipart/form-data)

    • info

      added the new USD enum value to the request property (media type: application/json)

    • info

      added the new USD enum value to the request property (media type: application/x-www-form-urlencoded)

    • info

      added the new USD enum value to the request property (media type: multipart/form-data)

    • info

      the request property type was generalized from no type to string (media type: application/x-www-form-urlencoded)

    • info

      the request property type was generalized from no type to string (media type: multipart/form-data)

    • info

      the request property type was generalized from no type to string (media type: application/x-www-form-urlencoded)

    • info

      the request property type was generalized from no type to string (media type: multipart/form-data)

    • info

      the request property type was generalized from no type to string (media type: application/x-www-form-urlencoded)

    • info

      the request property type was generalized from no type to string (media type: multipart/form-data)

    • info

      the request property type was generalized from no type to string (media type: application/x-www-form-urlencoded)

    • info

      the request property type was generalized from no type to string (media type: multipart/form-data)

    • info

      the request property type was generalized from no type to string (media type: application/x-www-form-urlencoded)

    • info

      the request property type was generalized from no type to string (media type: multipart/form-data)

    • info

      the request property type was generalized from no type to string (media type: application/x-www-form-urlencoded)

    • info

      the request property type was generalized from no type to string (media type: multipart/form-data)

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

  • e0fd8b64afe2Revision changes
    • info

      the header request parameter Authorization became optional