Products/BOM-Lines

Changed on

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

  • Base URL
    https://api.retraced.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.retraced.com/api/bom-lines/
  • Auth
    none declared

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' | 'ROLL' | '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' | 'ROLL' | 'DENIER' | 'JUTE' | 'ENGLISH_COUNT' | 'METRIC_COUNT' | 'WORSTED_COUNT' | 'TEX' | 'KILOWATT_HOUR' | 'MOUND'
countryOfOriginstring nullable
isMainComponentboolean

Response

Default Response

Changes

  • 9ab01fbac88cRevision changes
    • info

      added the required property / to the response with the status

  • 5850ee6f0c2dRevision changes
    • info

      added the new ROLL enum value to the request property ////

    • info

      added the new ROLL enum value to the request property ////