API

Logistics APIs

POST logistics/pick-assignments?objectType={objectType}&objectId={objectId}&itemId={itemId}/api-operations/100111/instances

Undo Pick All.

This is an API operation. Read the documentation pages for more information about API operations.

HTTP method POST
URI https://api.rambase.net/logistics/pick-assignments?objectType={objectType}&objectId={objectId}&itemId={itemId}/api-operations/100111/instances
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 200
API resource identifier 2097, version 2

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 are required/mandatory.

Format:
1
<Parameters
Parameters

This field is optional.

>
2
     <OperationSequenceNumber
OperationSequenceNumber

Sequence number of the production operation. Controls the sequence of all the operations in the product structre. Products beloning to each operation will have the same operation sequence number.

This field is optional.

>{Integer}</OperationSequenceNumber>
3
</Parameters>
1
{
2
     "parameters
Parameters

This field is optional.

": {
3
          "operationSequenceNumber
OperationSequenceNumber

Sequence number of the production operation. Controls the sequence of all the operations in the product structre. Products beloning to each operation will have the same operation sequence number.

This field is optional.

": "{Integer}"
4
     }
5
}

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.

objectType String, required Type of object
objectId Integer, required Identifier of the object
itemId Integer, optional Item-number of the object
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

Read more about filters and sorting on how to use filter parameters and named filters.

Read more 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.

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

Format:
1
<OperationInstance>
2
     <OperationInstanceId
OperationInstanceId

Operation instance identifier

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

Status of the instance, 2 = started, 7 = error, 9 = finished

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

Date and time the operation instance was created

>{Datetime}</CreatedAt>
5
     <CreatedBy
CreatedBy

Reference to the creator

>
6
          <UserId
UserId

User identifier

>{Integer}</UserId>
7
          <UserLink
UserLink

User reference

>{String}</UserLink>
8
     </CreatedBy>
9
     <CreatedFor>
10
          <ObjectId
ObjectId

Identifier of the object

>{String}</ObjectId>
11
          <ObjectType
ObjectType

Type of object

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

API reference to the object

>{String}</ObjectLink>
13
          <ItemId
ItemId

Item-number of the object

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

Type of item

>{String}</ItemType>
15
          <ItemLink
ItemLink

API reference to the item

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

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
17
     </CreatedFor>
18
     <ApiOperation>
19
          <ApiOprationId
ApiOprationId

Api operation identifiers

>{Integer}</ApiOprationId>
20
          <ApiOperationLink
ApiOperationLink

Api operation reference

>{String}</ApiOperationLink>
21
     </ApiOperation>
22
     <ObjectReference>
23
          <ObjectId
ObjectId

Identifier of the object

>{String}</ObjectId>
24
          <ObjectType
ObjectType

Type of object

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

API reference to the object

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

Item-number of the object

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

Type of item

>{String}</ItemType>
28
          <ItemLink
ItemLink

API reference to the item

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

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
30
     </ObjectReference>
31
     <Error>
32
          <Message
Message

Full error message/description. The message is generated from the specified ErrorMessage object, expanded with the given parameter(s).

>{String}</Message>
33
          <TranslatedMessage
TranslatedMessage

Full translated error description. The language used is specified either in $lang or by user settings. If error message don't exist in desired language, english will be used.

>{String}</TranslatedMessage>
34
          <StackTrace
StackTrace

Stack trace for details about the error

>{String}</StackTrace>
35
          <ErrorMessage
ErrorMessage

Contains a reference to the error message, if an error occured

>
36
               <ErrorMessageId
ErrorMessageId

Error message identifier

>{Integer}</ErrorMessageId>
37
               <ErrorMessageLink
ErrorMessageLink

Error message reference

>{String}</ErrorMessageLink>
38
          </ErrorMessage>
39
          <Parameters>
40
               <Parameter>
41
                    <Index
Index

Error Key

>{Integer}</Index>
42
                    <Value
Value

Value of the error parameter

>{String}</Value>
43
               </Parameter>
44
          </Parameters>
45
          <InnerErrors>
46
               <Error>
47
                    <Message
Message

Full error message/description. The message is generated from the specified ErrorMessage object, expanded with the given parameter(s).

>{String}</Message>
48
                    <TranslatedMessage
TranslatedMessage

Full translated error description. The language used is specified either in $lang or by user settings. If error message don't exist in desired language, english will be used.

>{String}</TranslatedMessage>
49
                    <StackTrace
StackTrace

Stack trace for details about the error

>{String}</StackTrace>
50
                    <ErrorMessage
ErrorMessage

Contains a reference to the error message, if an error occured

>
51
                         <ErrorMessageId
ErrorMessageId

Error message identifier

>{Integer}</ErrorMessageId>
52
                         <ErrorMessageLink
ErrorMessageLink

Error message reference

>{String}</ErrorMessageLink>
53
                    </ErrorMessage>
54
                    <Parameters>
55
                         <Parameter>
56
                              <Index
Index

Error Key

>{Integer}</Index>
57
                              <Value
Value

Value of the error parameter

>{String}</Value>
58
                         </Parameter>
59
                    </Parameters>
60
               </Error>
61
          </InnerErrors>
62
     </Error>
63
     <ResultValues>
64
          <ResultValue>
65
               <Key
Key

Key of the result value

>{String}</Key>
66
               <Value
Value

Value of the result value

>{String}</Value>
67
          </ResultValue>
68
     </ResultValues>
69
     <SystemJob
SystemJob

Contains a reference to the system job, if a system job was started

>
70
          <ObjectId
ObjectId

{OIN.ObjectId}

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

Type of object

>{String}</ObjectType>
72
          <PercentComplete
PercentComplete

Percent complete

>{Integer}</PercentComplete>
73
          <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
74
     </SystemJob>
75
     <OperationInstanceLink
OperationInstanceLink

Operation instance reference

>{String}</OperationInstanceLink>
76
</OperationInstance>
1
{
2
     "operationInstance": {
3
          "operationInstanceId
OperationInstanceId

Operation instance identifier

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

Status of the instance, 2 = started, 7 = error, 9 = finished

": "{Integer}",
5
          "createdAt
CreatedAt

Date and time the operation instance was created

": "{Datetime}",
6
          "createdBy
CreatedBy

Reference to the creator

": {
7
               "userId
UserId

User identifier

": "{Integer}",
8
               "userLink
UserLink

User reference

": "{String}"
9
          },
10
          "createdFor": {
11
               "objectId
ObjectId

Identifier of the object

": "{String}",
12
               "objectType
ObjectType

Type of object

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

API reference to the object

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

Item-number of the object

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

Type of item

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

API reference to the item

": "{String}",
17
               "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

": "{String}"
18
          },
19
          "apiOperation": {
20
               "apiOprationId
ApiOprationId

Api operation identifiers

": "{Integer}",
21
               "apiOperationLink
ApiOperationLink

Api operation reference

": "{String}"
22
          },
23
          "objectReference": {
24
               "objectId
ObjectId

Identifier of the object

": "{String}",
25
               "objectType
ObjectType

Type of object

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

API reference to the object

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

Item-number of the object

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

Type of item

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

API reference to the item

": "{String}",
30
               "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

": "{String}"
31
          },
32
          "error": {
33
               "message
Message

Full error message/description. The message is generated from the specified ErrorMessage object, expanded with the given parameter(s).

": "{String}",
34
               "translatedMessage
TranslatedMessage

Full translated error description. The language used is specified either in $lang or by user settings. If error message don't exist in desired language, english will be used.

": "{String}",
35
               "stackTrace
StackTrace

Stack trace for details about the error

": "{String}",
36
               "errorMessage
ErrorMessage

Contains a reference to the error message, if an error occured

": {
37
                    "errorMessageId
ErrorMessageId

Error message identifier

": "{Integer}",
38
                    "errorMessageLink
ErrorMessageLink

Error message reference

": "{String}"
39
               },
40
               "parameters": [
41
                    {
42
                         "index
Index

Error Key

": "{Integer}",
43
                         "value
Value

Value of the error parameter

": "{String}"
44
                    }
45
               ],
46
               "innerErrors": [
47
                    {
48
                         "message
Message

Full error message/description. The message is generated from the specified ErrorMessage object, expanded with the given parameter(s).

": "{String}",
49
                         "translatedMessage
TranslatedMessage

Full translated error description. The language used is specified either in $lang or by user settings. If error message don't exist in desired language, english will be used.

": "{String}",
50
                         "stackTrace
StackTrace

Stack trace for details about the error

": "{String}",
51
                         "errorMessage
ErrorMessage

Contains a reference to the error message, if an error occured

": {
52
                              "errorMessageId
ErrorMessageId

Error message identifier

": "{Integer}",
53
                              "errorMessageLink
ErrorMessageLink

Error message reference

": "{String}"
54
                         },
55
                         "parameters": [
56
                              {
57
                                   "index
Index

Error Key

": "{Integer}",
58
                                   "value
Value

Value of the error parameter

": "{String}"
59
                              }
60
                         ]
61
                    }
62
               ]
63
          },
64
          "resultValues": [
65
               {
66
                    "key
Key

Key of the result value

": "{String}",
67
                    "value
Value

Value of the result value

": "{String}"
68
               }
69
          ],
70
          "systemJob
SystemJob

Contains a reference to the system job, if a system job was started

": {
71
               "objectId
ObjectId

{OIN.ObjectId}

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

Type of object

": "{String}",
73
               "percentComplete
PercentComplete

Percent complete

": "{Integer}",
74
               "objectLink
ObjectLink

API reference to the object

": "{String}"
75
          },
76
          "operationInstanceLink
OperationInstanceLink

Operation instance reference

": "{String}"
77
     }
78
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 101645 HTTP 400 Default account for {0} is not set up.
Error 104700 HTTP 400 VAT already postponed.
Error 104703 HTTP 400 VAT amount is equal to 0
Error 100199 HTTP 404 Location not found
Error 108844 HTTP 400 Manufacturer part number is not active on the product
Error 102115 HTTP 400 All purchase price conversion fields must be blanked, or all must be filled in
Error 100167 HTTP 404 Measurement unit not found
Error 102116 HTTP 400 Selected measurement unit is not activated in your system
Error 102112 HTTP 400 Purchase price can not be set when using price convesrsion by measurement units
Error 103478 HTTP 400 Purchase price is required
Error 102109 HTTP 400 Supplier is required
Error 100047 HTTP 404 Supplier not found
Error 101097 HTTP 404 Given currency {0} mismatch with currencies of supplier {1}