Resource:Collection: of customertransformC# Rel Const:Rels.CustomerSvc.CustomerTransformsURI template:{id}/transforms{?tofile,fromfile}Obtain URI from:
Get the list of transforms selected for use by a customer; may be limited to a "tofile" type or a "fromfile" type
Success status: 200; ETag response header supplied; Response is cacheable
Name (* = required) | Data Type | Description |
---|---|---|
id * | int | customer id |
tofile | Common.Enum.ToFileContent | default Unspecified |
- AdvanceShippingNotice | ||
- RoutingRequest | ||
- ReceiptAdvice | ||
- AdjustmentAdvice | ||
- Invoice | ||
- StockStatus | ||
- ItemDescription | ||
- ReceiverConfirmation | ||
- OrderConfirmation | ||
- Unspecified | ||
fromfile | Common.Enum.FromFileContent | default Unspecified |
- Order | ||
- Receiver | ||
- Item | ||
- PurchaseOrder | ||
- Assembly | ||
- Unspecified |
Type | Description | |
---|---|---|
Transforms | IList<Customer.Models.CustomerTransform> | |
TransformId | int | |
Description | string | |
FileType | Common.Enum.TransformFileType | |
- 0: Edi | ||
- 1: Xml | ||
- 2: Other | ||
Links | IList<WebApi.Hal.Link> | |
- /rels/orders/fileparse | ||
- /rels/orders/fileimport | ||
- /rels/orders/export | ||
- /rels/inventory/fileparse | ||
- /rels/inventory/fileimport | ||
- /rels/inventory/export |
{ "_embedded": { "http://api.3plCentral.com/rels/customers/customertransform": [ { "transformId": 1, "description": "str", "fileType": 0 } ] } }
Update the list of transforms selected for use by a customer; may be limited to a "tofile" type or a "fromfile" type
If-Match request header required; Success status: 200; ETag response header supplied
Name (* = required) | Data Type | Description |
---|---|---|
id * | int | customer id |
tofile | Common.Enum.ToFileContent | default Unspecified; if specified, other types of transforms will not be affected |
- AdvanceShippingNotice | ||
- RoutingRequest | ||
- ReceiptAdvice | ||
- AdjustmentAdvice | ||
- Invoice | ||
- StockStatus | ||
- ItemDescription | ||
- ReceiverConfirmation | ||
- OrderConfirmation | ||
- Unspecified | ||
fromfile | Common.Enum.FromFileContent | default Unspecified; if specified, other types of transforms will not be affected |
- Order | ||
- Receiver | ||
- Item | ||
- PurchaseOrder | ||
- Assembly | ||
- Unspecified |
Type | Description | |
---|---|---|
Transforms | IList<Customer.Models.CustomerTransform> | |
TransformId | int | |
Description | string | |
FileType | Common.Enum.TransformFileType | |
- 0: Edi | ||
- 1: Xml | ||
- 2: Other | ||
Links | IList<WebApi.Hal.Link> | |
- /rels/orders/fileparse | ||
- /rels/orders/fileimport | ||
- /rels/orders/export | ||
- /rels/inventory/fileparse | ||
- /rels/inventory/fileimport | ||
- /rels/inventory/export |
Sample content-type: application/hal+json |
{ "_embedded": { "http://api.3plCentral.com/rels/customers/customertransform": [ { "transformId": 1, "description": "str", "fileType": 0 } ] } }
Type | Description | |
---|---|---|
Transforms | IList<Customer.Models.CustomerTransform> | |
TransformId | int | |
Description | string | |
FileType | Common.Enum.TransformFileType | |
- 0: Edi | ||
- 1: Xml | ||
- 2: Other | ||
Links | IList<WebApi.Hal.Link> | |
- /rels/orders/fileparse | ||
- /rels/orders/fileimport | ||
- /rels/orders/export | ||
- /rels/inventory/fileparse | ||
- /rels/inventory/fileimport | ||
- /rels/inventory/export |
{ "_embedded": { "http://api.3plCentral.com/rels/customers/customertransform": [ { "transformId": 1, "description": "str", "fileType": 0 } ] } }
This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@3plcentral.com with any questions about this documentation.