Transfer Group
The Transfer Group API allows the user to create, view, and update transfer groups.
Security
jwt-bearer-token
apiKey | API Key |
|---|---|
Name | Authorization |
In | header |
Endpoints
GET /transfer-group/schema
Summary
Get the transfer group schema.
Request Parameters
In | Field Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes | The identifier (ID) of the company that owns the document |
Responses
Code | Description | Schema |
|---|---|---|
200 | Success | |
400 | Bad request, for more information look at body error | |
401 | Unauthorized error | |
403 | Forbidden error | |
404 | Not Found | |
422 | Unprocessable error | |
500 | Internal Server Error |
POST /transfer-group
Summary
Create the transfer group.
Request Parameters
In | Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes | The identifier (ID) of the company that owns the document |
body |
| Yes | The JSON formatted request |
Responses
Code | Description | Schema |
|---|---|---|
201 | Success | |
400 | Bad request, for more information look at body error | |
401 | Unauthorized error | |
403 | Forbidden error | |
404 | Not Found | |
422 | Unprocessable error | |
500 | Internal Server Error |
GET /transfer-group
Summary
Get the transfer group list.
Request Parameters
In | Field Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes | The identifier (ID) of the company that owns the document |
query |
| string | No | A filter expression in OData v4 format |
query |
| integer | No | The maximum documents to return. For example, if |
query |
| integer | No | The documents to skip before returning. For example, if |
query |
| string | No | |
query |
| string | No | An order by expression in OData v4 format |
query |
| boolean | No | If |
Responses
Code | Description | Schema |
|---|---|---|
200 | Success | |
400 | Bad request, for more information look at body error | |
401 | Unauthorized error | |
403 | Forbidden error | |
404 | Not Found | |
422 | Unprocessable error | |
500 | Internal Server Error |
PATCH /transfer-group/{id}
Summary
Update the transfer group.
Request Parameters
In | Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes | The identifier (ID) of the company that owns the document |
path |
| string | Yes | The transfer group's document ID from the database |
body |
| Yes | The JSON formatted request |
Responses
Code | Description | Schema |
|---|---|---|
204 | No content | |
400 | Bad request, for more information look at body error | |
401 | Unauthorized error | |
403 | Forbidden error | |
404 | Not Found | |
422 | Unprocessable error | |
500 | Internal Server Error |
GET /transfer-group/{id}
Summary
Get the transfer group detail.
Request Parameters
In | Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes | The identifier (ID) of the company that owns the document |
path |
| string | Yes | The transfer group's document ID from the database |
query |
| boolean | No | Get updated items |
query |
| boolean | No | Get transfer items |
query |
| string | No | Get transfer items |
Responses
Code | Description | Schema |
|---|---|---|
200 | Success | |
400 | Bad request, for more information look at body error | |
401 | Unauthorized error | |
403 | Forbidden error | |
404 | Not Found | |
422 | Unprocessable error | |
500 | Internal Server Error |
Data Models
transfer_group_get_response_1
Field Name | Type | Description |
|---|---|---|
| object | The transfer group schema definition |
transfer_group_post_body_2
Field Name | Type | Required | Description |
|---|---|---|---|
| string | No | |
| string | No | The transfer group site identifier (ID) |
| string | No | The transfer group type |
| string | Yes | The transfer type. Enum: |
| string | Yes | |
| date/time | Yes | The transfer group date |
transfer_group_post_response_2
Field Name | Type | Description |
|---|---|---|
| string | |
| string | |
| string | The transfer type |
| string | The transfer group type |
| string | |
| string | The transfer group's name |
| string | |
| string | The transfer from site identifier (ID) |
| string | The transfer from site name |
| string | The transfer from store number |
| date/time | |
| string | The user's company ID |
| date/time | The date of creation |
| string | The created by user ID |
| date/time | The updated date |
| string | The updated by user ID |
transfer_group_get_response_3
Field Name | Type | Description |
|---|---|---|
| ||
| number | |
| number | |
| number | |
| number |
transfer_group_get_response_3_items
Field Name | Type | Required | Description |
|---|---|---|---|
| string | Yes |
|
| string | Yes | The transfer group's entity identifier (ID) |
| string | Yes | The transfer group's name |
| string | Yes | The site's ID |
| string | Yes | The site's name |
| string | Yes | The site ID |
| date/time | Yes | The transfer group transaction date |
| string | No | The transfer group type |
| string | No | The transfer type |
| date/time | Yes | The last update date |
| number | No | The sum of all transfers' |
| number | No | The sum of all transfers' |
| number | No | The sum of all transfers' |
transfer_group_patch_body_4
Field Name | Type | Description |
|---|---|---|
| string | |
| string | The transfer from site identifier (ID) |
| string | The transfer group's type. Enum: |
| string | The transfer group's name |
| date/time | The transfer group date |
transfer_group_get_response_5
Field Name | Type | Description |
|---|---|---|
| string |
|
| string | The transfer type |
| string | The transfer group type |
| string | The transfer group's name |
| string | |
| string | The transfer from site identifier (ID) |
| string | The transfer from site name |
| date/time |
|
| A list of transfer items |
transfer_group_get_response_5_transfer_items
Field Name | Type | Description |
|---|---|---|
| object |