POST v1/item-builds

Creates new or updates existing builds. This API performs a full update for an existing build, so ensure that all parameters and IDs are correctly supplied when using this api for update. Update is only valid for Builds with Incomplete/Pending Status. When creating a build IF the status is pending or finalized, validation will be performed if the quantity to be built is not available. An error will be returned in that case.

Request Information

URI Parameters

None.

Body Parameters

ItemBuild
NameDescriptionTypeAdditional information
Id

Read-only. Item Build unique id - auto generated by the system.

integer

Required

Range: inclusive between 0 and 2147483647

Item

The item that is being built. Can only be a manufactured item

IdNamePair

Required

InventoryLocation

The inventory location of the item being built. Required when there are more than one locations.

IdNamePair

None.

Class

Build Class - required if Class tracking is on.

IdNamePair

None.

TxnDate

Build date - required. Today's date will be used in case is not specified.

date

None.

TxnNumber

Build reference number - auto generated by the system for new builds if not provided. Required on update.

string

None.

AllowDuplicateTxnNumber

Set to true if you want to skip duplicate check for TxnNumber

boolean

None.

QtyToBuild

Quantity that needs to be built.

decimal number

Required

Memo

Memo of the build.

string

None.

Status

The status of the build.The status of new builds can explicitly be set to any of the following: Incomplete (182), Pending (186), Finalized (170). There will be a validation check if the status is set as Pending OR Finalized to make sure the quantity of BOM is available. This property is read-only for existing builds.

IdNamePair

None.

LineItems

Build line items.

Collection of ItemBuildLineItem

Required

CustomFields

Build custom fields.

Collection of CustomField

None.

AttachmentCount

Read-only. The number of attachments uploaded to the build.

integer

None.

DateCreated

Read-only. The date and time (in clients time zone) when the build was created.

date

None.

CreatedBy

The person who created the build.

IdNamePair

None.

LastUpdatedDate

Read-only. The date and time (in clients time zone) when the build was last updated.

date

None.

LastUpdatedBy

The person who last updated the build.

IdNamePair

None.

Reviewed

Read-only. Indicates whether the build has been reviewed or not.

boolean

None.

DateReviewed

Read-only. The date and time (in clients time zone) when the build was reviewed.

date

None.

ReviewedBy

Read-only. The person who reviewed the build.

IdNamePair

None.

Request Formats

application/json, text/json

Sample:
{
  "id": 1,
  "item": {
    "id": 1,
    "name": "sample string 2"
  },
  "inventoryLocation": {
    "id": 1,
    "name": "sample string 2"
  },
  "class": {
    "id": 1,
    "name": "sample string 2"
  },
  "txnDate": "2022-07-01T15:55:03.2634218-04:00",
  "txnNumber": "sample string 2",
  "allowDuplicateTxnNumber": true,
  "qtyToBuild": 4.0,
  "memo": "sample string 5",
  "status": {
    "id": 1,
    "name": "sample string 2"
  },
  "lineItems": [
    {
      "id": 1,
      "boMComponentId": 2,
      "item": {
        "id": 1,
        "name": "sample string 2"
      },
      "inventoryLocation": {
        "id": 1,
        "name": "sample string 2"
      },
      "description": "sample string 3"
    },
    {
      "id": 1,
      "boMComponentId": 2,
      "item": {
        "id": 1,
        "name": "sample string 2"
      },
      "inventoryLocation": {
        "id": 1,
        "name": "sample string 2"
      },
      "description": "sample string 3"
    }
  ],
  "customFields": [
    {
      "id": 1,
      "name": "sample string 2",
      "fieldType": {
        "id": 1,
        "name": "sample string 2"
      },
      "sourceId": 3,
      "value": "sample string 4",
      "valueText": "sample string 5",
      "isRequired": true
    },
    {
      "id": 1,
      "name": "sample string 2",
      "fieldType": {
        "id": 1,
        "name": "sample string 2"
      },
      "sourceId": 3,
      "value": "sample string 4",
      "valueText": "sample string 5",
      "isRequired": true
    }
  ],
  "attachmentCount": 6,
  "dateCreated": "2022-07-01T15:55:03.2634218-04:00",
  "createdBy": {
    "id": 1,
    "name": "sample string 2"
  },
  "lastUpdatedDate": "2022-07-01T15:55:03.2634218-04:00",
  "lastUpdatedBy": {
    "id": 1,
    "name": "sample string 2"
  },
  "reviewed": true,
  "dateReviewed": "2022-07-01T15:55:03.2634218-04:00",
  "reviewedBy": {
    "id": 1,
    "name": "sample string 2"
  }
}

application/xml, text/xml

Sample:
<ItemBuild xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models.Accounting">
  <AllowDuplicateTxnNumber>true</AllowDuplicateTxnNumber>
  <AttachmentCount>6</AttachmentCount>
  <Class xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </Class>
  <CreatedBy xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </CreatedBy>
  <CustomFields xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Core">
    <d2p1:CustomField>
      <d2p1:FieldType xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:FieldType>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsRequired>true</d2p1:IsRequired>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:SourceId>3</d2p1:SourceId>
      <d2p1:Value>sample string 4</d2p1:Value>
      <d2p1:ValueText>sample string 5</d2p1:ValueText>
    </d2p1:CustomField>
    <d2p1:CustomField>
      <d2p1:FieldType xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:FieldType>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsRequired>true</d2p1:IsRequired>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:SourceId>3</d2p1:SourceId>
      <d2p1:Value>sample string 4</d2p1:Value>
      <d2p1:ValueText>sample string 5</d2p1:ValueText>
    </d2p1:CustomField>
  </CustomFields>
  <DateCreated>2022-07-01T15:55:03.2634218-04:00</DateCreated>
  <DateReviewed>2022-07-01T15:55:03.2634218-04:00</DateReviewed>
  <Id>1</Id>
  <InventoryLocation xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </InventoryLocation>
  <Item xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </Item>
  <LastUpdatedBy xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </LastUpdatedBy>
  <LastUpdatedDate>2022-07-01T15:55:03.2634218-04:00</LastUpdatedDate>
  <LineItems>
    <ItemBuildLineItem>
      <BoMComponentId>2</BoMComponentId>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <InventoryLocation xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </InventoryLocation>
      <Item xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </Item>
    </ItemBuildLineItem>
    <ItemBuildLineItem>
      <BoMComponentId>2</BoMComponentId>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <InventoryLocation xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </InventoryLocation>
      <Item xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </Item>
    </ItemBuildLineItem>
  </LineItems>
  <Memo>sample string 5</Memo>
  <QtyToBuild>4</QtyToBuild>
  <Reviewed>true</Reviewed>
  <ReviewedBy xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </ReviewedBy>
  <Status xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </Status>
  <TxnDate>2022-07-01T15:55:03.2634218-04:00</TxnDate>
  <TxnNumber>sample string 2</TxnNumber>
</ItemBuild>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ItemBuild
NameDescriptionTypeAdditional information
Id

Read-only. Item Build unique id - auto generated by the system.

integer

Required

Range: inclusive between 0 and 2147483647

Item

The item that is being built. Can only be a manufactured item

IdNamePair

Required

InventoryLocation

The inventory location of the item being built. Required when there are more than one locations.

IdNamePair

None.

Class

Build Class - required if Class tracking is on.

IdNamePair

None.

TxnDate

Build date - required. Today's date will be used in case is not specified.

date

None.

TxnNumber

Build reference number - auto generated by the system for new builds if not provided. Required on update.

string

None.

AllowDuplicateTxnNumber

Set to true if you want to skip duplicate check for TxnNumber

boolean

None.

QtyToBuild

Quantity that needs to be built.

decimal number

Required

Memo

Memo of the build.

string

None.

Status

The status of the build.The status of new builds can explicitly be set to any of the following: Incomplete (182), Pending (186), Finalized (170). There will be a validation check if the status is set as Pending OR Finalized to make sure the quantity of BOM is available. This property is read-only for existing builds.

IdNamePair

None.

LineItems

Build line items.

Collection of ItemBuildLineItem

Required

CustomFields

Build custom fields.

Collection of CustomField

None.

AttachmentCount

Read-only. The number of attachments uploaded to the build.

integer

None.

DateCreated

Read-only. The date and time (in clients time zone) when the build was created.

date

None.

CreatedBy

The person who created the build.

IdNamePair

None.

LastUpdatedDate

Read-only. The date and time (in clients time zone) when the build was last updated.

date

None.

LastUpdatedBy

The person who last updated the build.

IdNamePair

None.

Reviewed

Read-only. Indicates whether the build has been reviewed or not.

boolean

None.

DateReviewed

Read-only. The date and time (in clients time zone) when the build was reviewed.

date

None.

ReviewedBy

Read-only. The person who reviewed the build.

IdNamePair

None.

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "item": {
    "id": 1,
    "name": "sample string 2"
  },
  "inventoryLocation": {
    "id": 1,
    "name": "sample string 2"
  },
  "class": {
    "id": 1,
    "name": "sample string 2"
  },
  "txnDate": "2022-07-01T15:55:03.2634218-04:00",
  "txnNumber": "sample string 2",
  "allowDuplicateTxnNumber": true,
  "qtyToBuild": 4.0,
  "memo": "sample string 5",
  "status": {
    "id": 1,
    "name": "sample string 2"
  },
  "lineItems": [
    {
      "id": 1,
      "boMComponentId": 2,
      "item": {
        "id": 1,
        "name": "sample string 2"
      },
      "inventoryLocation": {
        "id": 1,
        "name": "sample string 2"
      },
      "description": "sample string 3"
    },
    {
      "id": 1,
      "boMComponentId": 2,
      "item": {
        "id": 1,
        "name": "sample string 2"
      },
      "inventoryLocation": {
        "id": 1,
        "name": "sample string 2"
      },
      "description": "sample string 3"
    }
  ],
  "customFields": [
    {
      "id": 1,
      "name": "sample string 2",
      "fieldType": {
        "id": 1,
        "name": "sample string 2"
      },
      "sourceId": 3,
      "value": "sample string 4",
      "valueText": "sample string 5",
      "isRequired": true
    },
    {
      "id": 1,
      "name": "sample string 2",
      "fieldType": {
        "id": 1,
        "name": "sample string 2"
      },
      "sourceId": 3,
      "value": "sample string 4",
      "valueText": "sample string 5",
      "isRequired": true
    }
  ],
  "attachmentCount": 6,
  "dateCreated": "2022-07-01T15:55:03.2634218-04:00",
  "createdBy": {
    "id": 1,
    "name": "sample string 2"
  },
  "lastUpdatedDate": "2022-07-01T15:55:03.2634218-04:00",
  "lastUpdatedBy": {
    "id": 1,
    "name": "sample string 2"
  },
  "reviewed": true,
  "dateReviewed": "2022-07-01T15:55:03.2634218-04:00",
  "reviewedBy": {
    "id": 1,
    "name": "sample string 2"
  }
}

application/xml, text/xml

Sample:
<ItemBuild xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models.Accounting">
  <AllowDuplicateTxnNumber>true</AllowDuplicateTxnNumber>
  <AttachmentCount>6</AttachmentCount>
  <Class xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </Class>
  <CreatedBy xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </CreatedBy>
  <CustomFields xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Core">
    <d2p1:CustomField>
      <d2p1:FieldType xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:FieldType>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsRequired>true</d2p1:IsRequired>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:SourceId>3</d2p1:SourceId>
      <d2p1:Value>sample string 4</d2p1:Value>
      <d2p1:ValueText>sample string 5</d2p1:ValueText>
    </d2p1:CustomField>
    <d2p1:CustomField>
      <d2p1:FieldType xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:FieldType>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsRequired>true</d2p1:IsRequired>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:SourceId>3</d2p1:SourceId>
      <d2p1:Value>sample string 4</d2p1:Value>
      <d2p1:ValueText>sample string 5</d2p1:ValueText>
    </d2p1:CustomField>
  </CustomFields>
  <DateCreated>2022-07-01T15:55:03.2634218-04:00</DateCreated>
  <DateReviewed>2022-07-01T15:55:03.2634218-04:00</DateReviewed>
  <Id>1</Id>
  <InventoryLocation xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </InventoryLocation>
  <Item xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </Item>
  <LastUpdatedBy xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </LastUpdatedBy>
  <LastUpdatedDate>2022-07-01T15:55:03.2634218-04:00</LastUpdatedDate>
  <LineItems>
    <ItemBuildLineItem>
      <BoMComponentId>2</BoMComponentId>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <InventoryLocation xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </InventoryLocation>
      <Item xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </Item>
    </ItemBuildLineItem>
    <ItemBuildLineItem>
      <BoMComponentId>2</BoMComponentId>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <InventoryLocation xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </InventoryLocation>
      <Item xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </Item>
    </ItemBuildLineItem>
  </LineItems>
  <Memo>sample string 5</Memo>
  <QtyToBuild>4</QtyToBuild>
  <Reviewed>true</Reviewed>
  <ReviewedBy xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </ReviewedBy>
  <Status xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </Status>
  <TxnDate>2022-07-01T15:55:03.2634218-04:00</TxnDate>
  <TxnNumber>sample string 2</TxnNumber>
</ItemBuild>