Sign in
Products/BOM-Lines

Add a component to a BOM. The body carries two different products: entity is the product whose BOM is being edited (it selects the BOM link to act through, and decides whether the shared BOM is edited or forked for that product first), while component is the part being added and is what the line stores. Both accept a Retraced ID or your own externalId. bomHeaderId alone is not enough, because one BOM header is linked to a style and every variant/SKU inheriting it, each with its own ownership flag.

post/api/bom-lines/

Request body

bomHeaderIdstring required
placementIdstring nullable
quantitynumber nullable
quantityUnit'LITRE' | 'MILLILITRE' | 'CENTILITRE' | 'CUBIC_DECIMETRE' | 'CUBIC_METRE' | 'GALLON' | 'QUART' | 'PINT' | 'GILL' | 'FLUID_OUNCE' | 'FLUID_DRAM' | 'MINIM' | 'BUSHEL' | 'ACRE_FOOT' | 'CORD' | 'CUBIC_YARD' | 'CUBIC_FOOT' | 'CUBIC_INCH' | 'PECK' | 'METRE' | 'MILLIMETRE' | 'DECIMETRE' | 'CENTIMETRE' | 'INCH' | 'NAUTICAL_MILE' | 'MILE' | 'FURLONG' | 'ROD' | 'FATHOM' | 'YARD' | 'FOOT' | 'GRAM' | 'GRAM_PER_SQUARE_METER' | 'GRAM_PER_SQUARE_FOOT' | 'GRAM_PER_SQUARE_YARD' | 'OUNCE_PER_SQUARE_YARD' | 'MILLIGRAM' | 'KILOGRAM' | 'METRIC_TON' | 'POUNDS' | 'SHORT_TON' | 'LONG_TON' | 'HUNDREDWEIGHT' | 'SHORT_HUNDREDWEIGHT' | 'LONG_HUNDREDWEIGHT' | 'OUNCE' | 'DRAM' | 'GRAIN' | 'PENNYWEIGHT' | 'SCRUPLE' | 'STONE' | 'SQUARE_METRE' | 'SQUARE_DECIMETRE' | 'SQUARE_CENTIMETRE' | 'SQUARE_INCH' | 'SQUARE_MILE' | 'SQUARE_FEET' | 'SQUARE_ROD' | 'SQUARE_YARD' | 'ACRE' | 'PIECES' | 'PAIR' | 'PERCENTAGE' | 'DENIER' | 'JUTE' | 'ENGLISH_COUNT' | 'METRIC_COUNT' | 'WORSTED_COUNT' | 'TEX' | 'KILOWATT_HOUR' | 'MOUND'
weightnumber nullable
weightUnit'LITRE' | 'MILLILITRE' | 'CENTILITRE' | 'CUBIC_DECIMETRE' | 'CUBIC_METRE' | 'GALLON' | 'QUART' | 'PINT' | 'GILL' | 'FLUID_OUNCE' | 'FLUID_DRAM' | 'MINIM' | 'BUSHEL' | 'ACRE_FOOT' | 'CORD' | 'CUBIC_YARD' | 'CUBIC_FOOT' | 'CUBIC_INCH' | 'PECK' | 'METRE' | 'MILLIMETRE' | 'DECIMETRE' | 'CENTIMETRE' | 'INCH' | 'NAUTICAL_MILE' | 'MILE' | 'FURLONG' | 'ROD' | 'FATHOM' | 'YARD' | 'FOOT' | 'GRAM' | 'GRAM_PER_SQUARE_METER' | 'GRAM_PER_SQUARE_FOOT' | 'GRAM_PER_SQUARE_YARD' | 'OUNCE_PER_SQUARE_YARD' | 'MILLIGRAM' | 'KILOGRAM' | 'METRIC_TON' | 'POUNDS' | 'SHORT_TON' | 'LONG_TON' | 'HUNDREDWEIGHT' | 'SHORT_HUNDREDWEIGHT' | 'LONG_HUNDREDWEIGHT' | 'OUNCE' | 'DRAM' | 'GRAIN' | 'PENNYWEIGHT' | 'SCRUPLE' | 'STONE' | 'SQUARE_METRE' | 'SQUARE_DECIMETRE' | 'SQUARE_CENTIMETRE' | 'SQUARE_INCH' | 'SQUARE_MILE' | 'SQUARE_FEET' | 'SQUARE_ROD' | 'SQUARE_YARD' | 'ACRE' | 'PIECES' | 'PAIR' | 'PERCENTAGE' | 'DENIER' | 'JUTE' | 'ENGLISH_COUNT' | 'METRIC_COUNT' | 'WORSTED_COUNT' | 'TEX' | 'KILOWATT_HOUR' | 'MOUND'
countryOfOriginstring nullable
isMainComponentboolean

Response

Default Response

Changes

Changed in 1 of the 49 revisions of this API.19317

  • 97e51f27dc7719317See the full diff
    • ▲

      added to the request property allOf list

      request-property-all-of-added

    • ▲

      added to the request property allOf list

      request-property-all-of-added

    • ▲

      removed subschema #2 from the request property anyOf list

      request-property-any-of-removed

    • ▲

      removed subschema #2 from the request property anyOf list

      request-property-any-of-removed

    • ▲

      request property list-of-types was narrowed by removing types null from media type application/json

      request-property-list-of-types-narrowed

    • ▲

      request property list-of-types was narrowed by removing types null from media type application/json

      request-property-list-of-types-narrowed

    • ▲

      request property list-of-types was narrowed by removing types null from media type application/json

      request-property-list-of-types-narrowed

    • ▲

      request property list-of-types was narrowed by removing types null from media type application/json

      request-property-list-of-types-narrowed

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ●

      the request property's maxLength was set to 100

      request-property-max-length-set

    • ●

      the request property's min was set to 0.00

      request-property-min-set

    • ●

      the request property's min was set to 0.00

      request-property-min-set

    • ○

      the request property became nullable

      request-property-became-nullable

    • ○

      the request property became nullable

      request-property-became-nullable

    • ○

      the request property became nullable

      request-property-became-nullable

    • ○

      the request property became nullable

      request-property-became-nullable

    • ○

      the request property became nullable

      request-property-became-nullable

    • ○

      the request property became nullable

      request-property-became-nullable

    • ○

      response property data/countryOfOrigin list-of-types was narrowed by removing types null from media type application/json of response 201

      response-property-list-of-types-narrowed

    • ○

      response property data/createdByCompanyId list-of-types was narrowed by removing types null from media type application/json of response 201

      response-property-list-of-types-narrowed

    • ○

      response property data/createdByUserId list-of-types was narrowed by removing types null from media type application/json of response 201

      response-property-list-of-types-narrowed

    • ○

      response property data/placementId list-of-types was narrowed by removing types null from media type application/json of response 201

      response-property-list-of-types-narrowed

    • ○

      response property data/quantity list-of-types was narrowed by removing types null from media type application/json of response 201

      response-property-list-of-types-narrowed

    • ○

      response property data/quantityUnit list-of-types was narrowed by removing types null from media type application/json of response 201

      response-property-list-of-types-narrowed

    • ○

      response property data/styleId list-of-types was narrowed by removing types null from media type application/json of response 201

      response-property-list-of-types-narrowed

    • ○

      response property data/updatedByCompanyId list-of-types was narrowed by removing types null from media type application/json of response 201

      response-property-list-of-types-narrowed

    • ○

      response property data/updatedByUserId list-of-types was narrowed by removing types null from media type application/json of response 201

      response-property-list-of-types-narrowed

    • ○

      response property data/weight list-of-types was narrowed by removing types null from media type application/json of response 201

      response-property-list-of-types-narrowed

    • ○

      response property data/weightUnit list-of-types was narrowed by removing types null from media type application/json of response 201

      response-property-list-of-types-narrowed

Of the 49 revisions, 1 has no diff computed.