Product locations

ATUM

The ATUM product locations API allows you to create, view, update, and delete individual, or a batch, of locations.

The product locations endpoints are only available when the ATUM Purchase Orders module is enabled. Reading the locations requires the ATUM manage_location_terms capability, creating or editing them requires edit_location_terms and deleting them requires delete_location_terms.

Product location properties

Attribute	Type	Description
`id`	integer	Unique identifier for the resource. read-only
`name`	string	Location name. mandatory
`slug`	string	An alphanumeric identifier for the resource unique to its type.
`parent`	integer	The ID for the parent of the resource.
`description`	string	HTML description of the resource.
`count`	integer	Number of published products for the resource. read-only
`barcode`	string	The barcode used for all the products linked to this location. Only present when the ATUM Barcodes module is enabled and the user has the `view_barcode` capability (the `edit_barcode` capability is required to change it). ATUM

Create a product location

This API helps you to create a new product location.

HTTP request

POST/wp-json/wc/v3/products/atum-locations

Example of how to create a product location

curl -X POST https://example.com/wp-json/wc/v3/products/atum-locations \
	-u consumer_key:consumer_secret \
	-H "Content-Type: application/json" \
	-d '{
  "name": "Manchester",
  "parent": 38
}'

JSON response example

{
    "id": 58,
    "name": "Manchester",
    "slug": "manchester",
    "parent": 38,
    "description": "",
    "count": 0,
    "barcode": "",
    "_links": {
        "self": [
            {
                "href": "https://example.com/wp-json/wc/v3/products/atum-locations/58"
            }
        ],
        "collection": [
            {
                "href": "https://example.com/wp-json/wc/v3/products/atum-locations"
            }
        ],
        "up": [
            {
                "href": "https://example.com/wp-json/wc/v3/products/atum-locations/38"
            }
        ]
    }
}

Retrieve a product location

This API lets you retrieve a product location by ID.

GET/wp-json/wc/v3/products/atum-locations/<id>

curl https://example.com/wp-json/wc/v3/products/atum-locations/38 \
	-u consumer_key:consumer_secret

JSON response example

{
    "id": 38,
    "name": "United Kingdom",
    "slug": "united-kingdom",
    "parent": 0,
    "description": "",
    "count": 7,
    "barcode": "",
    "_links": {
        "self": [
            {
                "href": "https://example.com/wp-json/wc/v3/products/atum-locations/38"
            }
        ],
        "collection": [
            {
                "href": "https://example.com/wp-json/wc/v3/products/atum-locations"
            }
        ]
    }
}

List all product locations

This API lets you retrieve all product locations.

GET/wp-json/wc/v3/products/atum-locations

curl https://example.com/wp-json/wc/v3/products/atum-locations \
	-u consumer_key:consumer_secret

JSON response example

[
    {
        "id": 39,
        "name": "Italy",
        "slug": "italy",
        "parent": 0,
        "description": "",
        "count": 5,
        "barcode": "",
        "_links": {
            "self": [
                {
                    "href": "https://example.com/wp-json/wc/v3/products/atum-locations/39"
                }
            ],
            "collection": [
                {
                    "href": "https://example.com/wp-json/wc/v3/products/atum-locations"
                }
            ]
        }
    },
    {
        "id": 50,
        "name": "Madrid",
        "slug": "madrid",
        "parent": 37,
        "description": "",
        "count": 3,
        "barcode": "",
        "_links": {
            "self": [
                {
                    "href": "https://example.com/wp-json/wc/v3/products/atum-locations/50"
                }
            ],
            "collection": [
                {
                    "href": "https://example.com/wp-json/wc/v3/products/atum-locations"
                }
            ],
            "up": [
                {
                    "href": "https://example.com/wp-json/wc/v3/products/atum-locations/37"
                }
            ]
        }
    },
    {
        "id": 58,
        "name": "Manchester",
        "slug": "manchester",
        "parent": 38,
        "description": "",
        "count": 0,
        "barcode": "",
        "_links": {
            "self": [
                {
                    "href": "https://example.com/wp-json/wc/v3/products/atum-locations/58"
                }
            ],
            "collection": [
                {
                    "href": "https://example.com/wp-json/wc/v3/products/atum-locations"
                }
            ],
            "up": [
                {
                    "href": "https://example.com/wp-json/wc/v3/products/atum-locations/38"
                }
            ]
        }
    },
    {
        "id": 53,
        "name": "Slovakia",
        "slug": "slovakia",
        "parent": 0,
        "description": "",
        "count": 0,
        "barcode": "",
        "_links": {
            "self": [
                {
                    "href": "https://example.com/wp-json/wc/v3/products/atum-locations/53"
                }
            ],
            "collection": [
                {
                    "href": "https://example.com/wp-json/wc/v3/products/atum-locations"
                }
            ]
        }
    },
    {
        "id": 37,
        "name": "Spain",
        "slug": "spain",
        "parent": 0,
        "description": "",
        "count": 7,
        "barcode": "",
        "_links": {
            "self": [
                {
                    "href": "https://example.com/wp-json/wc/v3/products/atum-locations/37"
                }
            ],
            "collection": [
                {
                    "href": "https://example.com/wp-json/wc/v3/products/atum-locations"
                }
            ]
        }
    },
    {
        "id": 38,
        "name": "United Kingdom",
        "slug": "united-kingdom",
        "parent": 0,
        "description": "",
        "count": 7,
        "barcode": "UIOHOUIGHOUO",
        "_links": {
            "self": [
                {
                    "href": "https://example.com/wp-json/wc/v3/products/atum-locations/38"
                }
            ],
            "collection": [
                {
                    "href": "https://example.com/wp-json/wc/v3/products/atum-locations"
                }
            ]
        }
    },
    {
        "id": 49,
        "name": "Valencia",
        "slug": "valencia",
        "parent": 37,
        "description": "",
        "count": 6,
        "barcode": "",
        "_links": {
            "self": [
                {
                    "href": "https://example.com/wp-json/wc/v3/products/atum-locations/49"
                }
            ],
            "collection": [
                {
                    "href": "https://example.com/wp-json/wc/v3/products/atum-locations"
                }
            ],
            "up": [
                {
                    "href": "https://example.com/wp-json/wc/v3/products/atum-locations/37"
                }
            ]
        }
    }
]

Available parameters

Parameter	Type	Description
`context`	string	Scope under which the request is made; determines fields present in response. Options: `view` and `edit`. Default is `view`.
`page`	integer	Current page of the collection. Default is `1`.
`per_page`	integer	Maximum number of items to be returned in result set. Default is `10`. Maximum is `100`.
`search`	string	Limit results to those matching a string.
`exclude`	array	Ensure result set excludes specific ids.
`include`	array	Limit result set to specific ids.
`offset`	integer	Offset the result set by a specific number of items.
`order`	string	Order sort attribute ascending or descending. Options: `asc` and `desc`. Default is `asc`.
`orderby`	string	Sort collection by resource attribute. Options: `id`, `include`, `name`, `slug`, `term_group`, `description` and `count`. Default is `name`.
`hide_empty`	boolean	Whether to hide resources not assigned to any products. Default is `false`.
`parent`	integer	Limit result set to resources assigned to a specific parent.
`product`	integer	Limit result set to resources assigned to a specific product.
`slug`	string, array	Limit result set to resources with a specific slug (or any of the specified slugs).

Update a product location

This API lets you make changes to a product location.

HTTP request

PUT/wp-json/wc/v3/products/atum-locations/<id>

curl -X PUT https://example.com/wp-json/wc/v3/products/atum-locations/58 \
	-u consumer_key:consumer_secret \
	-H "Content-Type: application/json" \
	-d '{
  "description": "Manchester city."
}'

JSON response example

{
    "id": 58,
    "name": "Manchester",
    "slug": "manchester",
    "parent": 38,
    "description": "Manchester city.",
    "count": 0,
    "barcode": "",
    "_links": {
        "self": [
            {
                "href": "https://example.com/wp-json/wc/v3/products/atum-locations/58"
            }
        ],
        "collection": [
            {
                "href": "https://example.com/wp-json/wc/v3/products/atum-locations"
            }
        ],
        "up": [
            {
                "href": "https://example.com/wp-json/wc/v3/products/atum-locations/38"
            }
        ]
    }
}

Delete a product location

This API helps you delete a product location.

HTTP request

DELETE/wp-json/wc/v3/products/atum-locations/<id>

curl -X DELETE https://example.com/wp-json/wc/v3/products/atum-locations/58?force=true \
	-u consumer_key:consumer_secret

JSON response example

{
    "id": 58,
    "name": "Manchester",
    "slug": "manchester",
    "parent": 38,
    "description": "Manchester city.",
    "count": 0,
    "barcode": "",
    "_links": {
        "self": [
            {
                "href": "https://example.com/wp-json/wc/v3/products/atum-locations/58"
            }
        ],
        "collection": [
            {
                "href": "https://example.com/wp-json/wc/v3/products/atum-locations"
            }
        ],
        "up": [
            {
                "href": "https://example.com/wp-json/wc/v3/products/atum-locations/38"
            }
        ]
    }
}

Available parameters

Parameter	Type	Description
`force`	boolean	Required to be `true`, as resource does not support trashing.

Batch update product locations

This API helps you to batch create, update and delete multiple product locations.

Note: By default it's limited to up to 100 objects to be created, updated or deleted.

HTTP request

POST/wp-json/wc/v3/products/atum-locations/batch

curl -X POST https://example.com//wp-json/wc/v3/products/atum-locations/batch \
	-u consumer_key:consumer_secret \
	-H "Content-Type: application/json" \
	-d '{
    "create": [
        {
          "name": "London",
          "parent": 38
        },
        {
          "name": "Portugal"
        }
    ],
    "update": [
        {
            "id": 49,
            "description": "Valencia city."
        }	
    ],
    "delete": [
        59	
    ]
}'

JSON response example

{
    "create": [
        {
            "id": 60,
            "name": "London",
            "slug": "london",
            "parent": 38,
            "description": "",
            "count": 0,
            "barcode": "",
            "_links": {
                "self": [
                    {
                        "href": "https://example.com/wp-json/wc/v3/products/atum-locations/60"
                    }
                ],
                "collection": [
                    {
                        "href": "https://example.com/wp-json/wc/v3/products/atum-locations"
                    }
                ],
                "up": [
                    {
                        "href": "https://example.com/wp-json/wc/v3/products/atum-locations/38"
                    }
                ]
            }
        },
        {
            "id": 61,
            "name": "Portugal",
            "slug": "portugal",
            "parent": 0,
            "description": "",
            "count": 0,
            "barcode": "",
            "_links": {
                "self": [
                    {
                        "href": "https://example.com/wp-json/wc/v3/products/atum-locations/61"
                    }
                ],
                "collection": [
                    {
                        "href": "https://example.com/wp-json/wc/v3/products/atum-locations"
                    }
                ]
            }
        }
    ],
    "update": [
        {
            "id": 49,
            "name": "Valencia",
            "slug": "valencia",
            "parent": 37,
            "description": "Valencia city.",
            "count": 6,
            "barcode": "",
            "_links": {
                "self": [
                    {
                        "href": "https://example.com/wp-json/wc/v3/products/atum-locations/49"
                    }
                ],
                "collection": [
                    {
                        "href": "https://example.com/wp-json/wc/v3/products/atum-locations"
                    }
                ],
                "up": [
                    {
                        "href": "https://example.com/wp-json/wc/v3/products/atum-locations/37"
                    }
                ]
            }
        }
    ],
    "delete": [
        {
            "id": 59,
            "name": "Manchester",
            "slug": "manchester",
            "parent": 38,
            "description": "",
            "count": 0,
            "barcode": "",
            "_links": {
                "self": [
                    {
                        "href": "https://example.com/wp-json/wc/v3/products/atum-locations/59"
                    }
                ],
                "collection": [
                    {
                        "href": "https://example.com/wp-json/wc/v3/products/atum-locations"
                    }
                ],
                "up": [
                    {
                        "href": "https://example.com/wp-json/wc/v3/products/atum-locations/38"
                    }
                ]
            }
        }
    ]
}

Product location propertiesCopy Anchor Link

Create a product locationCopy Anchor Link

HTTP requestCopy Anchor Link

Retrieve a product locationCopy Anchor Link

List all product locationsCopy Anchor Link

Available parametersCopy Anchor Link

Update a product locationCopy Anchor Link

HTTP requestCopy Anchor Link

Delete a product locationCopy Anchor Link

HTTP requestCopy Anchor Link

Available parametersCopy Anchor Link

Batch update product locationsCopy Anchor Link

HTTP requestCopy Anchor Link

On this page

Product location properties

Create a product location

HTTP request

Retrieve a product location

List all product locations

Available parameters

Update a product location

HTTP request

Delete a product location

HTTP request

Available parameters

Batch update product locations

HTTP request