Rel doc - Rel

POST

/orders/fileimporter/async{?customerId,facilityId,transformId,channelId,skipShortOrders,skipInvalidOrders,fileName}

Create orders from contents of import file asynchronously
Use content-type: text/plain, with the request body being the contents of the file.
Success status: 202

Name (* = required)	Data Type	Description
customerId *	int
facilityId *	int
transformId	int
channelId	int	id of channel, if any, through which these orders were imported
skipShortOrders	bool	true: don't create orders with insufficient inventory
skipInvalidOrders	bool	true: create as many as you can; false: all or nothing
fileName	string

this object model should not be used directly by the API client, but is assembled by the media formatter from the request's content-type and payload

	Type	Description
ContentType	string	obtained from the HTTP "Content-Type" header
Content	Object	obtained from the HTTP payload

Sample content-type: application/hal+json

{
  "contentType": "str",
  "content": {}
}

	Type	Description
OrderCreationsAttempted	int? ...
OrdersToCreate	int? ...
ImportFileCreateResults	Order.Models.ImportFileCreateResults	Links to each newly created order
FaultedOrders	Generic.Models.Exceptions.ListException	container of WmsExceptionBase-derived exceptions occuring during actions on lists, such as import or mass ops
Message	string
Faults	IList<Generic.Models.Exceptions.ListEntryFault>
EntryNumber	int	1-indexed position in the source list
EntryInfo	string	optional info about the entry in the source list, such as id, sku, ref#, etc.
WmsException	Generic.Models.Exceptions.WmsExceptionBase	for more details at runtime see which WmsExceptionBase-derived exception it is
ErrorCode	string	could have been a number, but is a short string for human readability; not to be localized
Hint	string	helpful word or two if the thrower happens to know more things; not to be localized
Message	string
InnerException	System.Exception
OrderIdentifiers	IEnumerable<Generic.Models.OrderIdentifier>
Id	int
Links	IList<WebApi.Hal.Link>
	- /rels/orders/order	newly created orders
Links	IList<WebApi.Hal.Link>
	- /rels/orders/fileimportasyncstatus	may be polled until the operation is complete or fails

Sample accept: application/hal+json

{
  "orderCreationsAttempted": 1,
  "ordersToCreate": 1,
  "_embedded": {
    "http://api.3plCentral.com/rels/orders/fileimport": {
      "faultedOrders": {
        "message": "ListException: Faults [{EntryNumber 1, }]",
        "faults": [
          {
            "entryNumber": 1,
            "entryInfo": "str"
          }
        ],
        "data": {},
        "helpLink": "str",
        "source": "str",
        "hResult": 3
      },
      "orderIdentifiers": [
        {
          "id": 1
        }
      ]
    }
  }
}

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.