GET production/work-orders/{productionWorkOrderId}

Production work order details for provided identifier

Note: Log in to check if your API client have access to run this resource
Version: 26
Success HTTP Status Code: 200

Uri parameters

{productionWorkOrderId} Integer Production work order identifier

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold is required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$expand String, optional Use to expand Output fields that are not shown by default in the output result. Possible Expandable fields are listed in the Output tab for the resource. Accepts a comma-separated list of expandable Output Field names. See the Expand and Select page for more information about this.
$showDomainDescriptions Boolean, optional Use to show an additional descriptional field for fields that are using Domain Values.
$select String, optional Use to define the fields to return in the result. Accepts a comma-separated list of Output Field names. See the Expand and Select page for more information about this.
$db String, optional Set the database to use for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "json"
$lang String, optional Use to get localized responses. Supported formats are 3-letter ISO-639-1 [lll], 2-letter ISO-639-2 [ll], or a combination of a two-letter language code and a two-letter country code ISO-639-2 and ISO-3166-1 [ll_CC], [ll-CC]
$useMinimumVersion Integer, optional This can be used to test a new version of a resource when your ApiClient is running an older, deprecated, version of a resource. $useminimumversion can be used to test against a newer version of the resource. See the Deprecated APIs page for more information about this.

See the page about filters and sorting on how to use filter parameters and named filters.

See the page about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<ProductionWorkOrder>
2
     <ProductionWorkOrderId
ProductionWorkOrderId

Production work order identifier

>
{Integer}</ProductionWorkOrderId>
3
     <Status
Status

Status of production work order

Possible domain values can be found here when logged in

>
{Integer}</Status>
4
     <Type
Type

Type of production work order

Possible domain values can be found here when logged in

>
{String}</Type>
5
     <CreatedAt
CreatedAt

Date and time of creation

>
{Datetime}</CreatedAt>
6
     <RegistrationDate
RegistrationDate

Date of registration

>
{Date}</RegistrationDate>
7
     <CustomersReferenceNumber
CustomersReferenceNumber

Customers order reference. If the production work order is derived from a sales order, the customers order reference will be the same as in the sales order. Typically a reference to an external system.

>
{String}</CustomersReferenceNumber>
8
     <NetWeight
NetWeight

The net weight of object (excluding packing meterial) in kilograms

>
{Decimal}</NetWeight>
9
     <RequestedCompletionDate
RequestedCompletionDate

The requested date of completion for the production work order.

>
{Date}</RequestedCompletionDate>
10
     <ConfirmedCompletionDate
ConfirmedCompletionDate

The confirmed date of completion for the production work order

>
{Date}</ConfirmedCompletionDate>
11
     <ProductRevision
ProductRevision

Product revision used for this production work order

>
{String}</ProductRevision>
12
     <ProductDescription
ProductDescription

Description of the item. If not specified, the description is by default copied from the product.

>
{String}</ProductDescription>
13
     <Quantity
Quantity

The quantity that will be (or has been) produced

>
{Decimal}</Quantity>
14
     <ScheduledStartDate
ScheduledStartDate

Scheduled/planned date of production start

>
{Date}</ScheduledStartDate>
15
     <RemainingQuantity
RemainingQuantity

Remaining number of units to produce

>
{Decimal}</RemainingQuantity>
16
     <PotentialProductionQuantity
PotentialProductionQuantity

Number of products possible to produce with the current stock.

>
{Decimal}</PotentialProductionQuantity>
17
     <HasMaterialShortage
HasMaterialShortage

True if production has supply shortage (negative metarial trend)

>
{Boolean}</HasMaterialShortage>
18
     <IsBlockedForPurchase
IsBlockedForPurchase

True if materials in this production work order should not be purchased

>
{Boolean}</IsBlockedForPurchase>
19
     <OnHold>
20
          <IsOnHold
IsOnHold

Flag to indicate if production work order is on hold

>
{Boolean}</IsOnHold>
21
          <OnHoldAt
OnHoldAt

Date of putting production work order on hold

>
{Datetime}</OnHoldAt>
22
          <Reason
Reason

Reason of putting production work order on hold

>
{String}</Reason>
23
     </OnHold>
24
     <ProductionFor>
25
          <Database
Database

Database of the object

>
{String}</Database>
26
          <ItemId
ItemId

Item-number of the object

>
{Integer}</ItemId>
27
          <ItemType
ItemType

Type of item

>
{String}</ItemType>
28
          <Object>
29
               <ObjectId
ObjectId

Identifier of the object

>
{Integer}</ObjectId>
30
               <ObjectType
ObjectType

Type of object

>
{String}</ObjectType>
31
               <Customer>
32
                    <CustomerId
CustomerId

Customer identifier

>
{Integer}</CustomerId>
33
                    <Name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

>
{String}</Name>
34
                    <CustomerLink
CustomerLink

Customer reference

>
{String}</CustomerLink>
35
               </Customer>
36
               <ObjectLink
ObjectLink

API reference to the object

>
{String}</ObjectLink>
37
          </Object>
38
          <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>
{String}</RamBaseKey>
39
          <ItemLink
ItemLink

API reference to the item

>
{String}</ItemLink>
40
     </ProductionFor>
41
     <Location
Location

The location of the production.

>
42
          <ShortName
ShortName

Unique abbreviation/short name of the location

>
{String}</ShortName>
43
     </Location>
44
     <MeasurementUnit>
45
          <MeasurementUnitId
MeasurementUnitId

Material unit reference

>
{Integer}</MeasurementUnitId>
46
          <MeasurementUnitLink
MeasurementUnitLink

Material unit reference

>
{String}</MeasurementUnitLink>
47
     </MeasurementUnit>
48
     <Product>
49
          <ProductId
ProductId

Product identifier

>
{Integer}</ProductId>
50
          <Name
Name

Name of the product

>
{String}</Name>
51
          <Type
Type

Type of product

Possible domain values can be found here when logged in

>
{String}</Type>
52
          <CountryOfOriginCode
CountryOfOriginCode

Two-character code (ISO 3166) identifying the default country where the product is produced.

>
{String}</CountryOfOriginCode>
53
          <CustomField1
CustomField1

Custom field for grouping, sorting, categorizing and other purposes.

>
{String}</CustomField1>
54
          <CustomField2
CustomField2

Custom field for grouping, sorting, categorizing and other purposes.

>
{String}</CustomField2>
55
          <Dimensions>
56
               <Weight
Weight

The weight of the product in kilograms.

>
{Decimal}</Weight>
57
          </Dimensions>
58
          <Manufacturer>
59
               <ManufacturerId
ManufacturerId

Manufacturer identifier

>
{Integer}</ManufacturerId>
60
               <ShortName
ShortName

Shortname/code of the manufacturer

>
{String}</ShortName>
61
               <ManufacturerLink
ManufacturerLink

Manufacturer reference

>
{String}</ManufacturerLink>
62
          </Manufacturer>
63
          <ProductClassification>
64
               <ProductClassificationId
ProductClassificationId

Product classification identifier

>
{String}</ProductClassificationId>
65
               <ProductClassificationLink
ProductClassificationLink

Product classification reference

>
{String}</ProductClassificationLink>
66
          </ProductClassification>
67
          <ProductLink
ProductLink

Product reference

>
{String}</ProductLink>
68
     </Product>
69
     <ProductStructure>
70
          <ProductStructureId
ProductStructureId

Product structure reference

>
{Integer}</ProductStructureId>
71
          <ProductStructureLink
ProductStructureLink

Product structure reference

>
{String}</ProductStructureLink>
72
     </ProductStructure>
73
     <FinanceProject>
74
          <FinanceProjectId
FinanceProjectId

Finance project identifier

>
{Integer}</FinanceProjectId>
75
          <FinanceProjectLink
FinanceProjectLink

Finance project reference

>
{String}</FinanceProjectLink>
76
     </FinanceProject>
77
     <ProductionPlanner>
78
          <EmployeeId
EmployeeId

Employee identifier

>
{Integer}</EmployeeId>
79
          <EmployeeLink
EmployeeLink

Employee reference

>
{String}</EmployeeLink>
80
     </ProductionPlanner>
81
     <ForwardedFrom
ForwardedFrom

The preceding/previous/source item.

>
82
          <ForwardedQuantity
ForwardedQuantity

The quantity forwarded to this item.

>
{Decimal}</ForwardedQuantity>
83
          <ForwardedFromItem>
84
               <ItemId
ItemId

Identifier of the object

>
{Integer}</ItemId>
85
               <Object>
86
                    <ObjectId
ObjectId

Identifier of the object

>
{Integer}</ObjectId>
87
                    <ObjectType
ObjectType

Type of object

>
{String}</ObjectType>
88
                    <ObjectLink
ObjectLink

API reference to the object

>
{String}</ObjectLink>
89
               </Object>
90
               <ItemLink
ItemLink

API reference to the item

>
{String}</ItemLink>
91
          </ForwardedFromItem>
92
     </ForwardedFrom>
93
     <ForwardedTo
ForwardedTo

This field is greyed out because it is an expandable field. You have to add $expand=ForwardedTo in your request URI to get this field

>
94
          <OpenForwardedQuantity
OpenForwardedQuantity

When items are forwarded they end up in one or more open items. Open items in this context means items that are not registered (status 0 or 1). OpenForwardedQuantity will be the sum of ForwardedQuantity of all items this item has been forwarded to.

This field is greyed out because it is an expandable field. You have to add $expand=ForwardedTo in your request URI to get this field

>
{Decimal}</OpenForwardedQuantity>
95
          <ForwardedToItems
ForwardedToItems

This field is greyed out because it is an expandable field. You have to add $expand=ForwardedTo in your request URI to get this field

>
96
               <Item
Item

Item this item was forwarded to.

This field is greyed out because it is an expandable field. You have to add $expand=ForwardedTo in your request URI to get this field

>
97
                    <ItemId
ItemId

Identifier of the object

This field is greyed out because it is an expandable field. You have to add $expand=ForwardedTo in your request URI to get this field

>
{Integer}</ItemId>
98
                    <Object
Object

This field is greyed out because it is an expandable field. You have to add $expand=ForwardedTo in your request URI to get this field

>
99
                         <ObjectId
ObjectId

Identifier of the object

This field is greyed out because it is an expandable field. You have to add $expand=ForwardedTo in your request URI to get this field

>
{Integer}</ObjectId>
100
                         <ObjectType
ObjectType

Type of object

This field is greyed out because it is an expandable field. You have to add $expand=ForwardedTo in your request URI to get this field

>
{String}</ObjectType>
101
                         <ObjectLink
ObjectLink

API reference to the object

This field is greyed out because it is an expandable field. You have to add $expand=ForwardedTo in your request URI to get this field

>
{String}</ObjectLink>
102
                    </Object>
103
                    <ItemLink
ItemLink

API reference to the item

This field is greyed out because it is an expandable field. You have to add $expand=ForwardedTo in your request URI to get this field

>
{String}</ItemLink>
104
               </Item>
105
          </ForwardedToItems>
106
     </ForwardedTo>
107
</ProductionWorkOrder>
1
{
2
     "productionWorkOrder": {
3
          "productionWorkOrderId
ProductionWorkOrderId

Production work order identifier

":
"{Integer}",
4
          "status
Status

Status of production work order

Possible domain values can be found here when logged in

":
"{Integer}",
5
          "type
Type

Type of production work order

Possible domain values can be found here when logged in

":
"{String}",
6
          "createdAt
CreatedAt

Date and time of creation

":
"{Datetime}",
7
          "registrationDate
RegistrationDate

Date of registration

":
"{Date}",
8
          "customersReferenceNumber
CustomersReferenceNumber

Customers order reference. If the production work order is derived from a sales order, the customers order reference will be the same as in the sales order. Typically a reference to an external system.

":
"{String}",
9
          "netWeight
NetWeight

The net weight of object (excluding packing meterial) in kilograms

":
"{Decimal}",
10
          "requestedCompletionDate
RequestedCompletionDate

The requested date of completion for the production work order.

":
"{Date}",
11
          "confirmedCompletionDate
ConfirmedCompletionDate

The confirmed date of completion for the production work order

":
"{Date}",
12
          "productRevision
ProductRevision

Product revision used for this production work order

":
"{String}",
13
          "productDescription
ProductDescription

Description of the item. If not specified, the description is by default copied from the product.

":
"{String}",
14
          "quantity
Quantity

The quantity that will be (or has been) produced

":
"{Decimal}",
15
          "scheduledStartDate
ScheduledStartDate

Scheduled/planned date of production start

":
"{Date}",
16
          "remainingQuantity
RemainingQuantity

Remaining number of units to produce

":
"{Decimal}",
17
          "potentialProductionQuantity
PotentialProductionQuantity

Number of products possible to produce with the current stock.

":
"{Decimal}",
18
          "hasMaterialShortage
HasMaterialShortage

True if production has supply shortage (negative metarial trend)

":
"{Boolean}",
19
          "isBlockedForPurchase
IsBlockedForPurchase

True if materials in this production work order should not be purchased

":
"{Boolean}",
20
          "onHold": {
21
               "isOnHold
IsOnHold

Flag to indicate if production work order is on hold

":
"{Boolean}",
22
               "onHoldAt
OnHoldAt

Date of putting production work order on hold

":
"{Datetime}",
23
               "reason
Reason

Reason of putting production work order on hold

":
"{String}"
24
          },
25
          "productionFor": {
26
               "database
Database

Database of the object

":
"{String}",
27
               "itemId
ItemId

Item-number of the object

":
"{Integer}",
28
               "itemType
ItemType

Type of item

":
"{String}",
29
               "object": {
30
                    "objectId
ObjectId

Identifier of the object

":
"{Integer}",
31
                    "objectType
ObjectType

Type of object

":
"{String}",
32
                    "customer": {
33
                         "customerId
CustomerId

Customer identifier

":
"{Integer}",
34
                         "name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

":
"{String}",
35
                         "customerLink
CustomerLink

Customer reference

":
"{String}"
36
                    },
37
                    "objectLink
ObjectLink

API reference to the object

":
"{String}"
38
               },
39
               "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

":
"{String}",
40
               "itemLink
ItemLink

API reference to the item

":
"{String}"
41
          },
42
          "location
Location

The location of the production.

":
{
43
               "shortName
ShortName

Unique abbreviation/short name of the location

":
"{String}"
44
          },
45
          "measurementUnit": {
46
               "measurementUnitId
MeasurementUnitId

Material unit reference

":
"{Integer}",
47
               "measurementUnitLink
MeasurementUnitLink

Material unit reference

":
"{String}"
48
          },
49
          "product": {
50
               "productId
ProductId

Product identifier

":
"{Integer}",
51
               "name
Name

Name of the product

":
"{String}",
52
               "type
Type

Type of product

Possible domain values can be found here when logged in

":
"{String}",
53
               "countryOfOriginCode
CountryOfOriginCode

Two-character code (ISO 3166) identifying the default country where the product is produced.

":
"{String}",
54
               "customField1
CustomField1

Custom field for grouping, sorting, categorizing and other purposes.

":
"{String}",
55
               "customField2
CustomField2

Custom field for grouping, sorting, categorizing and other purposes.

":
"{String}",
56
               "dimensions": {
57
                    "weight
Weight

The weight of the product in kilograms.

":
"{Decimal}"
58
               },
59
               "manufacturer": {
60
                    "manufacturerId
ManufacturerId

Manufacturer identifier

":
"{Integer}",
61
                    "shortName
ShortName

Shortname/code of the manufacturer

":
"{String}",
62
                    "manufacturerLink
ManufacturerLink

Manufacturer reference

":
"{String}"
63
               },
64
               "productClassification": {
65
                    "productClassificationId
ProductClassificationId

Product classification identifier

":
"{String}",
66
                    "productClassificationLink
ProductClassificationLink

Product classification reference

":
"{String}"
67
               },
68
               "productLink
ProductLink

Product reference

":
"{String}"
69
          },
70
          "productStructure": {
71
               "productStructureId
ProductStructureId

Product structure reference

":
"{Integer}",
72
               "productStructureLink
ProductStructureLink

Product structure reference

":
"{String}"
73
          },
74
          "financeProject": {
75
               "financeProjectId
FinanceProjectId

Finance project identifier

":
"{Integer}",
76
               "financeProjectLink
FinanceProjectLink

Finance project reference

":
"{String}"
77
          },
78
          "productionPlanner": {
79
               "employeeId
EmployeeId

Employee identifier

":
"{Integer}",
80
               "employeeLink
EmployeeLink

Employee reference

":
"{String}"
81
          },
82
          "forwardedFrom
ForwardedFrom

The preceding/previous/source item.

":
{
83
               "forwardedQuantity
ForwardedQuantity

The quantity forwarded to this item.

":
"{Decimal}",
84
               "forwardedFromItem": {
85
                    "itemId
ItemId

Identifier of the object

":
"{Integer}",
86
                    "object": {
87
                         "objectId
ObjectId

Identifier of the object

":
"{Integer}",
88
                         "objectType
ObjectType

Type of object

":
"{String}",
89
                         "objectLink
ObjectLink

API reference to the object

":
"{String}"
90
                    },
91
                    "itemLink
ItemLink

API reference to the item

":
"{String}"
92
               }
93
          },
94
          "forwardedTo
ForwardedTo

This field is greyed out because it is an expandable field. You have to add $expand=ForwardedTo in your request URI to get this field

":
{
95
               "openForwardedQuantity
OpenForwardedQuantity

When items are forwarded they end up in one or more open items. Open items in this context means items that are not registered (status 0 or 1). OpenForwardedQuantity will be the sum of ForwardedQuantity of all items this item has been forwarded to.

This field is greyed out because it is an expandable field. You have to add $expand=ForwardedTo in your request URI to get this field

":
"{Decimal}",
96
               "forwardedToItems
ForwardedToItems

This field is greyed out because it is an expandable field. You have to add $expand=ForwardedTo in your request URI to get this field

":
[
97
                    {
98
                         "itemId
ItemId

Identifier of the object

This field is greyed out because it is an expandable field. You have to add $expand=ForwardedTo in your request URI to get this field

":
"{Integer}",
99
                         "object
Object

This field is greyed out because it is an expandable field. You have to add $expand=ForwardedTo in your request URI to get this field

":
{
100
                              "objectId
ObjectId

Identifier of the object

This field is greyed out because it is an expandable field. You have to add $expand=ForwardedTo in your request URI to get this field

":
"{Integer}",
101
                              "objectType
ObjectType

Type of object

This field is greyed out because it is an expandable field. You have to add $expand=ForwardedTo in your request URI to get this field

":
"{String}",
102
                              "objectLink
ObjectLink

API reference to the object

This field is greyed out because it is an expandable field. You have to add $expand=ForwardedTo in your request URI to get this field

":
"{String}"
103
                         },
104
                         "itemLink
ItemLink

API reference to the item

This field is greyed out because it is an expandable field. You have to add $expand=ForwardedTo in your request URI to get this field

":
"{String}"
105
                    }
106
               ]
107
          }
108
     }
109
}

Possible error codes the response might return:

Error 100241 HTTP 404 Production work order not found
Error 100050 HTTP 403 No admittance as customer {0}
Error 100053 HTTP 403 You have only admittance to your own suppliers
Error 101231 HTTP 404 Production work order item not found
Error 100031 HTTP 404 Customer not found
Error 100051 HTTP 400 When logged in as supplier {0} you do not have access to this API resource
Error 100055 HTTP 403 You have only admittance to your own objects
Error 101119 HTTP 404 Shipping Service document not found
Error 101304 HTTP 404 Carrier not found
Error 102738 HTTP 404 Price list not found